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