org.openimaj.image.processing.face.alignment

Class CLMAligner

java.lang.Object

org.openimaj.image.processing.face.alignment.CLMAligner

All Implemented Interfaces:

FaceAligner<CLMDetectedFace>, ReadableBinary, ReadWriteableBinary, WriteableBinary

public class CLMAligner
extends Object
implements FaceAligner<CLMDetectedFace>

An aligner that warps a CLMDetectedFace to the neutral pose (reference shape) of the CLMFaceDetector.Configuration.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
CLMAligner() Construct a new CLMAligner using the default CLMFaceDetector.Configuration and default size of 100 pixels.
CLMAligner(int size) Construct a new CLMAligner using the default CLMFaceDetector.Configuration and given size for the aligned output image.

Method Summary

Methods

Modifier and Type	Method and Description
FImage	align(CLMDetectedFace face) For the provided face detection, return an aligned version of the face.
byte[]	binaryHeader() Header for binary input.
FImage	getMask() Return a mask image for aligned faces.
void	readBinary(DataInput in) Read internal state from in.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CLMAligner

public CLMAligner()

Construct a new CLMAligner using the default CLMFaceDetector.Configuration and default size of 100 pixels.

CLMAligner

public CLMAligner(int size)

Construct a new CLMAligner using the default CLMFaceDetector.Configuration and given size for the aligned output image.

Parameters:

size - the output facial patch size

Method Detail

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

align

public FImage align(CLMDetectedFace face)

Description copied from interface: FaceAligner

For the provided face detection, return an aligned version of the face.

Specified by:

align in interface FaceAligner<CLMDetectedFace>

Parameters:

face - the face to align

Returns:

aligned face

getMask

public FImage getMask()

Description copied from interface: FaceAligner

Return a mask image for aligned faces. 0 pixels mark background pixels that should be ignored in further processing of aligned faces produced by this aligner.

Specified by:

getMask in interface FaceAligner<CLMDetectedFace>

Returns:

a mask image, or null if masking isn't required