boofcv.abst.feature.associate

Class AssociateNearestNeighbor<D extends TupleDesc_F64>

java.lang.Object

boofcv.abst.feature.associate.AssociateNearestNeighbor<D>

All Implemented Interfaces:

Associate, AssociateDescription<D>

public class AssociateNearestNeighbor<D extends TupleDesc_F64>
extends Object
implements AssociateDescription<D>

Matches features using a NearestNeighbor search from DDogleg. The source features are processed as a lump using NearestNeighbor.setPoints(java.util.List, java.util.List) while destination features are matched one at time using NearestNeighbor.findNearest(double[], double, org.ddogleg.nn.NnData). Typically the processing of source features is more expensive and should be minimized while looking up destination features is fast. Multiple matches for source features are possible while there will only be a unique match for each destination feature.

Author:

Peter Abeles

Constructor Summary

Constructors

Constructor and Description
AssociateNearestNeighbor(org.ddogleg.nn.NearestNeighbor<Integer> alg, int featureDimension)

Method Summary

Methods

Modifier and Type	Method and Description
void	associate() Finds the best match for each item in the source list with an item in the destination list.
org.ddogleg.struct.FastQueue<AssociatedIndex>	getMatches() List of associated features.
MatchScoreType	getScoreType() Specifies the type of score which is returned.
org.ddogleg.struct.GrowQueue_I32	getUnassociatedDestination() Indexes of features in the destination set which are not associated.
org.ddogleg.struct.GrowQueue_I32	getUnassociatedSource() Indexes of features in the source set which are not associated.
void	setDestination(org.ddogleg.struct.FastQueue<D> listDst) Sets the list of destination features NOTE: A reference to the input list might be saved internally until the next call to this function.
void	setSource(org.ddogleg.struct.FastQueue<D> listSrc) Sets the list of source features.
void	setThreshold(double score) Associations are only considered if their score is less than the specified threshold.
boolean	uniqueDestination() If at most one match is returned for each destination feature.
boolean	uniqueSource() If at most one match is returned for each source feature.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssociateNearestNeighbor

public AssociateNearestNeighbor(org.ddogleg.nn.NearestNeighbor<Integer> alg,
                        int featureDimension)

Method Detail

setSource

public void setSource(org.ddogleg.struct.FastQueue<D> listSrc)

Description copied from interface: AssociateDescription

Sets the list of source features. NOTE: A reference to the input list might be saved internally until the next call to this function.

Specified by:

setSource in interface AssociateDescription<D extends TupleDesc_F64>

Parameters:

listSrc - List of features

setDestination

public void setDestination(org.ddogleg.struct.FastQueue<D> listDst)

Description copied from interface: AssociateDescription

Sets the list of destination features NOTE: A reference to the input list might be saved internally until the next call to this function.

Specified by:

setDestination in interface AssociateDescription<D extends TupleDesc_F64>

Parameters:

listDst - List of features

associate

public void associate()

Description copied from interface: Associate

Finds the best match for each item in the source list with an item in the destination list.

Specified by:

associate in interface Associate

getMatches

public org.ddogleg.struct.FastQueue<AssociatedIndex> getMatches()

Description copied from interface: Associate

List of associated features. Indexes refer to the index inside the input lists.

Specified by:

getMatches in interface Associate

Returns:

List of associated features.

getUnassociatedSource

public org.ddogleg.struct.GrowQueue_I32 getUnassociatedSource()

Description copied from interface: Associate

Indexes of features in the source set which are not associated. WARNING: In some implementations the unassociated list is recomputed each time this function is invoked. In other implementations it was found virtually for free while the matches are found.

Specified by:

getUnassociatedSource in interface Associate

Returns:

List of unassociated source features by index.

getUnassociatedDestination

public org.ddogleg.struct.GrowQueue_I32 getUnassociatedDestination()

Description copied from interface: Associate

Indexes of features in the destination set which are not associated. WARNING: In some implementations the unassociated list is recomputed each time this function is invoked. In other implementations it was found virtually for free while the matches are found.

Specified by:

getUnassociatedDestination in interface Associate

Returns:

List of unassociated destination features by index.

setThreshold

public void setThreshold(double score)

Description copied from interface: Associate

Associations are only considered if their score is less than the specified threshold. To remove any threshold test set this value to Double.MAX_VALUE

Specified by:

setThreshold in interface Associate

Parameters:

score - The threshold.

getScoreType

public MatchScoreType getScoreType()

Description copied from interface: Associate

Specifies the type of score which is returned.

Specified by:

getScoreType in interface Associate

Returns:

Type of association score.

uniqueSource

public boolean uniqueSource()

Description copied from interface: Associate

If at most one match is returned for each source feature.

Specified by:

uniqueSource in interface Associate

Returns:

true for unique source association

uniqueDestination

public boolean uniqueDestination()

Description copied from interface: Associate

If at most one match is returned for each destination feature.

Specified by:

uniqueDestination in interface Associate

Returns:

true for unique destination association