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.detection;
031
032import java.io.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035import java.util.ArrayList;
036import java.util.List;
037
038import org.openimaj.image.FImage;
039import org.openimaj.image.Image;
040import org.openimaj.image.MBFImage;
041
042/**
043 * A face detector that does nothing other than wrap the input image in a single
044 * {@link DetectedFace} object.
045 * <p>
046 * This class is only likely to be useful for performing evaluations of
047 * techniques that use datasets where a face has already been extracted/cropped
048 * into an image.
049 * 
050 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
051 * 
052 * @param <IMAGE>
053 *            The type of image
054 */
055public class IdentityFaceDetector<IMAGE extends Image<?, IMAGE>> implements FaceDetector<DetectedFace, IMAGE> {
056
057        @Override
058        public void readBinary(DataInput in) throws IOException {
059                // Do nothing
060        }
061
062        @Override
063        public byte[] binaryHeader() {
064                return IdentityFaceDetector.class.getName().getBytes();
065        }
066
067        @Override
068        public void writeBinary(DataOutput out) throws IOException {
069                // Do nothing
070        }
071
072        @Override
073        public List<DetectedFace> detectFaces(IMAGE image) {
074                DetectedFace face = null;
075                final Object oimage = image;
076
077                if (oimage instanceof FImage)
078                        face = new DetectedFace(image.getBounds(), ((FImage) (oimage)), 1);
079                else if (oimage instanceof MBFImage)
080                        face = new DetectedFace(image.getBounds(), ((MBFImage) (oimage)).flatten(), 1);
081                else
082                        throw new RuntimeException("unsupported image type");
083
084                final List<DetectedFace> faces = new ArrayList<DetectedFace>(1);
085                faces.add(face);
086
087                return faces;
088        }
089
090        @Override
091        public String toString() {
092                return "Identity Face Detector";
093        }
094}