boofcv.abst.feature.associate

Class EnforceUniqueByScore<A extends Associate>

java.lang.Object

boofcv.abst.feature.associate.EnforceUniqueByScore<A>

All Implemented Interfaces:

Associate

Direct Known Subclasses:

EnforceUniqueByScore.Describe, EnforceUniqueByScore.Describe2D

public class EnforceUniqueByScore<A extends Associate>
extends java.lang.Object
implements Associate

Ensures that the source and/or destination features are uniquely associated by resolving ambiguity using association score and preferring matches with better scores.

NOTE: Unassociated matches are recomputed from scratch. It could potentially add to the list created by the original algorithm for a bit more efficiency.

See Also:

AssociateUniqueByScoreAlg

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EnforceUniqueByScore.Describe<Desc> Implementation of EnforceUniqueByScore for AssociateDescription.
static class	EnforceUniqueByScore.Describe2D<Desc> Implementation of EnforceUniqueByScore for AssociateDescription2D.

Constructor Summary

Constructors

Constructor and Description
EnforceUniqueByScore(A association, boolean checkSource, boolean checkDestination) Configures the algorithm to ensure source and/or destination features are unique.

Method Summary

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.
FastQueue<AssociatedIndex>	getMatches() List of associated features.
MatchScoreType	getScoreType() Specifies the type of score which is returned.
GrowQueue_I32	getUnassociatedDestination() Indexes of features in the destination set which are not associated.
GrowQueue_I32	getUnassociatedSource() Indexes of features in the source set which are not associated.
void	setThreshold(double score) Associations are only considered if their score is less than or equal to 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

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

Constructor Detail

EnforceUniqueByScore

public EnforceUniqueByScore(A association,
                            boolean checkSource,
                            boolean checkDestination)

Configures the algorithm to ensure source and/or destination features are unique. The uniqueness of the input algorithm is checked and if it is already unique it that processing step will be skipped.

Parameters:

association - The association algorithm which is being wrapped

checkSource - Should source features be unique

checkDestination - Should destination features be unique

Method Detail

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 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 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 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 or equal to 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