Package adams.flow.transformer.wekaclusterer

Class AddCluster

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.wekaclusterer.AbstractClustererPostProcessor

adams.flow.transformer.wekaclusterer.AbstractClusterMembershipPostProcessor

adams.flow.transformer.wekaclusterer.AddCluster

All Implemented Interfaces:

AdditionalInformationHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class AddCluster
extends AbstractClusterMembershipPostProcessor

Just adds the predicted cluster (or distribution) to the original dataset.
Stored in container under: Clustered dataset

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-output-distribution <boolean> (property: outputDistribution)
    If enabled, the cluster distribution is output instead of the cluster index.
    default: false
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_OutputDistribution	output distribution instead of cluster index.
static String	PREDICTED_CLUSTER
static String	PREDICTED_DISTRIBUTION

Fields inherited from class adams.flow.transformer.wekaclusterer.AbstractClusterMembershipPostProcessor

VALUE_CLUSTERED_DATASET

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
AddCluster()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getOutputDistribution()	Returns whether to output the cluster distribution instead of the cluster index.
String	globalInfo()	Returns a string describing the object.
String	outputDistributionTipText()	Returns the tip text for this property.
protected weka.core.Instances	processDatasetWithClusterer(weka.core.Instances data, weka.clusterers.Clusterer clusterer)	Performs some form of processing on the full dataset.
void	setOutputDistribution(boolean value)	Sets whether to output the cluster distribution instead of the cluster index.

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

check, doPostProcess, getContainerKeys

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

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

PREDICTED_CLUSTER

public static final String PREDICTED_CLUSTER

See Also:

Constant Field Values

PREDICTED_DISTRIBUTION

public static final String PREDICTED_DISTRIBUTION

See Also:

Constant Field Values

m_OutputDistribution

protected boolean m_OutputDistribution

output distribution instead of cluster index.

Constructor Detail

AddCluster

public AddCluster()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setOutputDistribution

public void setOutputDistribution(boolean value)

Sets whether to output the cluster distribution instead of the cluster index.

Parameters:

value - true if to output distribution

getOutputDistribution

public boolean getOutputDistribution()

Returns whether to output the cluster distribution instead of the cluster index.

Returns:

true if to output distribution

outputDistributionTipText

public String outputDistributionTipText()

Returns the tip text for this property.

Returns:

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

processDatasetWithClusterer

protected weka.core.Instances processDatasetWithClusterer(weka.core.Instances data,
                                                          weka.clusterers.Clusterer clusterer)

Performs some form of processing on the full dataset.

Specified by:

processDatasetWithClusterer in class AbstractClusterMembershipPostProcessor