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