moa.clusterers

Class AbstractClusterer

java.lang.Object

moa.AbstractMOAObject

moa.options.AbstractOptionHandler

moa.clusterers.AbstractClusterer

All Implemented Interfaces:

Serializable, Clusterer, AWTRenderable, MOAObject, OptionHandler

Direct Known Subclasses:

ClusterGenerator, Clustream, ClusTree, CobWeb, MyBaseOutlierDetector, StreamKM, WekaClusteringAlgorithm, WithDBSCAN, WithKmeans

public abstract class AbstractClusterer
extends AbstractOptionHandler
implements Clusterer

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Random	clustererRandom
protected Clustering	clustering
FlagOption	evaluateMicroClusteringOption
protected InstancesHeader	modelContext
protected int	randomSeed
protected IntOption	randomSeedOption
protected double	trainingWeightSeenByModel

Fields inherited from class moa.options.AbstractOptionHandler

classOptionNamesToPreparedObjects, options

Constructor Summary

Constructors

Constructor and Description
AbstractClusterer()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	contextIsCompatible(InstancesHeader originalContext, InstancesHeader newContext)
Clusterer	copy() This method produces a copy of this object.
String	getAttributeNameString(int attIndex)
AWTRenderer	getAWTRenderer()
String	getClassLabelString(int classLabelIndex)
String	getClassNameString()
void	getDescription(StringBuilder out, int indent) Returns a string representation of this object.
Clustering	getMicroClusteringResult()
InstancesHeader	getModelContext()
abstract void	getModelDescription(StringBuilder out, int indent)
Measurement[]	getModelMeasurements()
protected abstract Measurement[]	getModelMeasurementsImpl()
String	getNominalValueString(int attIndex, int valIndex)
String	getPurposeString() Gets the purpose of this object
Clusterer[]	getSubClusterers()
boolean	implementsMicroClusterer()
boolean	keepClassLabel()
protected static int	modelAttIndexToInstanceAttIndex(int index, weka.core.Instance inst)
protected static int	modelAttIndexToInstanceAttIndex(int index, weka.core.Instances insts)
void	prepareForUseImpl(TaskMonitor monitor, ObjectRepository repository) This method describes the implementation of how to prepare this object for use.
void	resetLearning()
abstract void	resetLearningImpl()
void	setModelContext(InstancesHeader ih)
void	setRandomSeed(int s)
boolean	trainingHasStarted()
double	trainingWeightSeenByModel()
void	trainOnInstance(weka.core.Instance inst)
abstract void	trainOnInstanceImpl(weka.core.Instance inst)

Methods inherited from class moa.options.AbstractOptionHandler

discoverOptionsViaReflection, getCLICreationString, getOptions, getPreparedClassOption, getPreparedClassOption, prepareClassOptions, prepareForUse, prepareForUse

Methods inherited from class moa.AbstractMOAObject

copy, measureByteSize, measureByteSize, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface moa.clusterers.Clusterer

getClusteringResult, getVotesForInstance, isRandomizable

Methods inherited from interface moa.options.OptionHandler

getCLICreationString, getOptions, prepareForUse, prepareForUse

Methods inherited from interface moa.MOAObject

measureByteSize

Field Detail

modelContext

protected InstancesHeader modelContext

trainingWeightSeenByModel

protected double trainingWeightSeenByModel

randomSeed

protected int randomSeed

randomSeedOption

protected IntOption randomSeedOption

evaluateMicroClusteringOption

public FlagOption evaluateMicroClusteringOption

clustererRandom

protected Random clustererRandom

clustering

protected Clustering clustering

Constructor Detail

AbstractClusterer

public AbstractClusterer()

Method Detail

getPurposeString

public String getPurposeString()

Description copied from interface: OptionHandler

Gets the purpose of this object

Specified by:

getPurposeString in interface OptionHandler

Overrides:

getPurposeString in class AbstractOptionHandler

Returns:

the string with the purpose of this object

prepareForUseImpl

public void prepareForUseImpl(TaskMonitor monitor,
                     ObjectRepository repository)

Description copied from class: AbstractOptionHandler

This method describes the implementation of how to prepare this object for use. All classes that extends this class have to implement prepareForUseImpl and not prepareForUse since prepareForUse calls prepareForUseImpl.

Specified by:

prepareForUseImpl in class AbstractOptionHandler

Parameters:

monitor - the TaskMonitor to use

repository - the ObjectRepository to use

setModelContext

public void setModelContext(InstancesHeader ih)

Specified by:

setModelContext in interface Clusterer

getModelContext

public InstancesHeader getModelContext()

Specified by:

getModelContext in interface Clusterer

setRandomSeed

public void setRandomSeed(int s)

Specified by:

setRandomSeed in interface Clusterer

trainingHasStarted

public boolean trainingHasStarted()

Specified by:

trainingHasStarted in interface Clusterer

trainingWeightSeenByModel

public double trainingWeightSeenByModel()

Specified by:

trainingWeightSeenByModel in interface Clusterer

resetLearning

public void resetLearning()

Specified by:

resetLearning in interface Clusterer

trainOnInstance

public void trainOnInstance(weka.core.Instance inst)

Specified by:

trainOnInstance in interface Clusterer

getModelMeasurements

public Measurement[] getModelMeasurements()

Specified by:

getModelMeasurements in interface Clusterer

getDescription

public void getDescription(StringBuilder out,
                  int indent)

Description copied from interface: MOAObject

Returns a string representation of this object. Used in AbstractMOAObject.toString to give a string representation of the object.

Specified by:

getDescription in interface MOAObject

Parameters:

out - the stringbuilder to add the description

indent - the number of characters to indent

getSubClusterers

public Clusterer[] getSubClusterers()

Specified by:

getSubClusterers in interface Clusterer

copy

public Clusterer copy()

Description copied from interface: MOAObject

This method produces a copy of this object.

Specified by:

copy in interface Clusterer

Specified by:

copy in interface MOAObject

Specified by:

copy in interface OptionHandler

Overrides:

copy in class AbstractOptionHandler

Returns:

a copy of this object

getClassNameString

public String getClassNameString()

getClassLabelString

public String getClassLabelString(int classLabelIndex)

getAttributeNameString

public String getAttributeNameString(int attIndex)

getNominalValueString

public String getNominalValueString(int attIndex,
                           int valIndex)

contextIsCompatible

public static boolean contextIsCompatible(InstancesHeader originalContext,
                          InstancesHeader newContext)

getAWTRenderer

public AWTRenderer getAWTRenderer()

Specified by:

getAWTRenderer in interface AWTRenderable

resetLearningImpl

public abstract void resetLearningImpl()

trainOnInstanceImpl

public abstract void trainOnInstanceImpl(weka.core.Instance inst)

getModelMeasurementsImpl

protected abstract Measurement[] getModelMeasurementsImpl()

getModelDescription

public abstract void getModelDescription(StringBuilder out,
                       int indent)

modelAttIndexToInstanceAttIndex

protected static int modelAttIndexToInstanceAttIndex(int index,
                                  weka.core.Instance inst)

modelAttIndexToInstanceAttIndex

protected static int modelAttIndexToInstanceAttIndex(int index,
                                  weka.core.Instances insts)

implementsMicroClusterer

public boolean implementsMicroClusterer()

Specified by:

implementsMicroClusterer in interface Clusterer

keepClassLabel

public boolean keepClassLabel()

Specified by:

keepClassLabel in interface Clusterer

getMicroClusteringResult

public Clustering getMicroClusteringResult()

Specified by:

getMicroClusteringResult in interface Clusterer