001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.image.processing.face.recognition;
031
032import java.util.Collection;
033import java.util.Collections;
034import java.util.List;
035import java.util.Set;
036
037import org.openimaj.image.processing.face.detection.DetectedFace;
038import org.openimaj.io.ReadWriteableBinary;
039import org.openimaj.ml.annotation.IncrementalAnnotator;
040import org.openimaj.ml.annotation.RestrictedAnnotator;
041import org.openimaj.ml.annotation.ScoredAnnotation;
042
043/**
044 * Base class for all Face Recognisers.
045 * 
046 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
047 * 
048 * @param <FACE>
049 *            Type of {@link DetectedFace}
050 * @param <PERSON>
051 *            Type of object representing a person
052 */
053public abstract class FaceRecogniser<FACE extends DetectedFace, PERSON>
054                extends
055                IncrementalAnnotator<FACE, PERSON>
056                implements
057                RestrictedAnnotator<FACE, PERSON>,
058                ReadWriteableBinary
059{
060        protected FaceRecogniser() {
061        }
062
063        /**
064         * Attempt to recognize the given face, restricting the potential people to
065         * coming from the given set.
066         * 
067         * @param object
068         *            the detected face
069         * @param restrict
070         *            the set of allowed people
071         * @return potential people
072         */
073        @Override
074        public abstract List<ScoredAnnotation<PERSON>> annotate(FACE object, Collection<PERSON> restrict);
075
076        /**
077         * Attempt to recognize the given face, restricting the potential people to
078         * coming from the given set.
079         * 
080         * @param object
081         *            the detected face
082         * @param restrict
083         *            the set of allowed people
084         * @return potential people
085         */
086        public ScoredAnnotation<PERSON> annotateBest(FACE object, Collection<PERSON> restrict) {
087                final List<ScoredAnnotation<PERSON>> pot = annotate(object, restrict);
088
089                if (pot == null || pot.size() == 0)
090                        return null;
091
092                Collections.sort(pot);
093
094                return pot.get(0);
095        }
096
097        /**
098         * Attempt to recognize the given face.
099         * 
100         * @param object
101         *            the detected face
102         * @return potential people
103         */
104        @Override
105        public abstract List<ScoredAnnotation<PERSON>> annotate(FACE object);
106
107        /**
108         * Attempt to recognize the given face.
109         * 
110         * @param object
111         *            the detected face
112         * @return potential people
113         */
114        public ScoredAnnotation<PERSON> annotateBest(FACE object) {
115                final List<ScoredAnnotation<PERSON>> pot = annotate(object);
116
117                if (pot == null || pot.size() == 0)
118                        return null;
119
120                return pot.get(0);
121        }
122
123        /**
124         * Convenience method for {@link #getAnnotations()}
125         * 
126         * @see #getAnnotations()
127         * @return the people that can be recognised
128         */
129        public Set<PERSON> listPeople() {
130                return this.getAnnotations();
131        }
132}