org.openimaj.ml.clustering

Class IndexClusters

java.lang.Object

org.openimaj.ml.clustering.IndexClusters

All Implemented Interfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Clusters

Direct Known Subclasses:

DBSCANClusters, KDTreeClusters, SpectralIndexedClusters

public class IndexClusters
extends Object
implements Clusters

Class to describe objects that are the result of the clustering where the training data is implicitly clustered

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected int[][]	clusters
protected int	nEntries

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

CLUSTER_HEADER

Constructor Summary

Constructors

Constructor and Description
IndexClusters() Used only to initailise for IOUtils
IndexClusters(int[] assignments)
IndexClusters(int[][] clusters)
IndexClusters(int[][] clusters, int nEntries)
IndexClusters(List<int[]> completedClusters)

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
int[][]	clusters() Get the number of clusters.
int	numClusters() Get the number of clusters.
int	numEntries() Get the number of data entries
void	readASCII(Scanner in) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
String	toString()
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 java.lang.Object

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

Field Detail

clusters

protected int[][] clusters

nEntries

protected int nEntries

Constructor Detail

IndexClusters

public IndexClusters()

Used only to initailise for IOUtils

IndexClusters

public IndexClusters(int[][] clusters,
                     int nEntries)

Parameters:

clusters - the clusters

nEntries - the number of entries

IndexClusters

public IndexClusters(int[][] clusters)

Parameters:

clusters - the clusters

IndexClusters

public IndexClusters(int[] assignments)

Parameters:

assignments - convert a list of cluster assignments to a 2D array to cluster to assignments

IndexClusters

public IndexClusters(List<int[]> completedClusters)

Parameters:

completedClusters -

Method Detail

clusters

public int[][] clusters()

Get the number of clusters.

Returns:

number of clusters.

numEntries

public int numEntries()

Get the number of data entries

Returns:

the number of data entries.

numClusters

public int numClusters()

Get the number of clusters.

Returns:

number of clusters.

readASCII

public void readASCII(Scanner in)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

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

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

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

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

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

Parameters:

out - sink to write to

Throws:

IOException - an error writing to out

toString

public String toString()

Overrides:

toString in class Object