org.openimaj.image.processing.face.feature

Class EigenFaceFeature.Extractor<T extends DetectedFace>

java.lang.Object

org.openimaj.image.processing.face.feature.EigenFaceFeature.Extractor<T>

Type Parameters:

T -

All Implemented Interfaces:

FeatureExtractor<EigenFaceFeature,T>, FacialFeatureExtractor<EigenFaceFeature,T>, ReadableBinary, ReadWriteableBinary, WriteableBinary, BatchTrainer<T>

Enclosing class:

EigenFaceFeature

public static class EigenFaceFeature.Extractor<T extends DetectedFace>
extends Object
implements FacialFeatureExtractor<EigenFaceFeature,T>, BatchTrainer<T>

A FacialFeatureExtractor for producing EigenFaces. Unlike most FacialFeatureExtractors, this one either needs to be trained or provided with a pre-trained EigenImages object.

A FaceAligner can be used to produce aligned faces for training and feature extraction.

Author:

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

Constructor Summary

Constructors

Constructor and Description
EigenFaceFeature.Extractor(EigenImages basis, FaceAligner<T> aligner) Construct with given pre-trained EigenImages basis and a face aligner.
EigenFaceFeature.Extractor(int numComponents, FaceAligner<T> aligner) Construct with the requested number of components (the number of PCs to keep) and a face aligner.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	binaryHeader() Header for binary input.
EigenFaceFeature	extractFeature(T face) Extract features from an object and return them.
void	readBinary(DataInput in) Read internal state from in.
String	toString()
void	train(Dataset<? extends T> data) Train from a dataset
void	train(List<? extends T> data) Train the object with the given data.
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, wait, wait, wait

Constructor Detail

EigenFaceFeature.Extractor

public EigenFaceFeature.Extractor(int numComponents,
                          FaceAligner<T> aligner)

Construct with the requested number of components (the number of PCs to keep) and a face aligner. The principal components must be learned by calling train(List).

Parameters:

numComponents - the number of principal components to keep.

aligner - the face aligner

EigenFaceFeature.Extractor

public EigenFaceFeature.Extractor(EigenImages basis,
                          FaceAligner<T> aligner)

Construct with given pre-trained EigenImages basis and a face aligner.

Parameters:

basis - the pre-trained basis

aligner - the face aligner

Method Detail

extractFeature

public EigenFaceFeature extractFeature(T face)

Description copied from interface: FeatureExtractor

Extract features from an object and return them.

Specified by:

extractFeature in interface FeatureExtractor<EigenFaceFeature,T extends DetectedFace>

Parameters:

face - the object to extract from

Returns:

the extracted feature

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

train

public void train(List<? extends T> data)

Description copied from interface: BatchTrainer

Train the object with the given data. BatchTrainers should reset the underlying model everytime this method is called.

Specified by:

train in interface BatchTrainer<T extends DetectedFace>

Parameters:

data - the training data

train

public void train(Dataset<? extends T> data)

Train from a dataset

Parameters:

data - the dataset

toString

public String toString()

Overrides:

toString in class Object