Package adams.gui.tools.wekainvestigator.tab.classifytab.output

Class FourInOnePlot

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.tools.wekainvestigator.output.AbstractOutputGenerator<ResultItem>

adams.gui.tools.wekainvestigator.tab.classifytab.output.AbstractOutputGenerator

adams.gui.tools.wekainvestigator.tab.classifytab.output.AbstractOutputGeneratorWithSeparateFoldsSupport<ComponentContentPanel>

adams.gui.tools.wekainvestigator.tab.classifytab.output.FourInOnePlot

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

public class FourInOnePlot
extends AbstractOutputGeneratorWithSeparateFoldsSupport<ComponentContentPanel>

Generates the 4-in-1 plot: normal plot, histogram, residuals vs fit and vs order.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected HistogramOptions	m_HistogramOptions	Options for the histogram
protected NormalPlotOptions	m_NormalPlotOptions	options for the normal plot
protected boolean	m_UseAbsoluteError	whether to use absolute errors.
protected VersusFitOptions	m_VersusFitOptions	Options for the vs fit
protected VersusOrderOptions	m_VersusOrderOptions	Options for the vs order

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
FourInOnePlot()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateOutput(ResultItem item)	Checks whether output can be generated from this item.
protected ComponentContentPanel	createOutput(ResultItem item, weka.classifiers.Evaluation eval, int[] originalIndices, SpreadSheet additionalAttributes, MessageCollection errors)	Generates the output for the evaluation.
void	defineOptions()	Adds options to the internal list of options.
HistogramOptions	getHistogramOptions()	Get the options for the histogram.
NormalPlotOptions	getNormalPlotOptions()	get the options for the normal plot.
String	getTitle()	The title to use for the tab.
boolean	getUseAbsoluteError()	Returns whether to use an absolute error (ie no direction).
VersusFitOptions	getVersusFitOptions()	Get the options for the vsfit plot.
VersusOrderOptions	getVersusOrderOptions()	Get the options for the vsorder plot.
String	globalInfo()	Returns a string describing the object.
String	histogramOptionsTipText()	Tip text for the histogram options property.
String	normalPlotOptionsTipText()	tip text for the normalplot options property.
void	setHistogramOptions(HistogramOptions value)	Set the options for the histogram.
void	setNormalPlotOptions(NormalPlotOptions value)	Set the options for the normal plot.
void	setUseAbsoluteError(boolean value)	Sets whether to use an absolute error (ie no direction).
void	setVersusFitOptions(VersusFitOptions value)	Set the options for the vsfit plot.
void	setVersusOrderOptions(VersusOrderOptions value)	Set the options for the vs order plot.
String	useAbsoluteErrorTipText()	Returns the tip text for this property.
String	versusFitOptionsTipText()	Tip text for the vs fit options property.
String	versusOrderOptionsTipText()	Tip text for the vsorder options property.

Methods inherited from class adams.gui.tools.wekainvestigator.tab.classifytab.output.AbstractOutputGeneratorWithSeparateFoldsSupport

createOutput

Methods inherited from class adams.gui.tools.wekainvestigator.tab.classifytab.output.AbstractOutputGenerator

addPage, newMultiPagePane

Methods inherited from class adams.gui.tools.wekainvestigator.output.AbstractOutputGenerator

addTab, 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_UseAbsoluteError

protected boolean m_UseAbsoluteError

whether to use absolute errors.

m_NormalPlotOptions

protected NormalPlotOptions m_NormalPlotOptions

options for the normal plot

m_HistogramOptions

protected HistogramOptions m_HistogramOptions

Options for the histogram

m_VersusFitOptions

protected VersusFitOptions m_VersusFitOptions

Options for the vs fit

m_VersusOrderOptions

protected VersusOrderOptions m_VersusOrderOptions

Options for the vs order

Constructor Detail

FourInOnePlot

public FourInOnePlot()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

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 AbstractOptionHandler

setUseAbsoluteError

public void setUseAbsoluteError(boolean value)

Sets whether to use an absolute error (ie no direction).

Parameters:

value - true if to use absolute error

getUseAbsoluteError

public boolean getUseAbsoluteError()

Returns whether to use an absolute error (ie no direction).

Returns:

true if to use absolute error

useAbsoluteErrorTipText

public String useAbsoluteErrorTipText()

Returns the tip text for this property.

Returns:

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

setHistogramOptions

public void setHistogramOptions(HistogramOptions value)

Set the options for the histogram.

Parameters:

value - Histogramoptions object containing the options

getHistogramOptions

public HistogramOptions getHistogramOptions()

Get the options for the histogram.

Returns:

Histogramoptions object containing the options for the histogram

histogramOptionsTipText

public String histogramOptionsTipText()

Tip text for the histogram options property.

Returns:

String describing the property

setVersusOrderOptions

public void setVersusOrderOptions(VersusOrderOptions value)

Set the options for the vs order plot.

Parameters:

value - Versusorderoptions object containing the options

getVersusOrderOptions

public VersusOrderOptions getVersusOrderOptions()

Get the options for the vsorder plot.

Returns:

Versusorder object containing the options

versusOrderOptionsTipText

public String versusOrderOptionsTipText()

Tip text for the vsorder options property.

Returns:

String describing the property

setVersusFitOptions

public void setVersusFitOptions(VersusFitOptions value)

Set the options for the vsfit plot.

Parameters:

value - Vsfiroptions object containing the options

getVersusFitOptions

public VersusFitOptions getVersusFitOptions()

Get the options for the vsfit plot.

Returns:

vsfitoptions object containing the options

versusFitOptionsTipText

public String versusFitOptionsTipText()

Tip text for the vs fit options property.

Returns:

String describing the property

setNormalPlotOptions

public void setNormalPlotOptions(NormalPlotOptions value)

Set the options for the normal plot.

Parameters:

value - Normalplotoptions object containing the options

getNormalPlotOptions

public NormalPlotOptions getNormalPlotOptions()

get the options for the normal plot.

Returns:

Normalplotoptions object containing the options

normalPlotOptionsTipText

public String normalPlotOptionsTipText()

tip text for the normalplot options property.

Returns:

String describing the property

getTitle

public String getTitle()

The title to use for the tab.

Specified by:

getTitle in class AbstractOutputGenerator<ResultItem>

Returns:

the title

canGenerateOutput

public boolean canGenerateOutput(ResultItem item)

Checks whether output can be generated from this item.

Specified by:

canGenerateOutput in class AbstractOutputGenerator<ResultItem>

Parameters:

item - the item to check

Returns:

true if output can be generated

createOutput

protected ComponentContentPanel createOutput(ResultItem item,
                                             weka.classifiers.Evaluation eval,
                                             int[] originalIndices,
                                             SpreadSheet additionalAttributes,
                                             MessageCollection errors)

Generates the output for the evaluation.

Specified by:

createOutput in class AbstractOutputGeneratorWithSeparateFoldsSupport<ComponentContentPanel>

Parameters:

item - the item to generate output for

eval - the evaluation to use as basis

originalIndices - the original indices to use, can be null

additionalAttributes - the additional attributes to display, can be null

errors - for collecting errors

Returns:

the generated table, null if failed to generate