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, 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()
byte[]	binaryHeader()
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)
void	readBinary(DataInput in)
String	toString()
void	writeASCII(PrintWriter out)
void	writeBinary(DataOutput 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

Specified by:

readASCII in interface ReadableASCII

Throws:

IOException

asciiHeader

public String asciiHeader()

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

readBinary

public void readBinary(DataInput in)
                throws IOException

Specified by:

readBinary in interface ReadableBinary

Throws:

IOException

binaryHeader

public byte[] binaryHeader()

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

writeASCII

public void writeASCII(PrintWriter out)
                throws IOException

Specified by:

writeASCII in interface WriteableASCII

Throws:

IOException

writeBinary

public void writeBinary(DataOutput out)
                 throws IOException

Specified by:

writeBinary in interface WriteableBinary

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object