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.feature.local.matcher.consistent;
031
032import java.util.List;
033
034import org.openimaj.feature.local.LocalFeature;
035import org.openimaj.feature.local.matcher.LocalFeatureMatcher;
036import org.openimaj.math.geometry.point.Point2d;
037import org.openimaj.math.model.Model;
038import org.openimaj.math.model.fit.RobustModelFitting;
039
040/**
041 * Interface for classes able to match local features within the constraints of
042 * a mathematical model between pairs of 2d points (i.e. affine transform,
043 * homography, etc).
044 * 
045 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
046 * @param <T>
047 */
048public interface ModelFittingLocalFeatureMatcher<T extends LocalFeature<?, ?> /*
049                                                                                                                                                         * &
050                                                                                                                                                         * Point2d
051                                                                                                                                                         */> extends LocalFeatureMatcher<T> {
052        /**
053         * Set the object which robustly attempts to fit matches to the model
054         * 
055         * @param mf
056         *            fitting model
057         */
058        public void setFittingModel(RobustModelFitting<Point2d, Point2d, ?> mf);
059
060        /**
061         * Attempt to find matches between the model features from the database, and
062         * given query features and learn the parameters of the underlying model
063         * that links the two sets of features.
064         * 
065         * @param queryfeatures
066         *            features from the query
067         */
068        @Override
069        public boolean findMatches(List<T> queryfeatures);
070
071        /**
072         * Get the model that has been learned. Do this after finding matches!
073         * 
074         * @return the model found between the model features and object features
075         *         after a findMatches operation.
076         */
077        public Model<Point2d, Point2d> getModel();
078}