org.openimaj.ml.clustering

Class FeatureVectorCentroidsResult<T extends org.openimaj.feature.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 org.openimaj.feature.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()
byte[]	binaryHeader()
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)
void	readBinary(DataInput in)
String	toString()
void	writeASCII(PrintWriter writer)
void	writeBinary(DataOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

centroids

public T extends org.openimaj.feature.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()

Specified by:

asciiHeader in interface ReadableASCII

Specified by:

asciiHeader in interface WriteableASCII

binaryHeader

public byte[] binaryHeader()

Specified by:

binaryHeader in interface ReadableBinary

Specified by:

binaryHeader in interface WriteableBinary

readASCII

public void readASCII(Scanner br)
               throws IOException

Specified by:

readASCII in interface ReadableASCII

Throws:

IOException

readBinary

public void readBinary(DataInput in)
                throws IOException

Specified by:

readBinary in interface ReadableBinary

Throws:

IOException

writeASCII

public void writeASCII(PrintWriter writer)
                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

getCentroids

public T[] getCentroids()

Specified by:

getCentroids in interface CentroidsProvider<T extends org.openimaj.feature.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 org.openimaj.feature.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 org.openimaj.feature.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 org.openimaj.feature.FeatureVector>

Returns:

number of clusters.