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

Class PredictionTrend

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

All Implemented Interfaces:

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

public class PredictionTrend
extends AbstractOutputGeneratorWithSeparateFoldsSupport<ComponentContentPanel>
implements ColorProviderHandler

Generates a 'prediction trend' for classifier errors: sorts the predictions on the actual value and plots actual and predicted side-by-side.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ColorProvider	m_ColorProvider	the color provider to use.
protected XYSequencePaintlet	m_Paintlet	the paintlet.
protected 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
PredictionTrend()

Method Summary

Modifier and Type	Method	Description
boolean	canGenerateOutput(ResultItem item)	Checks whether output can be generated from this item.
String	colorProviderTipText()	Returns the tip text for this property.
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.
ColorProvider	getColorProvider()	Returns the color provider for the plots.
protected ColorProvider	getDefaultColorProvider()	Returns the default color provider to use.
protected XYSequencePaintlet	getDefaultPaintlet()	Returns the default paintlet to use.
XYSequencePaintlet	getPaintlet()	Returns the paintlet to use for the plot.
String	getTitle()	The title to use for the tab.
Watermark	getWatermark()	Returns the watermark to use.
String	globalInfo()	Returns a string describing the object.
String	paintletTipText()	Returns the tip text for this property.
void	setColorProvider(ColorProvider value)	Sets the color provider for the plots.
void	setPaintlet(XYSequencePaintlet value)	Sets the paintlet to use for the plot.
void	setWatermark(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_Paintlet

protected XYSequencePaintlet m_Paintlet

the paintlet.

m_ColorProvider

protected ColorProvider m_ColorProvider

the color provider to use.

m_Watermark

protected Watermark m_Watermark

the watermark to use.

Constructor Detail

PredictionTrend

public PredictionTrend()

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

getDefaultPaintlet

protected XYSequencePaintlet getDefaultPaintlet()

Returns the default paintlet to use.

Returns:

the paintlet

setPaintlet

public void setPaintlet(XYSequencePaintlet value)

Sets the paintlet to use for the plot.

Parameters:

value - the paintlet

getPaintlet

public XYSequencePaintlet getPaintlet()

Returns the paintlet to use for the plot.

Returns:

the paintlet

paintletTipText

public String paintletTipText()

Returns the tip text for this property.

Returns:

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

getDefaultColorProvider

protected ColorProvider getDefaultColorProvider()

Returns the default color provider to use.

Returns:

the default

setColorProvider

public void setColorProvider(ColorProvider value)

Sets the color provider for the plots.

Specified by:

setColorProvider in interface ColorProviderHandler

Parameters:

value - the color provider

getColorProvider

public ColorProvider getColorProvider()

Returns the color provider for the plots.

Specified by:

getColorProvider in interface ColorProviderHandler

Returns:

the color provider

colorProviderTipText

public String colorProviderTipText()

Returns the tip text for this property.

Specified by:

colorProviderTipText in interface ColorProviderHandler

Returns:

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

setWatermark

public void setWatermark(Watermark value)

Sets the watermark to use.

Parameters:

value - the watermark

getWatermark

public 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,
                                             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