org.openimaj.tools.faces

Class FaceSimilarityTool

java.lang.Object

org.openimaj.tools.faces.FaceSimilarityTool

public class FaceSimilarityTool
extends Object

Face similarity tool compares the faces in all given images and gives a score for each comparison. The tool can be made to match only the first image against all other images or comparing all images against all others.

This tool can be used both from the command-line and programmatically. Programmatically, there are some convenience functions for comparing Lists of Files and lists of FImages, however, you are welcome to give the getDistances(List, boolean, ImageGetter, FaceSimilarityEngine) method any List as long as you supply an FaceSimilarityTool.ImageGetter that can return FImages from that list.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

30 May 2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FaceSimilarityTool.ImageGetter<T> An interface to get images and names from a list of things.

Constructor Summary

Constructors

Constructor and Description
FaceSimilarityTool()

Method Summary

Modifier and Type	Method and Description
Map<String,Map<String,Double>>	getDistances(File first, List<File> others, FaceSimilarityEngine<?,?,FImage> strategy) Calculates the distance between all the faces in the first image with all the faces in the given images.
Map<String,Map<String,Double>>	getDistances(List<File> inputFiles, boolean withFirst, FaceSimilarityEngine<?,?,FImage> strategy) Calculates the distance between faces in the given images.
Map<String,Map<String,Double>>	getDistances(List<File> inputFiles, FaceSimilarityEngine<?,?,FImage> strategy) Calculates the distance between faces in the given images.
Map<String,Map<String,Double>>	getDistances(List<String> imageIdentifiers, List<FImage> inputImages, boolean withFirst, FaceSimilarityEngine<?,?,FImage> strategy) Calculates the distance between faces in the given images.
<T> Map<String,Map<String,Double>>	getDistances(List<T> inputList, boolean withFirst, FaceSimilarityTool.ImageGetter<T> iGetter, FaceSimilarityEngine<?,?,FImage> strategy) This is the actual comparison function that performs the nested loops as necessary to match all the faces against each other.
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

FaceSimilarityTool

public FaceSimilarityTool()

Method Detail

getDistances

public Map<String,Map<String,Double>> getDistances(File first,
                                                   List<File> others,
                                                   FaceSimilarityEngine<?,?,FImage> strategy)

Calculates the distance between all the faces in the first image with all the faces in the given images. Faces are identified by their image file and the index into the file, so if an image does not contain any faces, it will return null from the map for that filename.

Parameters:

first - The query image

others - The list of files to compare against

strategy - The strategy

Returns:

A Map giving the distance of every face with every other.

getDistances

public Map<String,Map<String,Double>> getDistances(List<File> inputFiles,
                                                   FaceSimilarityEngine<?,?,FImage> strategy)

Calculates the distance between faces in the given images. Faces are identified by their image file and the index into the file, so if an image does not contain any faces, it will return null from the map for that filename.

Parameters:

inputFiles - The list of files to process

strategy - the strategy

Returns:

A Map giving the distance of every face with every other.

getDistances

public Map<String,Map<String,Double>> getDistances(List<File> inputFiles,
                                                   boolean withFirst,
                                                   FaceSimilarityEngine<?,?,FImage> strategy)

Calculates the distance between faces in the given images. Faces are identified by their image file and the index into the file, so if an image does not contain any faces, it will return null from the map for that filename.

Parameters:

inputFiles - The list of files to process

withFirst - if TRUE, the first image in the list will be matched against all others, otherwise all images are matches against each other.

strategy - The strategy

Returns:

A Map giving the distance of every face with every other.

getDistances

public Map<String,Map<String,Double>> getDistances(List<String> imageIdentifiers,
                                                   List<FImage> inputImages,
                                                   boolean withFirst,
                                                   FaceSimilarityEngine<?,?,FImage> strategy)

Calculates the distance between faces in the given images. Faces are identified by their image file and the index into the file, so if an image does not contain any faces, it will return null from the map for that filename.

Parameters:

imageIdentifiers - A list of image names

inputImages - The list of images to process

withFirst - if TRUE, the first image in the list will be matched against all others, otherwise all images are matches against each other.

strategy - The strategy.

Returns:

A Map giving the distance of every face with every other.

getDistances

public <T> Map<String,Map<String,Double>> getDistances(List<T> inputList,
                                                       boolean withFirst,
                                                       FaceSimilarityTool.ImageGetter<T> iGetter,
                                                       FaceSimilarityEngine<?,?,FImage> strategy)

This is the actual comparison function that performs the nested loops as necessary to match all the faces against each other.

Type Parameters:

T - The type of thing in the input list

Parameters:

inputList - A list of things to process

withFirst - Whether to compare the first against all others (TRUE) or compare all against each other (FALSE)

iGetter - The getter that can make FImages from the input list.

strategy - The strategy

Returns:

A Map giving the distance of every face with every other.

main

public static void main(String[] args)

Parameters:

args -