org.openimaj.tools.globalfeature

Enum FeatureComparison

java.lang.Object

java.lang.Enum<FeatureComparison>

org.openimaj.tools.globalfeature.FeatureComparison

All Implemented Interfaces:

Serializable, Comparable<FeatureComparison>

public enum FeatureComparison
extends Enum<FeatureComparison>

Feature similarity/distance measures

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BHATTACHARYYA Bhattacharya distance
CHI_SQUARE Chi-squared distance
CORRELATION Pearson correlation
EQUALS Equality (every element is equal)
EUCLIDEAN Euclidean distance
INTERSECTION Histogram intersection

Method Summary

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

EUCLIDEAN

public static final FeatureComparison EUCLIDEAN

Euclidean distance

CORRELATION

public static final FeatureComparison CORRELATION

Pearson correlation

CHI_SQUARE

public static final FeatureComparison CHI_SQUARE

Chi-squared distance

INTERSECTION

public static final FeatureComparison INTERSECTION

Histogram intersection

BHATTACHARYYA

public static final FeatureComparison BHATTACHARYYA

Bhattacharya distance

EQUALS

public static final FeatureComparison EQUALS

Equality (every element is equal)

Method Detail

values

public static FeatureComparison[] 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 (FeatureComparison c : FeatureComparison.values())
    System.out.println(c);

Returns:

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

valueOf

public static FeatureComparison valueOf(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:

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

NullPointerException - if the argument is null