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.engine.ipd;
031
032import org.openimaj.image.feature.local.detector.ipd.finder.CharacteristicOctaveInterestPointFinder;
033
034import org.openimaj.image.feature.local.detector.ipd.finder.LoggingOctaveInterestPointFinder;
035import org.openimaj.image.feature.local.detector.ipd.finder.OctaveInterestPointFinder;
036import org.openimaj.image.feature.local.interest.IPDSelectionMode;
037import org.openimaj.image.feature.local.interest.InterestPointData;
038import org.openimaj.image.feature.local.interest.InterestPointDetector;
039
040/**
041 * The type of finder to use
042 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
043 *
044 * @param <T>
045 */
046public interface FinderMode<T extends InterestPointData> {
047        /**
048         * Given a detector and the selection pmode
049         * @param detector
050         * @param selectionMode
051         * @return the finder instance
052         */
053        public OctaveInterestPointFinder<T> finder(InterestPointDetector<T> detector, IPDSelectionMode selectionMode);
054        /**
055         * An {@link OctaveInterestPointFinder} is considered the most basic.
056         * @author Sina Samangooei (ss@ecs.soton.ac.uk)
057         *
058         * @param <T>
059         */
060        static class Basic<T extends InterestPointData> implements FinderMode<T>{
061                @Override
062                public OctaveInterestPointFinder<T> finder(InterestPointDetector<T> detector,IPDSelectionMode selectionMode) {
063                        return new OctaveInterestPointFinder<T>(detector,selectionMode);
064                }
065        }
066        /**
067         * A logging logs as well as finding points. Mainly used to debug
068         * @author Sina Samangooei (ss@ecs.soton.ac.uk)
069         *
070         * @param <T>
071         */
072        static class Logging<T extends InterestPointData> implements FinderMode<T>{
073                @Override
074                public OctaveInterestPointFinder<T> finder(InterestPointDetector<T> detector,IPDSelectionMode selectionMode) {
075                        return new LoggingOctaveInterestPointFinder<T>(detector,selectionMode);
076                }
077        }
078        /**
079         * The characteristic finder throws away ellipses that are basically the same, keeping the strongest one.
080         * @author Sina Samangooei (ss@ecs.soton.ac.uk)
081         *
082         * @param <T>
083         */
084        static class Characteristic<T extends InterestPointData> implements FinderMode<T>{
085                private CharacteristicOctaveInterestPointFinder<T> settings;
086
087                public Characteristic(){
088                        settings = new CharacteristicOctaveInterestPointFinder<T>(null,null);
089                }
090                
091                public Characteristic(int maxDistance, double maxRotation, double maxAxisRatio){
092                        settings = new CharacteristicOctaveInterestPointFinder<T>(null,null);
093                        settings.maxDistance = maxDistance;
094                        settings.maxRotation = maxRotation;
095                        settings.maxAxisRatio = maxAxisRatio;
096                }
097                
098                public Characteristic(int maxDistance){
099                        settings = new CharacteristicOctaveInterestPointFinder<T>(null,null);
100                        settings.maxDistance = maxDistance;
101                }
102                
103                @Override
104                public OctaveInterestPointFinder<T> finder(InterestPointDetector<T> detector,IPDSelectionMode selectionMode) {
105                        CharacteristicOctaveInterestPointFinder<T> n = new CharacteristicOctaveInterestPointFinder<T>(detector,selectionMode);
106                        n.maxDistance = settings.maxDistance;
107                        n.maxRotation = settings.maxRotation;
108                        n.maxAxisRatio = settings.maxAxisRatio;
109                        return n;
110                }
111        }
112}