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.local.list.LocalFeatureList;
037import org.openimaj.feature.local.list.MemoryLocalFeatureList;
038import org.openimaj.image.feature.local.engine.DoGSIFTEngine;
039import org.openimaj.image.feature.local.keypoints.Keypoint;
040import org.openimaj.image.processing.face.detection.DetectedFace;
041import org.openimaj.math.geometry.shape.Rectangle;
042
043/**
044 * A {@link FacialFeature} that uses DoG-SIFT features to 
045 * describe a face.
046 * 
047 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
048 *
049 */
050public class DoGSIFTFeature implements FacialFeature {
051        /**
052         * A {@link FacialFeatureExtractor} for producing {@link DoGSIFTFeature}s
053         * 
054         * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
055         *
056         */
057        public static class Extractor implements FacialFeatureExtractor<DoGSIFTFeature, DetectedFace> {
058                /**
059                 * Default constructor
060                 */
061                public Extractor() {
062                        
063                }
064                
065                @Override
066                public void readBinary(DataInput in) throws IOException {
067                        // currently no state to write
068                }
069
070                @Override
071                public byte[] binaryHeader() {
072                        return this.getClass().getName().getBytes();
073                }
074
075                @Override
076                public void writeBinary(DataOutput out) throws IOException {
077                        // currently no state to read
078                }
079
080                @Override
081                public DoGSIFTFeature extractFeature(DetectedFace face) {
082                        DoGSIFTFeature feature = new DoGSIFTFeature();
083                        feature.initialise(face);
084                        return feature;
085                }
086        }
087        
088        protected LocalFeatureList<Keypoint> keys;
089        protected Rectangle bounds;
090
091        protected void initialise(DetectedFace face) {
092                DoGSIFTEngine engine = new DoGSIFTEngine();
093                keys = engine.findFeatures(face.getFacePatch());
094                bounds = face.getFacePatch().getBounds();
095        }
096        
097        @Override
098        public void readBinary(DataInput in) throws IOException {
099                keys = MemoryLocalFeatureList.readNoHeader(in, Keypoint.class);
100        }
101
102        @Override
103        public byte[] binaryHeader() {
104                return this.getClass().getName().getBytes();
105        }
106
107        @Override
108        public void writeBinary(DataOutput out) throws IOException {
109                keys.writeBinary(out);
110        }
111
112        /**
113         * @return the keys
114         */
115        public LocalFeatureList<Keypoint> getKeys() {
116                return keys;
117        }
118
119        /**
120         * @return the bounds
121         */
122        public Rectangle getBounds() {
123                return bounds;
124        }
125}