org.openimaj.ml.clustering.assignment.soft

Class HierarchicalShortPathAssigner

java.lang.Object

org.openimaj.ml.clustering.assignment.soft.HierarchicalShortPathAssigner

All Implemented Interfaces:

Assigner<short[]>, SoftAssigner<short[],float[]>

public class HierarchicalShortPathAssigner
extends Object
implements SoftAssigner<short[],float[]>

A SoftAssigner for gathering the clusters assigned to a point from a hierarchical clustering. The returned clusters represent the path down the tree to the final closest leaf node.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<CentroidsProvider<short[]>,HardAssigner<short[],float[],IntFloatPair>>	assigners
protected HierarchicalShortKMeansResult	result

Constructor Summary

Constructors

Constructor and Description
HierarchicalShortPathAssigner(HierarchicalShortKMeansResult result) Construct with the given HierarchicalShortKMeansResult instance.

Method Summary

Modifier and Type	Method and Description
int[]	assign(short[] data) Assign a single point to some clusters.
int[][]	assign(short[][] data) Assign data to clusters.
IndependentPair<int[],float[]>	assignWeighted(short[] data) Assign a single point to some clusters.
void	assignWeighted(short[][] data, int[][] assignments, float[][] weights) Assign data to clusters.
int	numDimensions() Get the number of dimensions of the input vectors.
int	size() The number of clusters.

Methods inherited from class java.lang.Object

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

Field Detail

result

protected HierarchicalShortKMeansResult result

assigners

protected Map<CentroidsProvider<short[]>,HardAssigner<short[],float[],IntFloatPair>> assigners

Constructor Detail

HierarchicalShortPathAssigner

public HierarchicalShortPathAssigner(HierarchicalShortKMeansResult result)

Construct with the given HierarchicalShortKMeansResult instance.

Parameters:

result - the HierarchicalShortKMeansResult instance.

Method Detail

assign

public int[][] assign(short[][] data)

Description copied from interface: SoftAssigner

Assign data to clusters.

Specified by:

assign in interface SoftAssigner<short[],float[]>

Parameters:

data - the data.

Returns:

The cluster indices which the data was assigned to.

assign

public int[] assign(short[] data)

Description copied from interface: SoftAssigner

Assign a single point to some clusters.

Specified by:

assign in interface SoftAssigner<short[],float[]>

Parameters:

data - datum to assign.

Returns:

the assigned cluster indices.

assignWeighted

public void assignWeighted(short[][] data,
                           int[][] assignments,
                           float[][] weights)

Description copied from interface: SoftAssigner

Assign data to clusters. The results are returned in the indices and distances arrays. The return arrays must have the same length as the data array.

Specified by:

assignWeighted in interface SoftAssigner<short[],float[]>

Parameters:

data - the data.

assignments - the cluster indices for each data point.

weights - the weights to the for each cluster for each data point.

assignWeighted

public IndependentPair<int[],float[]> assignWeighted(short[] data)

Description copied from interface: SoftAssigner

Assign a single point to some clusters.

Specified by:

assignWeighted in interface SoftAssigner<short[],float[]>

Parameters:

data - point to assign.

Returns:

the assigned cluster indices and weights.

numDimensions

public int numDimensions()

Description copied from interface: Assigner

Get the number of dimensions of the input vectors.

Specified by:

numDimensions in interface Assigner<short[]>

Returns:

the number of dimensions

size

public int size()

Description copied from interface: SoftAssigner

The number of clusters.

Specified by:

size in interface SoftAssigner<short[],float[]>

Returns:

The number of clusters or unique ids that can be generated.