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.feature.local.detector.dog.extractor;
031
032import org.openimaj.feature.FloatFV;
033import org.openimaj.image.FImage;
034import org.openimaj.image.feature.local.extraction.FeatureVectorExtractor;
035import org.openimaj.image.feature.local.extraction.GradientScaleSpaceImageExtractorProperties;
036
037/**
038 * Abstract superclass for objects capable of finding the dominant
039 * orientation of a point in scale-space.
040 * 
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 */
043public abstract class AbstractDominantOrientationExtractor implements FeatureVectorExtractor<FloatFV, GradientScaleSpaceImageExtractorProperties<FImage>> {
044        /**
045         * Find the dominant orientations
046         * 
047         * @param props Properties describing the interest point in scale space.
048         * @return an FloatFV containing the angles of the dominant orientations [-PI to PI].
049         */
050        @Override
051        public FloatFV[] extractFeature(GradientScaleSpaceImageExtractorProperties<FImage> props) {
052                return new FloatFV[] { new FloatFV(extractFeatureRaw(props)) };
053        }
054
055        /**
056         * Find the dominant orientations.
057         * 
058         * @param props Properties describing the interest point in scale space.
059         * @return an array of the angles of the dominant orientations [-PI to PI].
060         */
061        public abstract float[] extractFeatureRaw(GradientScaleSpaceImageExtractorProperties<FImage> props);
062}