weka.gui.explorer
Class ClustererPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  weka.gui.explorer.ClustererPanel

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ClustererPanel

extends javax.swing.JPanel

This panel allows the user to select and configure a clusterer, and evaluate the clusterer using a number of testing modes (test on the training data, train/test on a percentage split, test on a separate split). The results of clustering runs are stored in a result history so that previous results are accessible.

Version:

$Revision: 1.42 $

Author:

Mark Hall (mhall@cs.waikato.ac.nz), Richard Kirkby (rkirkby@cs.waikato.ac.nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

private java.awt.Dimension	COMBO_SIZE Stop the class combo from taking up to much space
protected javax.swing.JComboBox	m_ClassCombo Lets the user select the class column for classes to clusters based evaluation
protected javax.swing.JRadioButton	m_ClassesToClustersBut Click to set test mode to classes to clusters based evaluation
protected PropertyPanel	m_CLPanel The panel showing the current clusterer selection
protected GenericObjectEditor	m_ClustererEditor Lets the user configure the clusterer
protected VisualizePanel	m_CurrentVis The current visualization object
protected javax.swing.JFileChooser	m_FileChooser The file chooser for selecting model files
protected ResultHistoryPanel	m_History A panel controlling results viewing
protected javax.swing.JButton	m_ignoreBut The button used to popup a list for choosing attributes to ignore while clustering
protected javax.swing.JList	m_ignoreKeyList
protected javax.swing.DefaultListModel	m_ignoreKeyModel
protected Instances	m_Instances The main set of instances we're playing with
protected Logger	m_Log The destination for log/status messages
protected javax.swing.filechooser.FileFilter	m_ModelFilter Filter to ensure only model files are selected
protected javax.swing.JTextArea	m_OutText The output area for classification results
protected javax.swing.JRadioButton	m_PercentBut Click to set test mode to generate a % split
protected javax.swing.JLabel	m_PercentLab Label by where the % split is entered
protected javax.swing.JTextField	m_PercentText The field where the % split is entered
(package private) java.awt.event.ActionListener	m_RadioListener Alters the enabled/disabled status of elements associated with each radio button
protected java.lang.Thread	m_RunThread A thread that clustering runs in
(package private) SaveBuffer	m_SaveOut The buffer saving object for saving output
protected javax.swing.JButton	m_SetTestBut The button used to open a separate test dataset
protected javax.swing.JFrame	m_SetTestFrame The frame used to show the test set selection panel
protected javax.swing.JButton	m_StartBut Click to start running the clusterer
protected javax.swing.JButton	m_StopBut Click to stop a running clusterer
protected javax.swing.JCheckBox	m_StorePredictionsBut Check to save the predictions in the results list for visualizing later on
protected InstancesSummaryPanel	m_Summary The instances summary panel displayed by m_SetTestFrame
protected Instances	m_TestInstances The user-supplied test set (if any)
protected Instances	m_TestInstancesCopy The user supplied test set after preprocess filters have been applied
protected javax.swing.JRadioButton	m_TestSplitBut Click to set test mode to a user-specified test set
protected javax.swing.JRadioButton	m_TrainBut Click to set test mode to test on training data
protected int	m_visXIndex default x index for visualizing
protected int	m_visYIndex default y index for visualizing
static java.lang.String	MODEL_FILE_EXTENSION The filename extension that should be used for model files

Fields inherited from class javax.swing.JPanel

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ClustererPanel()
Creates the clusterer panel

Method Summary

protected void	loadClusterer() Loads a clusterer
static void	main(java.lang.String[] args) Tests out the clusterer panel from the command line.
protected void	reevaluateModel(java.lang.String name, Clusterer clusterer, Instances trainHeader, int[] ignoredAtts) Re-evaluates the named clusterer with the current test set.
private Instances	removeClass(Instances inst)
private Instances	removeIgnoreCols(Instances inst)
private Instances	removeIgnoreCols(Instances inst, int[] toIgnore)
protected void	saveBuffer(java.lang.String name) Save the currently selected clusterer output to a file.
protected void	saveClusterer(java.lang.String name, Clusterer clusterer, Instances trainHeader, int[] ignoredAtts) Saves the currently selected clusterer
private void	setIgnoreColumns()
void	setInstances(Instances inst) Tells the panel to use a new set of instances.
void	setLog(Logger newLog) Sets the Logger to receive informational messages
protected void	setTestSet() Sets the user test set.
static PlotData2D	setUpVisualizableInstances(Instances testInstances, ClusterEvaluation eval) Sets up the structure for the visualizable instances.
void	setXY_VisualizeIndexes(int x, int y) Set the default attributes to use on the x and y axis of a new visualization object.
protected void	startClusterer() Starts running the currently configured clusterer with the current settings.
protected void	stopClusterer() Stops the currently running clusterer (if any).
protected void	updateRadioLinks() Updates the enabled status of the input fields and labels.
protected void	visualizeClusterAssignments(VisualizePanel sp) Pops up a visualize panel to display cluster assignments
protected void	visualizeClusterer(java.lang.String name, int x, int y) Handles constructing a popup menu with visualization options
protected void	visualizeTree(java.lang.String dottyString, java.lang.String treeName) Pops up a TreeVisualizer for the clusterer from the currently selected item in the results list

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_FILE_EXTENSION

public static java.lang.String MODEL_FILE_EXTENSION

The filename extension that should be used for model files

m_ClustererEditor

protected GenericObjectEditor m_ClustererEditor

Lets the user configure the clusterer

m_CLPanel

protected PropertyPanel m_CLPanel

The panel showing the current clusterer selection

m_OutText

protected javax.swing.JTextArea m_OutText

The output area for classification results

m_Log

protected Logger m_Log

The destination for log/status messages

m_SaveOut

SaveBuffer m_SaveOut

The buffer saving object for saving output

m_History

protected ResultHistoryPanel m_History

A panel controlling results viewing

m_PercentBut

protected javax.swing.JRadioButton m_PercentBut

Click to set test mode to generate a % split

m_TrainBut

protected javax.swing.JRadioButton m_TrainBut

Click to set test mode to test on training data

m_TestSplitBut

protected javax.swing.JRadioButton m_TestSplitBut

Click to set test mode to a user-specified test set

m_ClassesToClustersBut

protected javax.swing.JRadioButton m_ClassesToClustersBut

Click to set test mode to classes to clusters based evaluation

m_ClassCombo

protected javax.swing.JComboBox m_ClassCombo

Lets the user select the class column for classes to clusters based evaluation

m_PercentLab

protected javax.swing.JLabel m_PercentLab

Label by where the % split is entered

m_PercentText

protected javax.swing.JTextField m_PercentText

The field where the % split is entered

m_SetTestBut

protected javax.swing.JButton m_SetTestBut

The button used to open a separate test dataset

m_SetTestFrame

protected javax.swing.JFrame m_SetTestFrame

The frame used to show the test set selection panel

m_ignoreBut

protected javax.swing.JButton m_ignoreBut

The button used to popup a list for choosing attributes to ignore while clustering

m_ignoreKeyModel

protected javax.swing.DefaultListModel m_ignoreKeyModel

m_ignoreKeyList

protected javax.swing.JList m_ignoreKeyList

m_RadioListener

java.awt.event.ActionListener m_RadioListener

Alters the enabled/disabled status of elements associated with each radio button

m_StartBut

protected javax.swing.JButton m_StartBut

Click to start running the clusterer

COMBO_SIZE

private java.awt.Dimension COMBO_SIZE

Stop the class combo from taking up to much space

m_StopBut

protected javax.swing.JButton m_StopBut

Click to stop a running clusterer

m_Instances

protected Instances m_Instances

The main set of instances we're playing with

m_TestInstances

protected Instances m_TestInstances

The user-supplied test set (if any)

m_TestInstancesCopy

protected Instances m_TestInstancesCopy

The user supplied test set after preprocess filters have been applied

m_CurrentVis

protected VisualizePanel m_CurrentVis

The current visualization object

m_visXIndex

protected int m_visXIndex

default x index for visualizing

m_visYIndex

protected int m_visYIndex

default y index for visualizing

m_StorePredictionsBut

protected javax.swing.JCheckBox m_StorePredictionsBut

Check to save the predictions in the results list for visualizing later on

m_RunThread

protected java.lang.Thread m_RunThread

A thread that clustering runs in

m_Summary

protected InstancesSummaryPanel m_Summary

The instances summary panel displayed by m_SetTestFrame

m_ModelFilter

protected javax.swing.filechooser.FileFilter m_ModelFilter

Filter to ensure only model files are selected

m_FileChooser

protected javax.swing.JFileChooser m_FileChooser

The file chooser for selecting model files

Constructor Detail

ClustererPanel

public ClustererPanel()

Creates the clusterer panel

Method Detail

updateRadioLinks

protected void updateRadioLinks()

Updates the enabled status of the input fields and labels.

setLog

public void setLog(Logger newLog)

Sets the Logger to receive informational messages

Parameters:

newLog - the Logger that will now get info messages

setXY_VisualizeIndexes

public void setXY_VisualizeIndexes(int x,
                                   int y)

Set the default attributes to use on the x and y axis of a new visualization object.

Parameters:

x - the index of the attribute to use on the x axis

y - the index of the attribute to use on the y axis

setInstances

public void setInstances(Instances inst)

Tells the panel to use a new set of instances.

Parameters:

inst - a set of Instances

setTestSet

protected void setTestSet()

Sets the user test set. Information about the current test set is displayed in an InstanceSummaryPanel and the user is given the ability to load another set from a file or url.

setUpVisualizableInstances

public static PlotData2D setUpVisualizableInstances(Instances testInstances,
                                                    ClusterEvaluation eval)
                                             throws java.lang.Exception

Sets up the structure for the visualizable instances. This dataset contains the original attributes plus the clusterer's cluster assignments

Returns:

a PlotData2D object encapsulating the visualizable instances. The instances contain one more attribute (predicted cluster) than the testInstances

Throws:

java.lang.Exception

startClusterer

protected void startClusterer()

Starts running the currently configured clusterer with the current settings. This is run in a separate thread, and will only start if there is no clusterer already running. The clusterer output is sent to the results history panel.

removeClass

private Instances removeClass(Instances inst)

removeIgnoreCols

private Instances removeIgnoreCols(Instances inst)

removeIgnoreCols

private Instances removeIgnoreCols(Instances inst,
                                   int[] toIgnore)

stopClusterer

protected void stopClusterer()

Stops the currently running clusterer (if any).

visualizeTree

protected void visualizeTree(java.lang.String dottyString,
                             java.lang.String treeName)

Pops up a TreeVisualizer for the clusterer from the currently selected item in the results list

Parameters:

dottyString - the description of the tree in dotty format

treeName - the title to assign to the display

visualizeClusterAssignments

protected void visualizeClusterAssignments(VisualizePanel sp)

Pops up a visualize panel to display cluster assignments

Parameters:

sp - the visualize panel to display

visualizeClusterer

protected void visualizeClusterer(java.lang.String name,
                                  int x,
                                  int y)

Handles constructing a popup menu with visualization options

Parameters:

name - the name of the result history list entry clicked on by the user

x - the x coordinate for popping up the menu

y - the y coordinate for popping up the menu

saveBuffer

protected void saveBuffer(java.lang.String name)

Save the currently selected clusterer output to a file.

Parameters:

name - the name of the buffer to save

setIgnoreColumns

private void setIgnoreColumns()

saveClusterer

protected void saveClusterer(java.lang.String name,
                             Clusterer clusterer,
                             Instances trainHeader,
                             int[] ignoredAtts)

Saves the currently selected clusterer

loadClusterer

protected void loadClusterer()

Loads a clusterer

reevaluateModel

protected void reevaluateModel(java.lang.String name,
                               Clusterer clusterer,
                               Instances trainHeader,
                               int[] ignoredAtts)

Re-evaluates the named clusterer with the current test set. Unpredictable things will happen if the data set is not compatible with the clusterer.

Parameters:

name - the name of the clusterer entry

main

public static void main(java.lang.String[] args)

Tests out the clusterer panel from the command line.

Parameters:

args - may optionally contain the name of a dataset to load.