boofcv.struct.feature

Class MatchScoreType

java.lang.Object

boofcv.struct.feature.MatchScoreType

public abstract class MatchScoreType
extends Object

Specifies the meaning of a match score.

Author:

Peter Abeles

Field Summary

Fields

Modifier and Type	Field and Description
static MatchScoreType	CORRELATION Correlation scores can be both positive and negative values.
static MatchScoreType	NORM_ERROR These error metrics have values greater than or equal to zero.

Constructor Summary

Constructors

Constructor and Description
MatchScoreType()

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	compareTo(double scoreA, double scoreB) Used to test to see which score is better than another score.
abstract boolean	isZeroBest() True if the best possible score has a value of zero

Methods inherited from class java.lang.Object

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

Field Detail

CORRELATION

public static MatchScoreType CORRELATION

Correlation scores can be both positive and negative values. Scores with a larger positive value are considered to be better.

NORM_ERROR

public static MatchScoreType NORM_ERROR

These error metrics have values greater than or equal to zero. Closer the error is to zero the better the match is considered.

Constructor Detail

MatchScoreType

public MatchScoreType()

Method Detail

isZeroBest

public abstract boolean isZeroBest()

True if the best possible score has a value of zero

Returns:

True if the best possible score has a value of zero

compareTo

public abstract int compareTo(double scoreA,
            double scoreB)

Used to test to see which score is better than another score.

1 if scoreA better than scoreB
0 if scoreA == scoreB
-1 if scoreA worse than scoreB

Parameters:

scoreA - match score

scoreB - match score

Returns:

Returns a value of (-1,0,1) which indicates which score is better.