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.interest;
031
032import java.util.List;
033
034import org.openimaj.image.FImage;
035import org.openimaj.math.geometry.shape.Rectangle;
036
037/**
038 * A detector of interest points.
039 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
040 * @param <T> The type of {@link InterestPointData}
041 *
042 */
043public interface InterestPointDetector<T extends InterestPointData> extends Cloneable {
044        /**
045         * Find the interest points in an image
046         * @param image
047         */
048        public void findInterestPoints(FImage image);
049        
050        /**
051         * Find the interest points in an image
052         * @param image
053         * @param window
054         */
055        void findInterestPoints(FImage image, Rectangle window);
056        
057        /**
058         * Retrieve the interest points found
059         * @param npoints number of interest points to retrieve, < 0 returns all
060         * @return interest points
061         */
062        public List<T> getInterestPoints(int npoints);
063        
064        /**
065         * Retrieve the interest points found whose normalised score exceeds the threshold
066         * @param threshold normalised threshold
067         * @return interest points
068         */
069        public List<T> getInterestPoints(float threshold);
070        
071        /**
072         * Get all the interest points found.
073         * @return all interest points
074         */
075        public List<T> getInterestPoints();
076        
077        /**
078         * 
079         * @param detectionScaleVariance
080         */
081        public void setDetectionScale(float detectionScaleVariance);
082
083        public void setIntegrationScale(float currentScale);
084}