weka.gui.explorer

Class ClustererAssignmentsPlotInstances

java.lang.Object

weka.gui.explorer.AbstractPlotInstances

weka.gui.explorer.ClustererAssignmentsPlotInstances

All Implemented Interfaces:

java.io.Serializable, OptionHandler

public class ClustererAssignmentsPlotInstances
extends AbstractPlotInstances

A class for generating plottable cluster assignments.

Example usage:

 Instances train = ... // from somewhere
 Instances test = ... // from somewhere
 Clusterer cls = ... // from somewhere
 // build and evaluate clusterer
 cls.buildClusterer(train);
 ClusterEvaluation eval = new ClusterEvaluation();
 eval.setClusterer(cls);
 eval.evaluateClusterer(test);
 // generate plot instances
 ClustererPlotInstances plotInstances = new ClustererPlotInstances();
 plotInstances.setClusterer(cls);
 plotInstances.setInstances(test);
 plotInstances.setClusterer(cls);
 plotInstances.setClusterEvaluation(eval);
 plotInstances.setUp();
 // generate visualization
 VisualizePanel visPanel = new VisualizePanel();
 visPanel.addPlot(plotInstances.getPlotData("plot name"));
 // clean up
 plotInstances.cleanUp();
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Clusterer	m_Clusterer the clusterer being used.
protected ClusterEvaluation	m_Evaluation the cluster evaluation to use.
protected int[]	m_PlotShapes for storing the plot shapes.

Fields inherited from class weka.gui.explorer.AbstractPlotInstances

m_FinishUpCalled, m_Instances, m_PlotInstances

Constructor Summary

Constructors

Constructor and Description
ClustererAssignmentsPlotInstances()

Method Summary

Modifier and Type	Method and Description
protected void	check() Checks whether clusterer and evaluation are provided.
void	cleanUp() For freeing up memory.
protected PlotData2D	createPlotData(java.lang.String name) Assembles and returns the plot.
protected void	determineFormat() Sets up the structure for the plot instances.
protected void	finishUp() Performs optional post-processing.
Clusterer	getClusterer() Returns the currently set clusterer.
ClusterEvaluation	getClusterEvaluation() Returns the cluster evaluation object in use.
protected void	initialize() Initializes the members.
protected void	process() Generates the cluster assignments.
void	setClusterer(Clusterer value) Sets the classifier used for making the predictions.
void	setClusterEvaluation(ClusterEvaluation value) Sets the cluster evaluation object to use.

Methods inherited from class weka.gui.explorer.AbstractPlotInstances

canPlot, getInstances, getOptions, getPlotData, getPlotInstances, listOptions, setInstances, setOptions, setUp

Methods inherited from class java.lang.Object

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

Field Detail

m_PlotShapes

protected int[] m_PlotShapes

for storing the plot shapes.

m_Clusterer

protected Clusterer m_Clusterer

the clusterer being used.

m_Evaluation

protected ClusterEvaluation m_Evaluation

the cluster evaluation to use.

Constructor Detail

ClustererAssignmentsPlotInstances

public ClustererAssignmentsPlotInstances()

Method Detail

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractPlotInstances

setClusterer

public void setClusterer(Clusterer value)

Sets the classifier used for making the predictions.

Parameters:

value - the clusterer to use

getClusterer

public Clusterer getClusterer()

Returns the currently set clusterer.

Returns:

the clusterer in use

setClusterEvaluation

public void setClusterEvaluation(ClusterEvaluation value)

Sets the cluster evaluation object to use.

Parameters:

value - the evaluation object

getClusterEvaluation

public ClusterEvaluation getClusterEvaluation()

Returns the cluster evaluation object in use.

Returns:

the evaluation object

check

protected void check()

Checks whether clusterer and evaluation are provided.

Overrides:

check in class AbstractPlotInstances

determineFormat

protected void determineFormat()

Sets up the structure for the plot instances.

Specified by:

determineFormat in class AbstractPlotInstances

process

protected void process()

Generates the cluster assignments.

See Also:

m_PlotShapes, #m_PlotSizes, AbstractPlotInstances.m_PlotInstances

finishUp

protected void finishUp()

Performs optional post-processing.

Overrides:

finishUp in class AbstractPlotInstances

createPlotData

protected PlotData2D createPlotData(java.lang.String name)
                             throws java.lang.Exception

Assembles and returns the plot. The relation name of the dataset gets added automatically.

Specified by:

createPlotData in class AbstractPlotInstances

Parameters:

name - the name of the plot

Returns:

the plot

Throws:

java.lang.Exception - if plot generation fails

cleanUp

public void cleanUp()

For freeing up memory. Plot data cannot be generated after this call!

Overrides:

cleanUp in class AbstractPlotInstances