be.tarsos.util.histogram

Enum CorrelationMeasure

java.lang.Object

java.lang.Enum<CorrelationMeasure>

be.tarsos.util.histogram.CorrelationMeasure

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CorrelationMeasure>

public enum CorrelationMeasure
extends java.lang.Enum<CorrelationMeasure>

Defines a correlation measure for histograms. See On measuring the distance between histograms: Sung-Hyuk Chaa, Sargur N. Sriharib (2002) CorrelationMeasure is a bit of a strange name: also distance measures are defined. Side note: java enums are nice.

Author:

Joren Six

Enum Constant Summary

Enum Constants

Enum Constant and Description
BHATTACHARYA Another distance measure, with an impressive sounding name...
CITY_BLOCK Is a distance measure using city block distances.
CROSSCORRELATION Another correlation measure, seems to work also, TODO Write better description.
EUCLIDEAN A direct euclidean distance.
INTERSECTION The intersection computes the matching areas under the curve.

Method Summary

Modifier and Type	Method and Description
HistogramCorrelation	getHistogramCorrelation()
static CorrelationMeasure	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CorrelationMeasure[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CITY_BLOCK

public static final CorrelationMeasure CITY_BLOCK

Is a distance measure using city block distances.

EUCLIDEAN

public static final CorrelationMeasure EUCLIDEAN

A direct euclidean distance.

INTERSECTION

public static final CorrelationMeasure INTERSECTION

The intersection computes the matching areas under the curve. It is a symmetric correlation measure: 1.0 is perfect correlation, 0.0 means no correlation. Symmetric: f(a,b) = f(b,a)

BHATTACHARYA

public static final CorrelationMeasure BHATTACHARYA

Another distance measure, with an impressive sounding name... TODO Write better description

CROSSCORRELATION

public static final CorrelationMeasure CROSSCORRELATION

Another correlation measure, seems to work also, TODO Write better description.

Method Detail

values

public static CorrelationMeasure[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CorrelationMeasure c : CorrelationMeasure.values())
    System.out.println(c);

Returns:

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

valueOf

public static CorrelationMeasure valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getHistogramCorrelation

public HistogramCorrelation getHistogramCorrelation()

Returns:

the HistogramCorrelation instance used to caluculate the distance / correlation