Package boofcv.factory.disparity

Enum Class DisparityError

java.lang.Object

java.lang.Enum<DisparityError>

boofcv.factory.disparity.DisparityError

All Implemented Interfaces:

Serializable, Comparable<DisparityError>, java.lang.constant.Constable

public enum DisparityError
extends Enum<DisparityError>

Different disparity error functions that are available. Not all algorithm will support all errors

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CENSUS	Census.
NCC	Normalized Cross Correlation (NCC).
SAD	Sum of Absolute Difference (SAD).

Method Summary

Modifier and Type	Method	Description
boolean	isCorrelation()
boolean	isSquared()	If the error is distance squared or false if distance
static DisparityError	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DisparityError[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SAD

public static final DisparityError SAD

Sum of Absolute Difference (SAD). It's often recommended that an image derivative like Laplacian is applied first to add improved performance ot variable lighting between the two images.

CENSUS

public static final DisparityError CENSUS

Census. Can handle affine changes in lighting between the two images. There are many different possible sampling patterns.

See Also:

• CensusTransform

NCC

public static final DisparityError NCC

Normalized Cross Correlation (NCC). The NCC radius specifies the size of the local region used to compute normalization statistics.

Method Details

values

public static DisparityError[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static DisparityError valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isCorrelation

public boolean isCorrelation()

isSquared

public boolean isSquared()

If the error is distance squared or false if distance