org.openimaj.ml.clustering.kmeans

Class HierarchicalFloatKMeans

java.lang.Object

org.openimaj.ml.clustering.kmeans.HierarchicalFloatKMeans

All Implemented Interfaces:

Clusterer<float[][]>, SpatialClusterer<HierarchicalFloatKMeansResult,float[]>

@Reference(type=Inproceedings,
           author={"David. Nist\'er","Henrik. Stew\'enius"},
           title="Scalable Recognition with a Vocabulary Tree",
           year="2006",
           booktitle="CVPR",
           pages={"2161","","2168"},
           customData={"Date-Added","2010-11-12 09:33:18 +0000","Date-Modified","2010-11-22 15:11:22 +0000"})
public class HierarchicalFloatKMeans
extends Object
implements SpatialClusterer<HierarchicalFloatKMeansResult,float[]>

Hierarchical Float K-Means clustering (HierarchicalFloatKMeans) is a simple hierarchical version of FloatKMeans. The algorithm recursively applies

Author:

Sina Samangooei (ss@ecs.soton.ac.uk), Jonathon Hare (jsh2@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
HierarchicalFloatKMeans(int M, int K, int depth) Construct a new HierarchicalFloatKMeans with the given parameters.
HierarchicalFloatKMeans(KMeansConfiguration<FloatNearestNeighbours,float[]> config, int M, int K, int depth) Construct a new HierarchicalFloatKMeans with the given parameters.

Method Summary

Modifier and Type	Method and Description
HierarchicalFloatKMeansResult	cluster(DataSource<float[]> data) Perform clustering with data from a data source.
HierarchicalFloatKMeansResult	cluster(float[][] data) Perform clustering on the given data.
int[][]	performClustering(float[][] data)

Methods inherited from class java.lang.Object

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

Constructor Detail

HierarchicalFloatKMeans

public HierarchicalFloatKMeans(KMeansConfiguration<FloatNearestNeighbours,float[]> config,
                               int M,
                               int K,
                               int depth)

Construct a new HierarchicalFloatKMeans with the given parameters.

Parameters:

config - configuration for the underlying kmeans clustering.

M - Data dimensionality.

K - Number of clusters per node.

depth - Tree depth.

HierarchicalFloatKMeans

public HierarchicalFloatKMeans(int M,
                               int K,
                               int depth)

Construct a new HierarchicalFloatKMeans with the given parameters. Uses the default parameters of the KMeansConfiguration.

Parameters:

M - Data dimensionality.

K - Number of clusters per node.

depth - Tree depth.

Method Detail

cluster

public HierarchicalFloatKMeansResult cluster(float[][] data)

Description copied from interface: SpatialClusterer

Perform clustering on the given data.

Specified by:

cluster in interface SpatialClusterer<HierarchicalFloatKMeansResult,float[]>

Parameters:

data - the data.

Returns:

the generated clusters.

performClustering

public int[][] performClustering(float[][] data)

Specified by:

performClustering in interface Clusterer<float[][]>

Returns:

Given data items, cluster them by index

cluster

public HierarchicalFloatKMeansResult cluster(DataSource<float[]> data)

Description copied from interface: SpatialClusterer

Perform clustering with data from a data source. The DataSource could potentially be backed by disk rather in memory.

Specified by:

cluster in interface SpatialClusterer<HierarchicalFloatKMeansResult,float[]>

Parameters:

data - the data.

Returns:

the generated clusters.