org.openimaj.tools.clusterquantiser

Enum ClusterType

java.lang.Object

java.lang.Enum<ClusterType>

org.openimaj.tools.clusterquantiser.ClusterType

All Implemented Interfaces:

Serializable, Comparable<ClusterType>, CmdLineOptionsProvider

public enum ClusterType
extends Enum<ClusterType>
implements CmdLineOptionsProvider

Different clustering algorithms

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterType.ClusterTypeOp Options for each ClusterType.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FASTKMEANS Fast (possibly approximate) K-Means
FASTMBKMEANS Fast (possibly approximate) batched K-Means
HKMEANS Hierarchical K-Means
RANDOM Randomly sampled centroids (with replacement; the same centroid might be picked multiple times)
RANDOMSET Randomly sampled centroids (without replacement; a centroid can only be picked once)
RFOREST Random forest

Method Summary

Modifier and Type	Method and Description
static ClusterType.ClusterTypeOp	sniffClusterType(BufferedInputStream oldout) Guess the type of the clusters based on the file header
static ClusterType.ClusterTypeOp	sniffClusterType(File oldout) Guess the type of the clusters based on the file header
static ClusterType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClusterType[]	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

Methods inherited from interface org.kohsuke.args4j.CmdLineOptionsProvider

getOptions

Enum Constant Detail

RANDOM

public static final ClusterType RANDOM

Randomly sampled centroids (with replacement; the same centroid might be picked multiple times)

RANDOMSET

public static final ClusterType RANDOMSET

Randomly sampled centroids (without replacement; a centroid can only be picked once)

FASTMBKMEANS

public static final ClusterType FASTMBKMEANS

Fast (possibly approximate) batched K-Means

FASTKMEANS

public static final ClusterType FASTKMEANS

Fast (possibly approximate) K-Means

HKMEANS

public static final ClusterType HKMEANS

Hierarchical K-Means

RFOREST

public static final ClusterType RFOREST

Random forest

Method Detail

values

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

Returns:

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

valueOf

public static ClusterType 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

sniffClusterType

public static ClusterType.ClusterTypeOp sniffClusterType(File oldout)

Guess the type of the clusters based on the file header

Parameters:

oldout -

Returns:

guessed type

sniffClusterType

public static ClusterType.ClusterTypeOp sniffClusterType(BufferedInputStream oldout)

Guess the type of the clusters based on the file header

Parameters:

oldout -

Returns:

guessed type