net.sf.ij_plugins.clustering

Class KMeansConfig

java.lang.Object

net.sf.ij_plugins.clustering.KMeansConfig

All Implemented Interfaces:

java.lang.Cloneable

public final class KMeansConfig
extends java.lang.Object
implements java.lang.Cloneable

Configurable parameters of the k-means algorithm.

Constructor Summary

Constructors

Constructor and Description
KMeansConfig()

Method Summary

Methods

Modifier and Type	Method and Description
KMeansConfig	duplicate() Make duplicate of this object.
int	getNumberOfClusters()
int	getRandomizationSeed()
double	getTolerance() Return tolerance used to determine cluster centroid distance.
boolean	isClusterAnimationEnabled() Return true if when an animation illustrating cluster optimization is enabled.
boolean	isPrintTraceEnabled() Return true if a trace is printed to the ImageJ's Result window.
boolean	isRandomizationSeedEnabled() If true, random number generator will be initialized with a randomizationSeed.
void	setClusterAnimationEnabled(boolean clusterAnimationEnabled)
void	setNumberOfClusters(int numberOfClusters)
void	setPrintTraceEnabled(boolean printTraceEnabled)
void	setRandomizationSeed(int randomizationSeed)
void	setRandomizationSeedEnabled(boolean randomizationSeedEnabled)
void	setTolerance(float tolerance)

Methods inherited from class java.lang.Object

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

Constructor Detail

KMeansConfig

public KMeansConfig()

Method Detail

getRandomizationSeed

public int getRandomizationSeed()

setRandomizationSeed

public void setRandomizationSeed(int randomizationSeed)

isRandomizationSeedEnabled

public boolean isRandomizationSeedEnabled()

If true, random number generator will be initialized with a randomizationSeed. If false random number generator will be initialized using 'current' time.

Returns:

true when randomization seed is enabled.

See Also:

getRandomizationSeed()

setRandomizationSeedEnabled

public void setRandomizationSeedEnabled(boolean randomizationSeedEnabled)

getNumberOfClusters

public int getNumberOfClusters()

setNumberOfClusters

public void setNumberOfClusters(int numberOfClusters)

getTolerance

public double getTolerance()

Return tolerance used to determine cluster centroid distance. This tolerance is used to determine if a centroid changed location between iterations.

Returns:

cluster centroid location tolerance.

setTolerance

public void setTolerance(float tolerance)

isClusterAnimationEnabled

public boolean isClusterAnimationEnabled()

Return true if when an animation illustrating cluster optimization is enabled.

Returns:

true when cluster animation is enabled.

setClusterAnimationEnabled

public void setClusterAnimationEnabled(boolean clusterAnimationEnabled)

isPrintTraceEnabled

public boolean isPrintTraceEnabled()

Return true if a trace is printed to the ImageJ's Result window.

Returns:

true when printing of trace is enabled.

setPrintTraceEnabled

public void setPrintTraceEnabled(boolean printTraceEnabled)

duplicate

public KMeansConfig duplicate()

Make duplicate of this object. This a convenience wrapper for Object.clone() method.

Returns:

duplicate of this object.