boofcv.abst.feature.associate.AssociateDescription Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of boofcv-feature Show documentation

BoofCV is an open source Java library for real-time computer vision and robotics applications.

There is a newer version: 1.1.7

/*
 * Copyright (c) 2011-2020, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.abst.feature.associate;

import org.ddogleg.struct.FastAccess;
import org.ddogleg.struct.FastQueue;


/**
 * 
 * Generalized interface for associating features.   Finds matches for each feature in the source
 * list to one in the destination list.  There is only one match found for each member of source, but multiple
 * matches can be found for destination.  If the best match has an error which is too high then a member of
 * source might not be matched.
 * 
 *
 * 
 * DESIGN NOTE: {@link FastQueue} is used instead of {@link java.util.List} because in the association
 * micro benchmark it produced results that were about 20% faster consistently.  Which is surprising since
 * one would think descriptor comparisons would dominate.
 * 
 *
 * @param  Feature description type.
 *
 * @author Peter Abeles
 */
public interface AssociateDescription extends Associate {

	/**
	 * Sets the list of source features.
	 *
	 * NOTE: A reference to the input list might be saved internally until the next call to this function.
	 *
	 * @param listSrc List of features
	 */
	void setSource( FastAccess listSrc );

	/**
	 * Sets the list of destination features
	 *
	 * NOTE: A reference to the input list might be saved internally until the next call to this function.
	 *
	 * @param listDst List of features
	 */
	void setDestination( FastAccess listDst );
}