org.openimaj.image.processing.face.detection.keypoints

Class KEDetectedFace

java.lang.Object

org.openimaj.image.processing.face.detection.DetectedFace

org.openimaj.image.processing.face.detection.keypoints.KEDetectedFace

All Implemented Interfaces:

ReadableBinary, ReadWriteableBinary, WriteableBinary

public class KEDetectedFace
extends DetectedFace

A K(eypoint)E(nriched)DetectedFace models a face detected by a face detector, together with the locations of certain facial features localised on the face.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected FacialKeypoint[]	keypoints A list of detected facial keypoints.

Fields inherited from class org.openimaj.image.processing.face.detection.DetectedFace

bounds, confidence, facePatch

Constructor Summary

Constructors

Constructor and Description
KEDetectedFace() Default constructor
KEDetectedFace(Rectangle bounds, FImage patch, FacialKeypoint[] keypoints, float confidence) Construct with parameters.

Method Summary

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
FacialKeypoint	getKeypoint(FacialKeypoint.FacialKeypointType type) Get a keypoint of the specified type.
FacialKeypoint	getKeypointInterpolated(FacialKeypoint.FacialKeypointType type) Get a keypoint of the specified type, interpolating the position if the internal model doesn't have a matching point.
FacialKeypoint[]	getKeypoints()
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 org.openimaj.image.processing.face.detection.DetectedFace

getBounds, getConfidence, getFacePatch, getShape, setBounds, setConfidence, setFacePatch

Methods inherited from class java.lang.Object

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

Field Detail

keypoints

protected FacialKeypoint[] keypoints

A list of detected facial keypoints. The coordinates are given in terms of the facePatch image. To project them into the original image you need to translate by bounds.x and bounds.y.

Constructor Detail

KEDetectedFace

public KEDetectedFace()

Default constructor

KEDetectedFace

public KEDetectedFace(Rectangle bounds,
                      FImage patch,
                      FacialKeypoint[] keypoints,
                      float confidence)

Construct with parameters.

Parameters:

bounds - the bounds rectangle in the detection image

patch - the patch

keypoints - the detected facial keypoints.

confidence - the confidence of detection

Method Detail

getKeypoint

public FacialKeypoint getKeypoint(FacialKeypoint.FacialKeypointType type)

Get a keypoint of the specified type.

Parameters:

type - the type of keypoint

Returns:

the keypoint, or null if it wasn't found

getKeypointInterpolated

public FacialKeypoint getKeypointInterpolated(FacialKeypoint.FacialKeypointType type)

Get a keypoint of the specified type, interpolating the position if the internal model doesn't have a matching point. Currently only the FacialKeypoint.FacialKeypointType.MOUTH_CENTER, FacialKeypoint.FacialKeypointType.EYE_LEFT_CENTER and FacialKeypoint.FacialKeypointType.EYE_RIGHT_CENTER points are supported iff the corresponding left and right points are available.

Parameters:

type - the type of keypoint

Returns:

the keypoint, or null if it wasn't found

getKeypoints

public FacialKeypoint[] getKeypoints()

Returns:

the FacialKeypoints associated with this detection

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

Overrides:

writeBinary in class DetectedFace

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

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

Overrides:

binaryHeader in class DetectedFace

Returns:

header

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Overrides:

readBinary in class DetectedFace

Parameters:

in - source to read from.

Throws:

IOException - an error reading input