Package org.ddogleg.fitting.modelset.distance

Enum Class StatisticalDistance

java.lang.Object

java.lang.Enum<StatisticalDistance>

org.ddogleg.fitting.modelset.distance.StatisticalDistance

All Implemented Interfaces:

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

public enum StatisticalDistance
extends Enum<StatisticalDistance>

Statistic used by StatisticalDistanceModelMatcher.

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
MEAN	Mean metric is used to evaluate goodness.
PERCENTILE	Median is used to evaluate goodness.

Method Summary

Modifier and Type	Method	Description
static StatisticalDistance	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StatisticalDistance[]	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

MEAN

public static final StatisticalDistance MEAN

Mean metric is used to evaluate goodness. Threshold is in standard deviations. 2

PERCENTILE

public static final StatisticalDistance PERCENTILE

Median is used to evaluate goodness. Threshold is fraction of points saved. 0.95

Method Details

values

public static StatisticalDistance[] 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 StatisticalDistance 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