org.openimaj.image.connectedcomponent.proc

Enum ColourDescriptor.ColourDescriptorType

java.lang.Object

java.lang.Enum<ColourDescriptor.ColourDescriptorType>

org.openimaj.image.connectedcomponent.proc.ColourDescriptor.ColourDescriptorType

All Implemented Interfaces:

Serializable, Comparable<ColourDescriptor.ColourDescriptorType>

Enclosing class:

ColourDescriptor

public static enum ColourDescriptor.ColourDescriptorType
extends Enum<ColourDescriptor.ColourDescriptorType>

The different types of statistic available. This provides a convenient way of getting a single statistic, as the ColourDescriptor computes them all.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
MEAN The mean colour.
MEDIAN The median colour.
MODE The modal colour.
RANGE The range of the colours in the image.
VARIANCE The variance of the colours in the image.

Method Summary

Methods

Modifier and Type	Method and Description
abstract DoubleFV	getFeatureVector(ColourDescriptor desc) Extract the feature for the given descriptor.
static ColourDescriptor.ColourDescriptorType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ColourDescriptor.ColourDescriptorType[]	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

MEAN

public static final ColourDescriptor.ColourDescriptorType MEAN

The mean colour.

MODE

public static final ColourDescriptor.ColourDescriptorType MODE

The modal colour.

MEDIAN

public static final ColourDescriptor.ColourDescriptorType MEDIAN

The median colour.

RANGE

public static final ColourDescriptor.ColourDescriptorType RANGE

The range of the colours in the image.

VARIANCE

public static final ColourDescriptor.ColourDescriptorType VARIANCE

The variance of the colours in the image.

Method Detail

values

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

Returns:

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

valueOf

public static ColourDescriptor.ColourDescriptorType 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

getFeatureVector

public abstract DoubleFV getFeatureVector(ColourDescriptor desc)

Extract the feature for the given descriptor.

Parameters:

desc - the descriptor to extract from

Returns:

the extracted feature.