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