org.openimaj.ml.clustering.kdtree

Class KDTreeClusters

java.lang.Object

org.openimaj.ml.clustering.IndexClusters

org.openimaj.ml.clustering.kdtree.KDTreeClusters

All Implemented Interfaces:

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

public class KDTreeClusters
extends IndexClusters
implements SpatialClusters<double[]>

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Field Summary

Fields inherited from class org.openimaj.ml.clustering.IndexClusters

clusters, nEntries

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

CLUSTER_HEADER

Constructor Summary

Constructors

Constructor and Description
KDTreeClusters(DoubleKDTree tree, int dims)

Method Summary

Methods

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
HardAssigner<double[],?,?>	defaultHardAssigner() Get the default hard assigner for this clusterer.
int	numClusters() Get the number of clusters.
int	numDimensions() Get the data dimensionality
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
void	writeASCII(PrintWriter out) Write the content of this as ascii to out.
void	writeBinary(DataOutput out) Write the content of this as binary to out.

Methods inherited from class org.openimaj.ml.clustering.IndexClusters

clusters, numEntries, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

KDTreeClusters

public KDTreeClusters(DoubleKDTree tree,
              int dims)

Parameters:

tree - the KDTree which represents the clusters

dims -

Method Detail

numDimensions

public int numDimensions()

Description copied from interface: SpatialClusters

Get the data dimensionality

Specified by:

numDimensions in interface SpatialClusters<double[]>

Returns:

the data dimensionality.

numClusters

public int numClusters()

Description copied from class: IndexClusters

Get the number of clusters.

Specified by:

numClusters in interface SpatialClusters<double[]>

Overrides:

numClusters in class IndexClusters

Returns:

number of clusters.

defaultHardAssigner

public HardAssigner<double[],?,?> 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<double[]>

Returns:

a hard assigner.

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Overrides:

readASCII in class IndexClusters

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

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

Overrides:

asciiHeader in class IndexClusters

Returns:

header

readBinary

public void readBinary(DataInput in)
                throws IOException

Description copied from interface: ReadableBinary

Read internal state from in.

Specified by:

readBinary in interface ReadableBinary

Overrides:

readBinary in class IndexClusters

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

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

Overrides:

binaryHeader in class IndexClusters

Returns:

header

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Description copied from interface: WriteableASCII

Write the content of this as ascii to out.

Specified by:

writeASCII in interface WriteableASCII

Overrides:

writeASCII in class IndexClusters

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Description copied from interface: WriteableBinary

Write the content of this as binary to out.

Specified by:

writeBinary in interface WriteableBinary

Overrides:

writeBinary in class IndexClusters

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out