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

Class ResidualsVsFitted

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

All Implemented Interfaces:

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

public class ResidualsVsFitted
extends AbstractOutputGeneratorWithSeparateFoldsSupport<ComponentContentPanel>

Plots the residuals vs the fitted values (= predictions).

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.gui.visualization.watermark.Watermark	m_Watermark	the watermark to use.

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

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, adams.data.spreadsheet.SpreadSheet additionalAttributes, adams.core.MessageCollection errors)	Generates the output for the evaluation.
void	defineOptions()	Adds options to the internal list of options.
String	getTitle()	The title to use for the tab.
adams.gui.visualization.watermark.Watermark	getWatermark()	Returns the watermark to use.
String	globalInfo()	Returns a string describing the object.
void	setWatermark(adams.gui.visualization.watermark.Watermark value)	Sets the watermark to use.
String	watermarkTipText()	Returns the tip text for this 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_Watermark

protected adams.gui.visualization.watermark.Watermark m_Watermark

the watermark to use.

Constructor Detail

ResidualsVsFitted

public ResidualsVsFitted()

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

setWatermark

public void setWatermark(adams.gui.visualization.watermark.Watermark value)

Sets the watermark to use.

Parameters:

value - the watermark

getWatermark

public adams.gui.visualization.watermark.Watermark getWatermark()

Returns the watermark to use.

Returns:

the watermark

watermarkTipText

public String watermarkTipText()

Returns the tip text for this property.

Returns:

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

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,
                                             adams.data.spreadsheet.SpreadSheet additionalAttributes,
                                             adams.core.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