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.collector;
031
032import org.openimaj.feature.FeatureVector;
033import org.openimaj.feature.local.LocalFeature;
034import org.openimaj.feature.local.LocalFeatureImpl;
035import org.openimaj.feature.local.Location;
036import org.openimaj.feature.local.ScaleSpaceLocation;
037import org.openimaj.image.FImage;
038import org.openimaj.image.Image;
039import org.openimaj.image.analysis.pyramid.Octave;
040import org.openimaj.image.feature.local.detector.pyramid.OctaveInterestPointFinder;
041import org.openimaj.image.feature.local.extraction.FeatureVectorExtractor;
042import org.openimaj.image.feature.local.extraction.ScaleSpaceImageExtractorProperties;
043import org.openimaj.image.processor.SinglebandImageProcessor;
044
045/**
046 * Concrete implementation of an {@link AbstractOctaveLocalFeatureCollector}
047 * that collects {@link LocalFeature}s in the form of {@link LocalFeatureImpl}
048 * with the feature vector provided by the given feature extractor, and the
049 * {@link Location} provided by a {@link ScaleSpaceLocation} with an x, y and
050 * scale coordinates.
051 * 
052 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
053 * 
054 * @param <OCTAVE>
055 *            the underlying {@link Octave} type
056 * @param <FE>
057 *            the underlying {@link FeatureVectorExtractor} type
058 * @param <IMAGE>
059 *            the image type
060 */
061public class ConcreteOctaveLocalFeatureCollector<OCTAVE extends Octave<?, ?, IMAGE>, FE extends FeatureVectorExtractor<?, ScaleSpaceImageExtractorProperties<IMAGE>>, IMAGE extends Image<?, IMAGE> & SinglebandImageProcessor.Processable<Float, FImage, IMAGE>>
062                extends
063                AbstractOctaveLocalFeatureCollector<OCTAVE, FE, LocalFeature<?, ?>, IMAGE>
064{
065        protected ScaleSpaceImageExtractorProperties<IMAGE> extractionProperties = new ScaleSpaceImageExtractorProperties<IMAGE>();
066
067        /**
068         * Construct with the given feature extractor.
069         * 
070         * @param featureExtractor
071         *            the feature extractor.
072         */
073        public ConcreteOctaveLocalFeatureCollector(FE featureExtractor) {
074                super(featureExtractor);
075        }
076
077        @Override
078        public void foundInterestPoint(OctaveInterestPointFinder<OCTAVE, IMAGE> finder, float x, float y, float octaveScale) {
079                final int currentScaleIndex = finder.getCurrentScaleIndex();
080                extractionProperties.image = finder.getOctave().images[currentScaleIndex];
081                extractionProperties.scale = octaveScale;
082                extractionProperties.x = x;
083                extractionProperties.y = y;
084
085                final float octSize = finder.getOctave().octaveSize;
086
087                addFeature(octSize * x, octSize * y, octSize * octaveScale);
088        }
089
090        protected void addFeature(float imx, float imy, float imscale) {
091                final FeatureVector[] fvs = featureExtractor.extractFeature(extractionProperties);
092
093                final Location loc = new ScaleSpaceLocation(imx, imy, imscale);
094
095                for (final FeatureVector fv : fvs) {
096                        features.add(new LocalFeatureImpl<Location, FeatureVector>(loc, fv));
097                }
098        }
099}