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;
031
032import java.io.DataInput;
033import java.io.DataOutput;
034import java.io.IOException;
035
036import org.openimaj.feature.DoubleFV;
037import org.openimaj.feature.FeatureVectorProvider;
038import org.openimaj.image.processing.face.detection.CLMDetectedFace;
039
040/**
041 * A feature-vector that describes the shape of a face through a list of
042 * eigen-weights on a point distribution model. This feature is potentially
043 * useful for classifying expressions.
044 * 
045 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
046 */
047public class CLMShapeFeature implements FacialFeature, FeatureVectorProvider<DoubleFV> {
048        /**
049         * A {@link FacialFeatureExtractor} for providing {@link CLMShapeFeature}s.
050         * 
051         * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
052         */
053        public static class Extractor implements FacialFeatureExtractor<CLMShapeFeature, CLMDetectedFace> {
054                @Override
055                public CLMShapeFeature extractFeature(CLMDetectedFace face) {
056                        return new CLMShapeFeature(face.getShapeParameters());
057                }
058
059                @Override
060                public void readBinary(DataInput in) throws IOException {
061                        // nothing to do
062                }
063
064                @Override
065                public byte[] binaryHeader() {
066                        return this.getClass().getName().getBytes();
067                }
068
069                @Override
070                public void writeBinary(DataOutput out) throws IOException {
071                        // nothing to do
072                }
073        }
074
075        private DoubleFV fv;
076
077        protected CLMShapeFeature() {
078                this(null);
079        }
080
081        /**
082         * Construct the {@link CLMShapeFeature} with the given feature vector.
083         * 
084         * @param fv
085         *            the feature vector
086         */
087        public CLMShapeFeature(DoubleFV fv) {
088                this.fv = fv;
089        }
090
091        @Override
092        public void readBinary(DataInput in) throws IOException {
093                fv = new DoubleFV();
094                fv.readBinary(in);
095        }
096
097        @Override
098        public byte[] binaryHeader() {
099                return getClass().getName().getBytes();
100        }
101
102        @Override
103        public void writeBinary(DataOutput out) throws IOException {
104                fv.writeBinary(out);
105        }
106
107        @Override
108        public DoubleFV getFeatureVector() {
109                return fv;
110        }
111}