org.openimaj.ml.clustering

Class FeatureVectorCentroidsResult<T extends FeatureVector>

java.lang.Object

org.openimaj.ml.clustering.FeatureVectorCentroidsResult<T>

Type Parameters:

T - Type of features

All Implemented Interfaces:

Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, CentroidsProvider<T>, Clusters, SpatialClusters<T>

Direct Known Subclasses:

FeatureVectorKMeans.Result

public class FeatureVectorCentroidsResult<T extends FeatureVector>
extends Object
implements SpatialClusters<T>, CentroidsProvider<T>

The result of a SpatialClusterer that just produces a flat set of centroids in the form of FeatureVectors.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
T[]	centroids The centroids of the clusters

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

CLUSTER_HEADER

Constructor Summary

Constructors

Constructor and Description
FeatureVectorCentroidsResult()

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
byte[]	binaryHeader() Header for binary input.
HardAssigner<T,float[],IntFloatPair>	defaultHardAssigner() Get the default hard assigner for this clusterer.
boolean	equals(Object obj)
T[]	getCentroids()
int	numClusters() Get the number of clusters.
int	numDimensions() Get the data dimensionality
void	readASCII(Scanner br) Read internal state from in.
void	readBinary(DataInput in) Read internal state from in.
String	toString()
void	writeASCII(PrintWriter writer) 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

centroids

public T extends FeatureVector[] centroids

The centroids of the clusters

Constructor Detail

FeatureVectorCentroidsResult

public FeatureVectorCentroidsResult()

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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 br)
               throws IOException

Description copied from interface: ReadableASCII

Read internal state from in.

Specified by:

readASCII in interface ReadableASCII

Parameters:

br - source to read from.

Throws:

IOException - an error reading input

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

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 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

getCentroids

public T[] getCentroids()

Specified by:

getCentroids in interface CentroidsProvider<T extends FeatureVector>

Returns:

the centroids generated by the clustering

defaultHardAssigner

public HardAssigner<T,float[],IntFloatPair> 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<T extends FeatureVector>

Returns:

a hard assigner.

numDimensions

public int numDimensions()

Description copied from interface: SpatialClusters

Get the data dimensionality

Specified by:

numDimensions in interface SpatialClusters<T extends FeatureVector>

Returns:

the data dimensionality.

numClusters

public int numClusters()

Description copied from interface: SpatialClusters

Get the number of clusters.

Specified by:

numClusters in interface SpatialClusters<T extends FeatureVector>

Returns:

number of clusters.