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.analysis.pyramid.OctaveProcessor;
036import org.openimaj.image.processor.SinglebandImageProcessor;
037
038/**
039 * Interface for objects that can detect interest points within an
040 * octave.
041 * 
042 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
043 *
044 * @param <OCTAVE> Type of underlying {@link Octave}
045 * @param <IMAGE> Type of underlying {@link Image}
046 */
047public interface OctaveInterestPointFinder<
048                OCTAVE extends Octave<?,?,IMAGE>, 
049                IMAGE extends Image<?,IMAGE> & SinglebandImageProcessor.Processable<Float,FImage,IMAGE>> 
050        extends 
051                OctaveProcessor<OCTAVE,IMAGE> 
052{
053        /**
054         * Get the octave from which we are operating
055         * 
056         * @return the octave
057         */
058        public OCTAVE getOctave();
059        
060        /**
061         * Get the current scale index within the octave. Index 0 is the
062         * first level of the octave.
063         * 
064         * @return the current scale index.
065         */
066        public int getCurrentScaleIndex();
067        
068        /**
069         * Set a listener object that will listen to events triggered when interest
070         * points are detected.
071         * 
072         * @param listener the listener 
073         */
074        public void setOctaveInterestPointListener(OctaveInterestPointListener<OCTAVE, IMAGE> listener);
075        
076        /**
077         * Get the current listener object.
078         * 
079         * @return the listener, or null if none set.
080         */
081        public OctaveInterestPointListener<OCTAVE,IMAGE> getOctaveInterestPointListener();
082}