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.feature.comparison;
031
032import java.io.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035
036import org.openimaj.feature.FVComparator;
037import org.openimaj.feature.FeatureVector;
038import org.openimaj.feature.FeatureVectorProvider;
039import org.openimaj.image.processing.face.feature.FacialFeature;
040import org.openimaj.io.IOUtils;
041
042/**
043 * A generic {@link FacialFeatureComparator} for {@link FacialFeature}s that can
044 * provide {@link FeatureVector}s through the {@link FeatureVectorProvider}
045 * interface. Any compatible {@link FVComparator} can be used to compare
046 * features.
047 * 
048 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
049 * 
050 * @param <T>
051 *            Type of feature
052 * @param <Q>
053 *            Type of featurevector
054 */
055public class FaceFVComparator<T extends FacialFeature & FeatureVectorProvider<Q>, Q extends FeatureVector>
056                implements
057                        FacialFeatureComparator<T>
058{
059        FVComparator<Q> comp;
060
061        /**
062         * Construct with the given {@link FVComparator}
063         * 
064         * @param comp
065         *            the comparison technique
066         */
067        public FaceFVComparator(FVComparator<Q> comp) {
068                this.comp = comp;
069        }
070
071        @Override
072        public double compare(T query, T target) {
073                return comp.compare(query.getFeatureVector(), target.getFeatureVector());
074        }
075
076        @Override
077        public boolean isDistance() {
078                return comp.isDistance();
079        }
080
081        @Override
082        public void readBinary(DataInput in) throws IOException {
083                comp = IOUtils.read(in);
084        }
085
086        @Override
087        public byte[] binaryHeader() {
088                return this.getClass().getName().getBytes();
089        }
090
091        @Override
092        public void writeBinary(DataOutput out) throws IOException {
093                IOUtils.write(comp, out);
094        }
095
096        @Override
097        public String toString() {
098                return "FaceFVComparator[distance=" + comp + "]";
099        }
100}