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.pyramid;
031
032import org.openimaj.image.FImage;
033import org.openimaj.image.Image;
034import org.openimaj.image.analysis.pyramid.Octave;
035import org.openimaj.image.processor.SinglebandImageProcessor;
036
037/**
038 * Abstract base class for objects capable of detecting interest points
039 * within an octave.
040 * 
041 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
042 * 
043 * @param <OCTAVE> Type of underlying {@link Octave}
044 * @param <IMAGE> Type of underlying {@link Image}
045 */
046public abstract class AbstractOctaveInterestPointFinder<
047                OCTAVE extends Octave<?,?,IMAGE>, 
048                IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>> 
049        implements 
050                OctaveInterestPointFinder<OCTAVE, IMAGE> 
051{
052        /**
053         * The current octave.  
054         */
055        protected OCTAVE octave;
056        
057        /**
058         * The index of the scale currently being processed within the octave.
059         * This should be changed as the finder progresses through the scales.
060         */
061        protected int currentScaleIndex;
062        
063        /**
064         * The listener object that gets informed when interest points are detected.
065         */
066        protected OctaveInterestPointListener<OCTAVE, IMAGE> listener;
067        
068        /* (non-Javadoc)
069         * @see dogsiftdevel.pyramid.OctaveInterestPointFinder#getOctave()
070         */
071        @Override
072        public OCTAVE getOctave() {
073                return octave;
074        }
075
076        /* (non-Javadoc)
077         * @see dogsiftdevel.pyramid.OctaveInterestPointFinder#getCurrentScaleIndex()
078         */
079        @Override
080        public int getCurrentScaleIndex() {
081                return currentScaleIndex;
082        }
083
084        /* (non-Javadoc)
085         * @see dogsiftdevel.pyramid.OctaveInterestPointFinder#setInterestPointListener(dogsiftdevel.pyramid.OctaveInterestPointListener)
086         */
087        @Override
088        public void setOctaveInterestPointListener(OctaveInterestPointListener<OCTAVE, IMAGE> listener) {
089                this.listener = listener;
090        }
091
092        /* (non-Javadoc)
093         * @see dogsiftdevel.pyramid.OctaveInterestPointFinder#getInterestPointListener()
094         */
095        @Override
096        public OctaveInterestPointListener<OCTAVE, IMAGE> getOctaveInterestPointListener() {
097                return listener;
098        }
099}