adams.flow.sink
Class WekaCostCurve

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.core.AbstractDisplay
                  adams.flow.sink.AbstractDisplay
                      adams.flow.sink.AbstractGraphicalDisplay
                          adams.flow.sink.WekaCostCurve

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, Serializable, Comparable

public class WekaCostCurve
extends AbstractGraphicalDisplay
implements DisplayPanelProvider

Actor for displaying classifier errors.

Input/output:
- accepts:
weka.classifiers.Evaluation

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: CostCurve
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-width <int> (property: width)
    The width of the dialog.
    default: 640
    minimum: 1
 

-height <int> (property: height)
    The height of the dialog.
    default: 480
    minimum: 1
 

-x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -1
    minimum: -3
 

-y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -1
    minimum: -3
 

-writer <adams.gui.print.JComponentWriter [options]> (property: writer)
    The writer to use for generating the graphics output.
    default: adams.gui.print.NullWriter
 

-index <java.lang.String> (property: classLabelIndex)
    The 1-based index of the class label to use for the plot, 'first' and 'last'
     are accepted as well.
    default: first
 

Version:

$Revision: 5737 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected Index	m_ClassLabelIndex the class label index.
protected weka.gui.visualize.ThresholdVisualizePanel	m_VisualizePanel the text area.

Fields inherited from class adams.flow.sink.AbstractGraphicalDisplay

m_GraphicFileChooser, m_MenuBar, m_MenuItemFileClear, m_MenuItemFileClose, m_MenuItemFileSaveAs, m_MenuItemFileSaveTextAs, m_TextFileChooser, m_Writer

Fields inherited from class adams.flow.core.AbstractDisplay

BACKUP_INPUT, m_CreateFrame, m_Frame, m_Height, m_InputToken, m_Panel, m_ShortTitle, m_Updating, m_Width, m_X, m_Y

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

WekaCostCurve()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
String	classLabelIndexTipText() Returns the tip text for this property.
protected void	cleanUpGUI() Removes all graphical components.
void	clearPanel() Clears the content of the panel.
AbstractDisplayPanel	createDisplayPanel(Token token) Creates a new panel for the token.
void	defineOptions() Adds options to the internal list of options.
protected void	display(Token token) Plots the token (the panel and dialog have already been created at this stage).
boolean	displayPanelRequiresScrollPane() Returns whether the created display panel requires a scroll pane or not.
Index	getClassLabelIndex() Returns the class label index (1-based index).
protected int	getDefaultHeight() Returns the default height for the dialog.
protected int	getDefaultWidth() Returns the default width for the dialog.
String	globalInfo() Returns a string describing the object.
protected void	initialize() Initializes the members.
protected BasePanel	newPanel() Creates the panel to display in the dialog.
void	setClassLabelIndex(Index value) Sets the class label index (1-based index).

Methods inherited from class adams.flow.sink.AbstractGraphicalDisplay

clear, close, createMenuBar, getGraphicFileChooser, getMenuBar, getSendToClasses, getSendToItem, getTextFileChooser, getWriter, hasPanel, hasSendToItem, postDisplay, preDisplay, saveAs, saveTextAs, setWriter, supplyComponent, supportsClear, updateMenu, writerTipText

Methods inherited from class adams.flow.sink.AbstractDisplay

newDisplayRunnable

Methods inherited from class adams.flow.core.AbstractDisplay

backupState, cleanUp, createFrame, createTitle, doCreateFrame, doExecute, getCreateFrame, getDefaultX, getDefaultY, getFrame, getHeight, getPanel, getQuickInfo, getShortTitle, getWidth, getX, getY, heightTipText, input, postCreateFrame, preCreateFrame, reset, restoreState, setCreateFrame, setHeight, setShortTitle, setWidth, setX, setY, shortTitleTipText, stopExecution, widthTipText, wrapUp, xTipText, yTipText

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, compareTo, debug, destroy, equals, execute, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, postExecute, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.InputConsumer

input

Field Detail

m_VisualizePanel

protected weka.gui.visualize.ThresholdVisualizePanel m_VisualizePanel

the text area.

m_ClassLabelIndex

protected Index m_ClassLabelIndex

the class label index.

Constructor Detail

WekaCostCurve

public WekaCostCurve()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

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 AbstractGraphicalDisplay

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractDisplay

getDefaultWidth

protected int getDefaultWidth()

Returns the default width for the dialog.

Overrides:

getDefaultWidth in class AbstractDisplay

Returns:

the default width

getDefaultHeight

protected int getDefaultHeight()

Returns the default height for the dialog.

Overrides:

getDefaultHeight in class AbstractDisplay

Returns:

the default height

setClassLabelIndex

public void setClassLabelIndex(Index value)

Sets the class label index (1-based index).

Parameters:

value - the index

getClassLabelIndex

public Index getClassLabelIndex()

Returns the class label index (1-based index).

Returns:

the index

classLabelIndexTipText

public String classLabelIndexTipText()

Returns the tip text for this property.

Returns:

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

clearPanel

public void clearPanel()

Clears the content of the panel.

Specified by:

clearPanel in class AbstractDisplay

newPanel

protected BasePanel newPanel()

Creates the panel to display in the dialog.

Specified by:

newPanel in class AbstractDisplay

Returns:

the panel

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Returns:

weka.classifiers.Evaluation.class

display

protected void display(Token token)

Plots the token (the panel and dialog have already been created at this stage).

Specified by:

display in class AbstractDisplay

Parameters:

token - the token to display

cleanUpGUI

protected void cleanUpGUI()

Removes all graphical components.

Overrides:

cleanUpGUI in class AbstractGraphicalDisplay

createDisplayPanel

public AbstractDisplayPanel createDisplayPanel(Token token)

Creates a new panel for the token.

Specified by:

createDisplayPanel in interface DisplayPanelProvider

Parameters:

token - the token to display in a new panel

Returns:

the generated panel

displayPanelRequiresScrollPane

public boolean displayPanelRequiresScrollPane()

Returns whether the created display panel requires a scroll pane or not.

Specified by:

displayPanelRequiresScrollPane in interface DisplayPanelProvider

Returns:

true if the display panel requires a scroll pane