adams.flow.transformer
Class WekaAccumulatedError

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.WekaAccumulatedError

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class WekaAccumulatedError
extends AbstractTransformer

Generates plot containers from an evaluation object's predictions. The predictions are first sorted according to their error, smallest to largest, and then plot containers are created with the RMSE being accumulated.

Input/output:
- accepts:
weka.classifiers.Evaluation
- generates:
adams.flow.container.SequencePlotterContainer

Valid options are:

-D (property: debug)
    If set to true, scheme may output additional info to the console.
 

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

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

-plot-name <java.lang.String> (property: plotName)
    The name for the plot.
    default: Plot
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

static class

WekaAccumulatedError.SortablePrediction Container for a classifier prediction, used for sorting.

Field Summary

static String	BACKUP_ACCUMULATEDERROR the key for storing the current accumulated error in the backup.
static String	BACKUP_NUMPREDICTIONS the key for storing the current number of predictions in the backup.
static String	BACKUP_PREDICTIONS the key for storing the current predictions in the backup.
protected double	m_AccumulatdError the accumulated error so far.
protected int	m_NumPredictions the number of overall predictions.
protected String	m_PlotName the name of the plot.
protected Vector<WekaAccumulatedError.SortablePrediction>	m_Predictions the sorted predictions.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

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

WekaAccumulatedError()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
protected Hashtable<String,Object>	backupState() Backs up the current state of the actor before update the variables.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
String	getPlotName() Returns the current plot name.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo() Returns a string describing the object.
boolean	hasPendingOutput() Checks whether there is pending output to be collected after executing the flow item.
Token	output() Returns the generated token.
String	plotNameTipText() Returns the tip text for this property.
protected void	pruneBackup() Removes entries from the backup.
protected void	reset() Resets the scheme.
protected void	restoreState(Hashtable<String,Object> state) Restores the state of the actor before the variables got updated.
void	setPlotName(String value) Sets the plot name.
void	wrapUp() Cleans up after the execution has finished.

Methods inherited from class adams.flow.transformer.AbstractTransformer

execute, input, postExecute

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, 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, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, 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

Field Detail

BACKUP_PREDICTIONS

public static final String BACKUP_PREDICTIONS

the key for storing the current predictions in the backup.

See Also:

Constant Field Values

BACKUP_NUMPREDICTIONS

public static final String BACKUP_NUMPREDICTIONS

the key for storing the current number of predictions in the backup.

See Also:

Constant Field Values

BACKUP_ACCUMULATEDERROR

public static final String BACKUP_ACCUMULATEDERROR

the key for storing the current accumulated error in the backup.

See Also:

Constant Field Values

m_PlotName

protected String m_PlotName

the name of the plot.

m_Predictions

protected Vector<WekaAccumulatedError.SortablePrediction> m_Predictions

the sorted predictions.

m_NumPredictions

protected int m_NumPredictions

the number of overall predictions.

m_AccumulatdError

protected double m_AccumulatdError

the accumulated error so far.

Constructor Detail

WekaAccumulatedError

public WekaAccumulatedError()

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 AbstractActor

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

setPlotName

public void setPlotName(String value)

Sets the plot name.

Parameters:

value - the name

getPlotName

public String getPlotName()

Returns the current plot name.

Returns:

the name

plotNameTipText

public String plotNameTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

weka.classifiers.Evaluation.class

pruneBackup

protected void pruneBackup()

Removes entries from the backup.

Overrides:

pruneBackup in class AbstractActor

backupState

protected Hashtable<String,Object> backupState()

Backs up the current state of the actor before update the variables.

Overrides:

backupState in class AbstractTransformer

Returns:

the backup

restoreState

protected void restoreState(Hashtable<String,Object> state)

Restores the state of the actor before the variables got updated.

Overrides:

restoreState in class AbstractTransformer

Parameters:

state - the backup of the state to restore from

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractTransformer

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

adams.flow.container.SequencePlotterContainer.class

hasPendingOutput

public boolean hasPendingOutput()

Checks whether there is pending output to be collected after executing the flow item.

Specified by:

hasPendingOutput in interface OutputProducer

Overrides:

hasPendingOutput in class AbstractTransformer

Returns:

true if there is pending output

output

public Token output()

Returns the generated token.

Specified by:

output in interface OutputProducer

Overrides:

output in class AbstractTransformer

Returns:

the generated token

wrapUp

public void wrapUp()

Cleans up after the execution has finished.

Overrides:

wrapUp in class AbstractTransformer