org.openimaj.image.processing.face.recognition

Class AnnotatorFaceRecogniser<FACE extends DetectedFace,PERSON>

java.lang.Object

org.openimaj.ml.annotation.AbstractAnnotator<OBJECT,ANNOTATION>

org.openimaj.ml.annotation.IncrementalAnnotator<FACE,PERSON>

org.openimaj.image.processing.face.recognition.FaceRecogniser<FACE,PERSON>

org.openimaj.image.processing.face.recognition.AnnotatorFaceRecogniser<FACE,PERSON>

Type Parameters:

FACE - Type of DetectedFace

PERSON - Type of object representing a person

All Implemented Interfaces:

Classifier<PERSON,FACE>, ReadableBinary, ReadWriteableBinary, WriteableBinary, Annotator<FACE,PERSON>, RestrictedAnnotator<FACE,PERSON>, IncrementalTrainer<Annotated<FACE,PERSON>>

public class AnnotatorFaceRecogniser<FACE extends DetectedFace,PERSON>
extends FaceRecogniser<FACE,PERSON>

A FaceRecogniser built on top of an IncrementalAnnotator. This class essentially adapts standard IncrementalAnnotator to work in the face recognition scenario.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected IncrementalAnnotator<FACE,PERSON>	annotator

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnnotatorFaceRecogniser()
	AnnotatorFaceRecogniser(IncrementalAnnotator<FACE,PERSON> annotator) Construct with the given underlying annotator.

Method Summary

Methods

Modifier and Type	Method and Description
List<ScoredAnnotation<PERSON>>	annotate(FACE object) Attempt to recognize the given face.
List<ScoredAnnotation<PERSON>>	annotate(FACE object, Collection<PERSON> restrict) Attempt to recognize the given face, restricting the potential people to coming from the given set.
byte[]	binaryHeader() Header for binary input.
static <FACE extends DetectedFace,EXTRACTOR extends FeatureExtractor<?,FACE>,PERSON> AnnotatorFaceRecogniser<FACE,PERSON>	create(IncrementalAnnotator<FACE,PERSON> annotator) Convenience method to create AnnotatorFaceRecogniser instances from an annotator.
Set<PERSON>	getAnnotations()
void	readBinary(DataInput in) Read internal state from in.
void	reset() Reset the object to its initial condition, as if it hasn't seen any training data.
String	toString()
void	train(Annotated<FACE,PERSON> annotedImage) Train/update object using a new instance.
void	train(Iterable<? extends Annotated<FACE,PERSON>> data) Train the annotator with the given data.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class org.openimaj.image.processing.face.recognition.FaceRecogniser

annotateBest, annotateBest, listPeople

Methods inherited from class org.openimaj.ml.annotation.IncrementalAnnotator

train, trainMultiClass

Methods inherited from class org.openimaj.ml.annotation.AbstractAnnotator

classify

Methods inherited from class java.lang.Object

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

Field Detail

annotator

protected IncrementalAnnotator<FACE extends DetectedFace,PERSON> annotator

Constructor Detail

AnnotatorFaceRecogniser

protected AnnotatorFaceRecogniser()

AnnotatorFaceRecogniser

public AnnotatorFaceRecogniser(IncrementalAnnotator<FACE,PERSON> annotator)

Construct with the given underlying annotator.

Parameters:

annotator - the annotator

Method Detail

create

public static <FACE extends DetectedFace,EXTRACTOR extends FeatureExtractor<?,FACE>,PERSON> AnnotatorFaceRecogniser<FACE,PERSON> create(IncrementalAnnotator<FACE,PERSON> annotator)

Convenience method to create AnnotatorFaceRecogniser instances from an annotator.

Type Parameters:

FACE - Type of DetectedFace

EXTRACTOR - Type of FeatureExtractor

PERSON - Type of object representing a person

Parameters:

annotator - the annotator

Returns:

the new AnnotatorFaceRecogniser instance

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

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().

Returns:

header

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

annotate

public List<ScoredAnnotation<PERSON>> annotate(FACE object,
                                      Collection<PERSON> restrict)

Description copied from class: FaceRecogniser

Attempt to recognize the given face, restricting the potential people to coming from the given set.

Specified by:

annotate in interface RestrictedAnnotator<FACE extends DetectedFace,PERSON>

Specified by:

annotate in class FaceRecogniser<FACE extends DetectedFace,PERSON>

Parameters:

object - the detected face

restrict - the set of allowed people

Returns:

potential people

annotate

public List<ScoredAnnotation<PERSON>> annotate(FACE object)

Description copied from class: FaceRecogniser

Attempt to recognize the given face.

Specified by:

annotate in interface Annotator<FACE extends DetectedFace,PERSON>

Specified by:

annotate in class FaceRecogniser<FACE extends DetectedFace,PERSON>

Parameters:

object - the detected face

Returns:

potential people

train

public void train(Annotated<FACE,PERSON> annotedImage)

Description copied from interface: IncrementalTrainer

Train/update object using a new instance.

Parameters:

annotedImage - instance to train with

train

public void train(Iterable<? extends Annotated<FACE,PERSON>> data)

Description copied from class: IncrementalAnnotator

Train the annotator with the given data. The default implementation of this method just calls IncrementalTrainer.train(Object) on each data item. Subclasses may override to do something more intelligent if necessary.

Specified by:

train in interface IncrementalTrainer<Annotated<FACE extends DetectedFace,PERSON>>

Overrides:

train in class IncrementalAnnotator<FACE extends DetectedFace,PERSON>

Parameters:

data - the training data

getAnnotations

public Set<PERSON> getAnnotations()

Returns:

a Set of all annotations this Annotator knows about

reset

public void reset()

Description copied from interface: IncrementalTrainer

Reset the object to its initial condition, as if it hasn't seen any training data.

toString

public String toString()

Overrides:

toString in class Object