Package adams.flow.transformer.wekarepeatedcrossvalidationoutput

Class SamplePlot

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.wekarepeatedcrossvalidationoutput.AbstractWekaRepeatedCrossValidationOutput<adams.flow.container.SequencePlotterContainer[]>

adams.flow.transformer.wekarepeatedcrossvalidationoutput.SamplePlot

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, Serializable

public class SamplePlot
extends AbstractWekaRepeatedCrossValidationOutput<adams.flow.container.SequencePlotterContainer[]>

Generates plot containers with statistics derived for each sample across the cross-validation runs.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected LowerStatistic	m_Lower	the lower value to compute.
protected CenterStatistic	m_Statistic	the statistic to generate.
protected UpperStatistic	m_Upper	the upper value to compute.

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
SamplePlot()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected adams.flow.container.SequencePlotterContainer[]	doGenerateOutput(WekaEvaluationContainer[] conts)	Generates the data.
Class	generates()	Returns the class that it generates.
LowerStatistic	getLower()	Returns the lower value to output.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
CenterStatistic	getStatistic()	Returns the statistic to output.
UpperStatistic	getUpper()	Returns the upper value to output.
String	globalInfo()	Returns a string describing the object.
String	handles(WekaEvaluationContainer[] conts)	Checks whether the cross-validation results can be processed.
String	lowerTipText()	Returns the tip text for this property.
void	setLower(LowerStatistic value)	Sets the lower value to output.
void	setStatistic(CenterStatistic value)	Sets the statistic to output.
void	setUpper(UpperStatistic value)	Sets the upper value to output.
String	statisticTipText()	Returns the tip text for this property.
String	upperTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.wekarepeatedcrossvalidationoutput.AbstractWekaRepeatedCrossValidationOutput

generateOutput

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Field Detail

m_Statistic

protected CenterStatistic m_Statistic

the statistic to generate.

m_Lower

protected LowerStatistic m_Lower

the lower value to compute.

m_Upper

protected UpperStatistic m_Upper

the upper value to compute.

Constructor Detail

SamplePlot

public SamplePlot()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setStatistic

public void setStatistic(CenterStatistic value)

Sets the statistic to output.

Parameters:

value - the statistic

getStatistic

public CenterStatistic getStatistic()

Returns the statistic to output.

Returns:

the statistic

statisticTipText

public String statisticTipText()

Returns the tip text for this property.

Returns:

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

setLower

public void setLower(LowerStatistic value)

Sets the lower value to output.

Parameters:

value - the lower value

getLower

public LowerStatistic getLower()

Returns the lower value to output.

Returns:

the lower value

lowerTipText

public String lowerTipText()

Returns the tip text for this property.

Returns:

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

setUpper

public void setUpper(UpperStatistic value)

Sets the upper value to output.

Parameters:

value - the upper value

getUpper

public UpperStatistic getUpper()

Returns the upper value to output.

Returns:

the upper value

upperTipText

public String upperTipText()

Returns the tip text for this property.

Returns:

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

generates

public Class generates()

Returns the class that it generates.

Specified by:

generates in class AbstractWekaRepeatedCrossValidationOutput<adams.flow.container.SequencePlotterContainer[]>

Returns:

the class

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractWekaRepeatedCrossValidationOutput<adams.flow.container.SequencePlotterContainer[]>

Returns:

null if no info available, otherwise short string

handles

public String handles(WekaEvaluationContainer[] conts)

Checks whether the cross-validation results can be processed.

Specified by:

handles in class AbstractWekaRepeatedCrossValidationOutput<adams.flow.container.SequencePlotterContainer[]>

Parameters:

conts - the containers to check

Returns:

null if the data can be processed, otherwise an error message

doGenerateOutput

protected adams.flow.container.SequencePlotterContainer[] doGenerateOutput(WekaEvaluationContainer[] conts)

Generates the data.

Specified by:

doGenerateOutput in class AbstractWekaRepeatedCrossValidationOutput<adams.flow.container.SequencePlotterContainer[]>

Parameters:

conts - the containers to process

Returns:

the generated data