org.openimaj.image.processing.face.recognition.FaceRecogniser Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of faces Show documentation
Show all versions of faces Show documentation
Implementation of a flexible face-recognition pipeline,
including pluggable detectors, aligners, feature extractors
and recognisers.
/**
* Copyright (c) 2011, The University of Southampton and the individual contributors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of the University of Southampton nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.openimaj.image.processing.face.recognition;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import org.openimaj.image.processing.face.detection.DetectedFace;
import org.openimaj.io.ReadWriteableBinary;
import org.openimaj.ml.annotation.IncrementalAnnotator;
import org.openimaj.ml.annotation.RestrictedAnnotator;
import org.openimaj.ml.annotation.ScoredAnnotation;
/**
* Base class for all Face Recognisers.
*
* @author Jonathon Hare ([email protected])
*
* @param
* Type of {@link DetectedFace}
* @param
* Type of object representing a person
*/
public abstract class FaceRecogniser
extends
IncrementalAnnotator
implements
RestrictedAnnotator,
ReadWriteableBinary
{
protected FaceRecogniser() {
}
/**
* Attempt to recognize the given face, restricting the potential people to
* coming from the given set.
*
* @param object
* the detected face
* @param restrict
* the set of allowed people
* @return potential people
*/
@Override
public abstract List> annotate(FACE object, Collection restrict);
/**
* Attempt to recognize the given face, restricting the potential people to
* coming from the given set.
*
* @param object
* the detected face
* @param restrict
* the set of allowed people
* @return potential people
*/
public ScoredAnnotation annotateBest(FACE object, Collection restrict) {
final List> pot = annotate(object, restrict);
if (pot == null || pot.size() == 0)
return null;
Collections.sort(pot);
return pot.get(0);
}
/**
* Attempt to recognize the given face.
*
* @param object
* the detected face
* @return potential people
*/
@Override
public abstract List> annotate(FACE object);
/**
* Attempt to recognize the given face.
*
* @param object
* the detected face
* @return potential people
*/
public ScoredAnnotation annotateBest(FACE object) {
final List> pot = annotate(object);
if (pot == null || pot.size() == 0)
return null;
return pot.get(0);
}
/**
* Convenience method for {@link #getAnnotations()}
*
* @see #getAnnotations()
* @return the people that can be recognised
*/
public Set listPeople() {
return this.getAnnotations();
}
}