org.openimaj.image.processing.face.recognition

Class FaceRecogniser<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>

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>>

Direct Known Subclasses:

AnnotatorFaceRecogniser, EigenFaceRecogniser, FisherFaceRecogniser

public abstract class FaceRecogniser<FACE extends DetectedFace,PERSON>
extends IncrementalAnnotator<FACE,PERSON>
implements RestrictedAnnotator<FACE,PERSON>, ReadWriteableBinary

Base class for all Face Recognisers.

Author:

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FaceRecogniser()

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<ScoredAnnotation<PERSON>>	annotate(FACE object) Attempt to recognize the given face.
abstract 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.
ScoredAnnotation<PERSON>	annotateBest(FACE object) Attempt to recognize the given face.
ScoredAnnotation<PERSON>	annotateBest(FACE object, Collection<PERSON> restrict) Attempt to recognize the given face, restricting the potential people to coming from the given set.
Set<PERSON>	listPeople() Convenience method for Annotator.getAnnotations()

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

train, 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, toString, wait, wait, wait

Methods inherited from interface org.openimaj.io.ReadableBinary

binaryHeader, readBinary

Methods inherited from interface org.openimaj.io.WriteableBinary

binaryHeader, writeBinary

Methods inherited from interface org.openimaj.ml.training.IncrementalTrainer

reset, train

Methods inherited from interface org.openimaj.ml.annotation.Annotator

getAnnotations

Constructor Detail

FaceRecogniser

protected FaceRecogniser()

Method Detail

annotate

public abstract 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.

Specified by:

annotate in interface RestrictedAnnotator<FACE extends DetectedFace,PERSON>

Parameters:

object - the detected face

restrict - the set of allowed people

Returns:

potential people

annotateBest

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

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

Parameters:

object - the detected face

restrict - the set of allowed people

Returns:

potential people

annotate

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

Attempt to recognize the given face.

Specified by:

annotate in interface Annotator<FACE extends DetectedFace,PERSON>

Parameters:

object - the detected face

Returns:

potential people

annotateBest

public ScoredAnnotation<PERSON> annotateBest(FACE object)

Attempt to recognize the given face.

Parameters:

object - the detected face

Returns:

potential people

listPeople

public Set<PERSON> listPeople()

Convenience method for Annotator.getAnnotations()

Returns:

the people that can be recognised

See Also:

Annotator.getAnnotations()