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:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, Explorer.CapabilitiesFilterChangeListener, Explorer.ExplorerPanel, Explorer.LogHandler

public class ClustererPanel
extends JPanel
implements Explorer.CapabilitiesFilterChangeListener, Explorer.ExplorerPanel, Explorer.LogHandler

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: 7754 $

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected JComboBox	m_ClassCombo Lets the user select the class column for classes to clusters based evaluation
protected 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 Explorer	m_Explorer the parent frame
protected JFileChooser	m_FileChooser The file chooser for selecting model files
protected ResultHistoryPanel	m_History A panel controlling results viewing
protected JButton	m_ignoreBut The button used to popup a list for choosing attributes to ignore while clustering
protected JList	m_ignoreKeyList
protected 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 FileFilter	m_ModelFilter Filter to ensure only model files are selected
protected JTextArea	m_OutText The output area for classification results
protected JRadioButton	m_PercentBut Click to set test mode to generate a % split
protected JLabel	m_PercentLab Label by where the % split is entered
protected JTextField	m_PercentText The field where the % split is entered
protected Thread	m_RunThread A thread that clustering runs in
protected JButton	m_SetTestBut The button used to open a separate test dataset
protected JFrame	m_SetTestFrame The frame used to show the test set selection panel
protected JButton	m_StartBut Click to start running the clusterer
protected JButton	m_StopBut Click to stop a running clusterer
protected 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 JRadioButton	m_TestSplitBut Click to set test mode to a user-specified test set
protected JRadioButton	m_TrainBut Click to set test mode to test on training data
static String	MODEL_FILE_EXTENSION The filename extension that should be used for model files

Fields inherited from class javax.swing.JComponent

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.Component

accessibleContext, 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

Constructors

Constructor and Description
ClustererPanel() Creates the clusterer panel

Method Summary

Modifier and Type	Method and Description
void	capabilitiesFilterChanged(Explorer.CapabilitiesFilterChangeEvent e) method gets called in case of a change event
Explorer	getExplorer() returns the parent Explorer frame
String	getTabTitle() Returns the title for the tab in the Explorer
String	getTabTitleToolTip() Returns the tooltip for the tab in the Explorer
protected void	loadClusterer() Loads a clusterer
static void	main(String[] args) Tests out the clusterer panel from the command line.
protected void	reevaluateModel(String name, Clusterer clusterer, Instances trainHeader, int[] ignoredAtts) Re-evaluates the named clusterer with the current test set.
protected void	saveBuffer(String name) Save the currently selected clusterer output to a file.
protected void	saveClusterer(String name, Clusterer clusterer, Instances trainHeader, int[] ignoredAtts) Saves the currently selected clusterer
void	setExplorer(Explorer parent) Sets the Explorer to use as parent frame (used for sending notifications about changes in the data)
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.
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	updateCapabilitiesFilter(Capabilities filter) updates the capabilities filter of the GOE
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(String name, int x, int y) Handles constructing a popup menu with visualization options
protected void	visualizeTree(String graphString, 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, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

m_Explorer

protected Explorer m_Explorer

the parent frame

MODEL_FILE_EXTENSION

public static 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 JTextArea m_OutText

The output area for classification results

m_Log

protected Logger m_Log

The destination for log/status messages

m_History

protected ResultHistoryPanel m_History

A panel controlling results viewing

m_PercentBut

protected JRadioButton m_PercentBut

Click to set test mode to generate a % split

m_TrainBut

protected JRadioButton m_TrainBut

Click to set test mode to test on training data

m_TestSplitBut

protected JRadioButton m_TestSplitBut

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

m_ClassesToClustersBut

protected JRadioButton m_ClassesToClustersBut

Click to set test mode to classes to clusters based evaluation

m_ClassCombo

protected JComboBox m_ClassCombo

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

m_PercentLab

protected JLabel m_PercentLab

Label by where the % split is entered

m_PercentText

protected JTextField m_PercentText

The field where the % split is entered

m_SetTestBut

protected JButton m_SetTestBut

The button used to open a separate test dataset

m_SetTestFrame

protected JFrame m_SetTestFrame

The frame used to show the test set selection panel

m_ignoreBut

protected JButton m_ignoreBut

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

m_ignoreKeyModel

protected DefaultListModel m_ignoreKeyModel

m_ignoreKeyList

protected JList m_ignoreKeyList

m_StartBut

protected JButton m_StartBut

Click to start running the clusterer

m_StopBut

protected 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_CurrentVis

protected VisualizePanel m_CurrentVis

The current visualization object

m_StorePredictionsBut

protected JCheckBox m_StorePredictionsBut

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

m_RunThread

protected 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 FileFilter m_ModelFilter

Filter to ensure only model files are selected

m_FileChooser

protected 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

Specified by:

setLog in interface Explorer.LogHandler

Parameters:

newLog - the Logger that will now get info messages

setInstances

public void setInstances(Instances inst)

Tells the panel to use a new set of instances.

Specified by:

setInstances in interface Explorer.ExplorerPanel

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 Exception

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

Parameters:

testInstances - the instances that the clusterer has clustered

eval - the evaluation to use

Returns:

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

Throws:

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.

stopClusterer

protected void stopClusterer()

Stops the currently running clusterer (if any).

visualizeTree

protected void visualizeTree(String graphString,
                             String treeName)

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

Parameters:

graphString - 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(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(String name)

Save the currently selected clusterer output to a file.

Parameters:

name - the name of the buffer to save

saveClusterer

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

Saves the currently selected clusterer

loadClusterer

protected void loadClusterer()

Loads a clusterer

reevaluateModel

protected void reevaluateModel(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

clusterer - the clusterer to evaluate

trainHeader - the header of the training set

ignoredAtts - ignored attributes

updateCapabilitiesFilter

protected void updateCapabilitiesFilter(Capabilities filter)

updates the capabilities filter of the GOE

Parameters:

filter - the new filter to use

capabilitiesFilterChanged

public void capabilitiesFilterChanged(Explorer.CapabilitiesFilterChangeEvent e)

method gets called in case of a change event

Specified by:

capabilitiesFilterChanged in interface Explorer.CapabilitiesFilterChangeListener

Parameters:

e - the associated change event

setExplorer

public void setExplorer(Explorer parent)

Sets the Explorer to use as parent frame (used for sending notifications about changes in the data)

Specified by:

setExplorer in interface Explorer.ExplorerPanel

Parameters:

parent - the parent frame

getExplorer

public Explorer getExplorer()

returns the parent Explorer frame

Specified by:

getExplorer in interface Explorer.ExplorerPanel

Returns:

the parent

getTabTitle

public String getTabTitle()

Returns the title for the tab in the Explorer

Specified by:

getTabTitle in interface Explorer.ExplorerPanel

Returns:

the title of this tab

getTabTitleToolTip

public String getTabTitleToolTip()

Returns the tooltip for the tab in the Explorer

Specified by:

getTabTitleToolTip in interface Explorer.ExplorerPanel

Returns:

the tooltip of this tab

main

public static void main(String[] args)

Tests out the clusterer panel from the command line.

Parameters:

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