org.openimaj.feature.local.matcher.consistent.ConsistentLocalFeatureMatcher2d Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of image-local-features Show documentation
Methods for the extraction of local features. Local features are descriptions of regions of images (SIFT, ...) selected by detectors (Difference of Gaussian, Harris, ...).
There is a newer version: 1.3.8
Show newest version
/**
 * Copyright (c) 2011, The University of Southampton and the individual contributors.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *   * 	Redistributions of source code must retain the above copyright notice,
 * 	this list of conditions and the following disclaimer.
 *
 *   *	Redistributions in binary form must reproduce the above copyright notice,
 * 	this list of conditions and the following disclaimer in the documentation
 * 	and/or other materials provided with the distribution.
 *
 *   *	Neither the name of the University of Southampton nor the names of its
 * 	contributors may be used to endorse or promote products derived from this
 * 	software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.openimaj.feature.local.matcher.consistent;

import java.util.ArrayList;
import java.util.List;

import org.openimaj.feature.local.LocalFeature;
import org.openimaj.feature.local.matcher.LocalFeatureMatcher;
import org.openimaj.math.geometry.point.Point2d;
import org.openimaj.math.model.Model;
import org.openimaj.math.model.fit.RobustModelFitting;
import org.openimaj.util.pair.IndependentPair;
import org.openimaj.util.pair.Pair;

/**
 * Object to attempt to find a consistent geometric mapping of two sets of local
 * features according to a given model.
 * 
 * The initial matching is performed by a separate matcher that is provided in
 * the constructor. The list of initial matches is then passed to the
 * modelfitter which attempts to estimate the model and provide a list of inlier
 * pairs, which are then used to populate the consistent matches.
 * 
 * @author Jonathon Hare
 * @param 
 *            The type of LocalFeature
 * 
 */
public class ConsistentLocalFeatureMatcher2d & Point2d>
		implements
		ModelFittingLocalFeatureMatcher
{
	protected LocalFeatureMatcher innerMatcher;
	protected RobustModelFitting modelfit;
	protected List> consistentMatches;

	/**
	 * Default constructor
	 * 
	 * @param innerMatcher
	 *            the internal matcher for getting seed matches
	 */
	public ConsistentLocalFeatureMatcher2d(LocalFeatureMatcher innerMatcher) {
		this.innerMatcher = innerMatcher;

		modelfit = null;
		consistentMatches = new ArrayList>();
	}

	/**
	 * Default constructor
	 * 
	 * @param innerMatcher
	 *            the internal matcher for getting seed matches
	 * @param fit
	 *            the points against which to test consistency
	 */
	public ConsistentLocalFeatureMatcher2d(LocalFeatureMatcher innerMatcher,
			RobustModelFitting fit)
	{
		this(innerMatcher);

		modelfit = fit;
	}

	/**
	 * @return a list of consistent matching keypoints according to the
	 *         estimated model parameters.
	 */
	@Override
	public List> getMatches() {
		return consistentMatches;
	}

	/**
	 * @return a list of all matches irrespective of whether they fit the model
	 */
	public List> getAllMatches() {
		return innerMatcher.getMatches();
	}

	@Override
	public Model getModel() {
		return modelfit.getModel();
	}

	@SuppressWarnings("unchecked")
	@Override
	public boolean findMatches(List keys1)
	{
		// if we're gonna re-use the object, we need to reset everything!
		consistentMatches = new ArrayList>();

		// find the initial matches using the inner matcher
		innerMatcher.findMatches(keys1);
		final List> matches = innerMatcher.getMatches();

		if (matches.size() < modelfit.numItemsToEstimate()) {
			consistentMatches.clear();
			consistentMatches.addAll(matches);
			return false;
		}

		final List> li_p2d = new ArrayList>();
		for (final Pair m : matches) {
			li_p2d.add(new Pair(m.firstObject(), m.secondObject()));
		}

		// fit the model
		final boolean didfit = modelfit.fitData(li_p2d);

		// get the inliers and build the list of consistent matches
		for (final IndependentPair p : modelfit.getInliers()) {
			final Object op = p;
			consistentMatches.add((Pair) op);
		}

		return didfit;
	}

	@Override
	public void setFittingModel(RobustModelFitting mf) {
		modelfit = mf;
	}

	@Override
	public void setModelFeatures(List modelkeys) {
		innerMatcher.setModelFeatures(modelkeys);
	}
}