Package adams.flow.transformer.actualvspredictedprocessor

Class ClassifierErrors

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedProcessor<String>

adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor

adams.flow.transformer.actualvspredictedprocessor.ClassifierErrors

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, ActualVsPredictedHtmlProcessor, ActualVsPredictedProcessor<String>, Serializable

public class ClassifierErrors
extends AbstractActualVsPredictedHtmlProcessor

Generates a self-contained HTML file displaying a scatter plot of actual vs predicted.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	m_BorderColor	the border color.
protected double	m_BorderThickness	the thickness of the border.
protected Color	m_CircleFillColor	the circle fill color.
protected int	m_CircleSize	the circle size.
protected boolean	m_ShowLegend	whether to show the legend.

Fields inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor

m_Title

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

Method Summary

Modifier and Type	Method	Description
String	borderColorTipText()	Returns the tip text for this property.
String	borderThicknessTipText()	Returns the tip text for this property.
String	circleFillColorTipText()	Returns the tip text for this property.
String	circleSizeTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doProcess(SpreadSheet sheet)	Processes the actual vs predicted data and returns the output generated.
Color	getBorderColor()	Returns the border color of the circle.
double	getBorderThickness()	Returns the thickness of the circle border.
Color	getCircleFillColor()	Returns the fill color of the circle.
int	getCircleSize()	Returns the size of the circles.
boolean	getShowLegend()	Returns whether to show the legend.
String	globalInfo()	Returns a string describing the object.
void	setBorderColor(Color value)	Sets the border color of the circle.
void	setBorderThickness(double value)	Sets the thickness of the circle border.
void	setCircleFillColor(Color value)	Sets the fill color of the circle.
void	setCircleSize(int value)	Sets the size of the circles.
void	setShowLegend(boolean value)	Sets whether to show the legend.
String	showLegendTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedHtmlProcessor

generatedByAdams, generates, getTitle, setTitle, titleTipText

Methods inherited from class adams.flow.transformer.actualvspredictedprocessor.AbstractActualVsPredictedProcessor

check, getActualNumeric, getAdditional, getPredictedNumeric, process

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.logging.CustomLoggingLevelObject

setLoggingLevel

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.flow.transformer.actualvspredictedprocessor.ActualVsPredictedProcessor

process

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_CircleFillColor

protected Color m_CircleFillColor

the circle fill color.

m_CircleSize

protected int m_CircleSize

the circle size.

m_BorderColor

protected Color m_BorderColor

the border color.

m_BorderThickness

protected double m_BorderThickness

the thickness of the border.

m_ShowLegend

protected boolean m_ShowLegend

whether to show the legend.

Constructor Detail

ClassifierErrors

public ClassifierErrors()

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 AbstractActualVsPredictedHtmlProcessor

setCircleFillColor

public void setCircleFillColor(Color value)

Sets the fill color of the circle.

Parameters:

value - the color

getCircleFillColor

public Color getCircleFillColor()

Returns the fill color of the circle.

Returns:

the color

circleFillColorTipText

public String circleFillColorTipText()

Returns the tip text for this property.

Returns:

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

setCircleSize

public void setCircleSize(int value)

Sets the size of the circles.

Parameters:

value - the size

getCircleSize

public int getCircleSize()

Returns the size of the circles.

Returns:

the size

circleSizeTipText

public String circleSizeTipText()

Returns the tip text for this property.

Returns:

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

setBorderColor

public void setBorderColor(Color value)

Sets the border color of the circle.

Parameters:

value - the color

getBorderColor

public Color getBorderColor()

Returns the border color of the circle.

Returns:

the color

borderColorTipText

public String borderColorTipText()

Returns the tip text for this property.

Returns:

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

setBorderThickness

public void setBorderThickness(double value)

Sets the thickness of the circle border.

Parameters:

value - the thickness

getBorderThickness

public double getBorderThickness()

Returns the thickness of the circle border.

Returns:

the thickness

borderThicknessTipText

public String borderThicknessTipText()

Returns the tip text for this property.

Returns:

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

setShowLegend

public void setShowLegend(boolean value)

Sets whether to show the legend.

Parameters:

value - true if to show

getShowLegend

public boolean getShowLegend()

Returns whether to show the legend.

Returns:

true if to show

showLegendTipText

public String showLegendTipText()

Returns the tip text for this property.

Returns:

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

doProcess

protected String doProcess(SpreadSheet sheet)

Processes the actual vs predicted data and returns the output generated.

Specified by:

doProcess in class AbstractActualVsPredictedProcessor<String>

Parameters:

sheet - the data to process

Returns:

the output