Package adams.flow.transformer.wekaclusterer

Class AverageSilhouetteCoefficient

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.wekaclusterer.AbstractClustererPostProcessor

adams.flow.transformer.wekaclusterer.AverageSilhouetteCoefficient

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.core.TechnicalInformationHandler, Serializable

public class AverageSilhouetteCoefficient
extends AbstractClustererPostProcessor
implements adams.core.TechnicalInformationHandler

Computes the average Silhouette coefficient for the clusters.

Author:

FracPete (fracpete at waikato dot ac dot nz), Eibe Frank (original Groovy code on Weka mailing list)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected weka.core.DistanceFunction	m_DistanceFunction	the distance function to use.
static String	VALUE_AVERAGE_SILHOUETTE_COEFFICIENT	the key in the container.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AverageSilhouetteCoefficient()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	distanceFunctionTipText()	Returns the tip text for this property.
protected WekaModelContainer	doPostProcess(WekaModelContainer cont)	Performs the actual post-processing.
protected String[]	getContainerKeys()	Returns the keys that the processor adds/modifies.
weka.core.DistanceFunction	getDistanceFunction()	Returns the distance function to use.
adams.core.TechnicalInformation	getTechnicalInformation()	Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.
String	globalInfo()	Returns a string describing the object.
void	setDistanceFunction(weka.core.DistanceFunction value)	Sets the distance function to use.

Methods inherited from class adams.flow.transformer.wekaclusterer.AbstractClustererPostProcessor

check, getAdditionalInformation, postProcess

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

VALUE_AVERAGE_SILHOUETTE_COEFFICIENT

public static final String VALUE_AVERAGE_SILHOUETTE_COEFFICIENT

the key in the container.

See Also:

Constant Field Values

m_DistanceFunction

protected weka.core.DistanceFunction m_DistanceFunction

the distance function to use.

Constructor Detail

AverageSilhouetteCoefficient

public AverageSilhouetteCoefficient()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

getTechnicalInformation

public adams.core.TechnicalInformation getTechnicalInformation()

Returns an instance of a TechnicalInformation object, containing detailed information about the technical background of this class, e.g., paper reference or book this class is based on.

Specified by:

getTechnicalInformation in interface adams.core.TechnicalInformationHandler

Returns:

the technical information about this class

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setDistanceFunction

public void setDistanceFunction(weka.core.DistanceFunction value)

Sets the distance function to use.

Parameters:

value - the function

getDistanceFunction

public weka.core.DistanceFunction getDistanceFunction()

Returns the distance function to use.

Returns:

the function

distanceFunctionTipText

public String distanceFunctionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getContainerKeys

protected String[] getContainerKeys()

Returns the keys that the processor adds/modifies.

Specified by:

getContainerKeys in class AbstractClustererPostProcessor

Returns:

the keys, null of zero-length array for none

doPostProcess

protected WekaModelContainer doPostProcess(WekaModelContainer cont)

Performs the actual post-processing.

Specified by:

doPostProcess in class AbstractClustererPostProcessor

Parameters:

cont - the container to post-process

Returns:

the post-processed container