org.openimaj.image.processing.face.similarity

Class FaceSimilarityEngine<D extends DetectedFace,F extends FacialFeature,I extends Image<?,I>>

java.lang.Object

org.openimaj.image.processing.face.similarity.FaceSimilarityEngine<D,F,I>

Type Parameters:

D - The type of DetectedFace

F - the type of FacialFeature

I - The type of Image

public class FaceSimilarityEngine<D extends DetectedFace,F extends FacialFeature,I extends Image<?,I>>
extends Object

The FaceSimilarityEngine allows computation of the similarity between faces in two images.

Author:

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

Constructor Summary

Constructors

Constructor and Description
FaceSimilarityEngine(FaceDetector<D,I> detector, FacialFeatureExtractor<F,D> extractor, FacialFeatureComparator<F> comparator) Construct a new FaceSimilarityEngine from the specified detector, extractor and comparator.

Method Summary

Modifier and Type	Method and Description
FacialFeatureComparator<F>	comparator()
static <D extends DetectedFace,F extends FacialFeature,I extends Image<?,I>> FaceSimilarityEngine<D,F,I>	create(FaceDetector<D,I> detector, FacialFeatureExtractor<F,D> extractor, FacialFeatureComparator<F> comparator) Create a new FaceSimilarityEngine from the specified detector, extractor and comparator.
FaceDetector<D,I>	detector()
FacialFeatureExtractor<F,D>	extractor()
Map<String,Rectangle>	getBoundingBoxes()
Map<String,Map<String,Double>>	getSimilarityDictionary()
SimilarityMatrix	getSimilarityMatrix(boolean invertIfRequired) Get the similarity matrix computed by performTest().
void	performTest() Compute the similarities between faces in the query and target
void	setCache(boolean cache) Set whether detections should be cached
void	setQuery(I queryImage, String queryId) Set the query image.
void	setQueryTest() Compare the query to itself for the next test
void	setTest(I testImage, String testId) Set the image against which the query will be compared to next

Methods inherited from class java.lang.Object

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

Constructor Detail

FaceSimilarityEngine

public FaceSimilarityEngine(FaceDetector<D,I> detector,
                            FacialFeatureExtractor<F,D> extractor,
                            FacialFeatureComparator<F> comparator)

Construct a new FaceSimilarityEngine from the specified detector, extractor and comparator.

Parameters:

detector - The face detector

extractor - The feature extractor

comparator - The feature comparator

Method Detail

detector

public FaceDetector<D,I> detector()

Returns:

the detector

extractor

public FacialFeatureExtractor<F,D> extractor()

Returns:

the featureFactory

comparator

public FacialFeatureComparator<F> comparator()

Returns:

the comparator

create

public static <D extends DetectedFace,F extends FacialFeature,I extends Image<?,I>> FaceSimilarityEngine<D,F,I> create(FaceDetector<D,I> detector,
                                                                                                                       FacialFeatureExtractor<F,D> extractor,
                                                                                                                       FacialFeatureComparator<F> comparator)

Create a new FaceSimilarityEngine from the specified detector, extractor and comparator.

Type Parameters:

D - The type of DetectedFace

F - the type of FacialFeature

I - The type of Image

Parameters:

detector - The face detector

extractor - The feature extractor

comparator - The feature comparator

Returns:

the new FaceSimilarityEngine

setQuery

public void setQuery(I queryImage,
                     String queryId)

Set the query image.

Parameters:

queryImage - the query image

queryId - the identifier of the query image

setTest

public void setTest(I testImage,
                    String testId)

Set the image against which the query will be compared to next

Parameters:

testImage -

testId -

setQueryTest

public void setQueryTest()

Compare the query to itself for the next test

performTest

public void performTest()

Compute the similarities between faces in the query and target

getSimilarityDictionary

public Map<String,Map<String,Double>> getSimilarityDictionary()

Returns:

The similarity dictionary structured as: {image0:face0 => {image0:face0 => DISTANCE,...},...,}

getSimilarityMatrix

public SimilarityMatrix getSimilarityMatrix(boolean invertIfRequired)

Get the similarity matrix computed by performTest().

Parameters:

invertIfRequired - invert distances into similarities if required.

Returns:

the similarity matrix

getBoundingBoxes

public Map<String,Rectangle> getBoundingBoxes()

Returns:

the bounding boxes of the detected faces

setCache

public void setCache(boolean cache)

Set whether detections should be cached

Parameters:

cache - enable cache if true