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