org.openimaj.ml.clustering.kmeans

Class HierarchicalByteKMeansResult

java.lang.Object

org.openimaj.ml.clustering.kmeans.HierarchicalByteKMeansResult

All Implemented Interfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Clusters, SpatialClusters<byte[]>

public class HierarchicalByteKMeansResult
extends Object
implements SpatialClusters<byte[]>

The result of a HierarchicalByteKMeans clustering operation.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HierarchicalByteKMeansResult.Node HierarchicalByteKMeans tree node The number of children is not bigger than the HierarchicalByteKMeans K parameter

Field Summary

Fields inherited from interface org.openimaj.ml.clustering.Clusters

CLUSTER_HEADER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HierarchicalByteKMeansResult()

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
int	countActiveLeafNodes() Count number of active leaf nodes.
int	countLeafs() Total number of leaves assuming leaves = K^depth
HierarchicalByteHardAssigner	defaultHardAssigner() Get the default hard assigner for this clusterer.
boolean	equals(Object o)
byte[]	getClusterCentroid(int[] path) Given a path, get the cluster centroid associated with the cluster index of the path.
int	getDepth() Get the depth of the cluster tree
int	getIndex(int[] path) Translates a path down the KDTree as a cluster index.
static int	getIndex(int[] path, int depth, int K) Translates a path down the KDTree as a cluster index.
int	getK() Get the number of clusters per node
int[]	getPath(int index) Given an index, what was the path down the hierarchy that lead to it.
static int[]	getPath(int index, int depth, int K) Given an index, what was the path down the hierarchy that lead to it.
HierarchicalByteKMeansResult.Node	getRoot() Get the root node of the tree
int	numClusters() Get the number of clusters.
int	numDimensions() Get the data dimensionality
void	readASCII(Scanner reader) Read internal state from in.
void	readBinary(DataInput dis) Read internal state from in.
String	toString()
void	writeASCII(PrintWriter writer) Write the content of this as ascii to out.
void	writeBinary(DataOutput dos) Write the content of this as binary to out.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HierarchicalByteKMeansResult

protected HierarchicalByteKMeansResult()

Method Detail

numDimensions

public int numDimensions()

Description copied from interface: SpatialClusters

Get the data dimensionality

Specified by:

numDimensions in interface SpatialClusters<byte[]>

Returns:

the data dimensionality.

getK

public int getK()

Get the number of clusters per node

Returns:

number of clusters per node

getDepth

public int getDepth()

Get the depth of the cluster tree

Returns:

the depth of the cluster tree

getRoot

public HierarchicalByteKMeansResult.Node getRoot()

Get the root node of the tree

Returns:

the root node of the tree

getIndex

public static int getIndex(int[] path,
                           int depth,
                           int K)

Translates a path down the KDTree as a cluster index. This allows the specification of K and the depth

Parameters:

path -

depth -

K -

Returns:

cluster index

getIndex

public int getIndex(int[] path)

Translates a path down the KDTree as a cluster index.

Parameters:

path -

Returns:

cluster index

getPath

public static int[] getPath(int index,
                            int depth,
                            int K)

Given an index, what was the path down the hierarchy that lead to it. Allows the specification of depth and number of clusters.

Parameters:

index -

depth -

K -

Returns:

a hierarchy path

getPath

public int[] getPath(int index)

Given an index, what was the path down the hierarchy that lead to it. Assumes the class depth and K.

Parameters:

index -

Returns:

a hierarchy path

countActiveLeafNodes

public int countActiveLeafNodes()

Count number of active leaf nodes.

Returns:

number of nodes.

toString

public String toString()

Overrides:

toString in class Object

countLeafs

public int countLeafs()

Total number of leaves assuming leaves = K^depth

Returns:

number of leaves

numClusters

public int numClusters()

Description copied from interface: SpatialClusters

Get the number of clusters.

Specified by:

numClusters in interface SpatialClusters<byte[]>

Returns:

number of clusters.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getClusterCentroid

public byte[] getClusterCentroid(int[] path)

Given a path, get the cluster centroid associated with the cluster index of the path.

Parameters:

path -

Returns:

the centroid of a given path

asciiHeader

public String asciiHeader()

Description copied from interface: ReadableASCII

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

Returns:

header

binaryHeader

public byte[] binaryHeader()

Description copied from interface: ReadableBinary

Header for binary input. Will be automatically read by IOUtils when using readBinary().

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

Returns:

header

readASCII

public void readASCII(Scanner reader)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

reader - source to read from.

Throws:

IOException - an error reading input

readBinary

public void readBinary(DataInput dis)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Parameters:

dis - source to read from.

Throws:

IOException - an error reading input

writeASCII

public void writeASCII(PrintWriter writer)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Parameters:

writer - sink to write to

Throws:

IOException - an error writing to out

writeBinary

public void writeBinary(DataOutput dos)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Parameters:

dos - sink to write to

Throws:

IOException - an error writing to out

defaultHardAssigner

public HierarchicalByteHardAssigner defaultHardAssigner()

Description copied from interface: SpatialClusters

Get the default hard assigner for this clusterer. This method is potentially expensive, so callers should only call it once, and hold on to the result (and reuse it).

Specified by:

defaultHardAssigner in interface SpatialClusters<byte[]>

Returns:

a hard assigner.