Package adams.gui.visualization.stats.zscore

Class StdDev

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.stats.zscore.AbstractZScoreOverlay

adams.gui.visualization.stats.zscore.StdDev

All Implemented Interfaces:

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

public class StdDev
extends AbstractZScoreOverlay

Display a standard deviation line on the z score above and below the mean

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-color <java.awt.Color> (property: color)
    Colour to draw the overlay
    default: #000000
 

-line-thickness <float> (property: thickness)
    Thickness of the overlay line
    default: 2.0
    minimum: 1.0
    maximum: 5.0
 

-standard-deviations <double> (property: standardDeviations)
    number of standard deviations from mean
    default: 1.0
    minimum: 1.0
    maximum: 5.0
 

Version:

$Revision$

Author:

msf8

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_StdDev	Number of standard deviations from the mean

Fields inherited from class adams.gui.visualization.stats.zscore.AbstractZScoreOverlay

m_Color, m_Data, m_Paintlet, m_Parent, m_Thickness

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
double	getStandardDeviations()	get the number of standard deviations for the overlay
String	globalInfo()	Returns a string describing the object.
void	setStandardDeviations(double val)	Set the number of standard deviations for the overlay
void	setUp()	set up the overlay and it's paintlet
String	shortName()	Return a short name for the overlay to display in the key
String	standardDeviationsTipText()	return a string for the standard deviations option

Methods inherited from class adams.gui.visualization.stats.zscore.AbstractZScoreOverlay

colorTipText, getColor, getPaintlet, getParent, getThickness, setColor, setData, setParent, setThickness, shallowCopy, shallowCopy, thicknessTipText

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_StdDev

protected double m_StdDev

Number of standard deviations from the mean

Constructor Detail

StdDev

public StdDev()

Method Detail

setUp

public void setUp()

Description copied from class: AbstractZScoreOverlay

set up the overlay and it's paintlet

Specified by:

setUp in class AbstractZScoreOverlay

globalInfo

public String globalInfo()

Description copied from class: AbstractOptionHandler

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

Description copied from class: AbstractOptionHandler

Adds options to the internal list of options. Derived classes must override this method to add additional options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractZScoreOverlay

setStandardDeviations

public void setStandardDeviations(double val)

Set the number of standard deviations for the overlay

Parameters:

val - Number of standard deviations from mean

getStandardDeviations

public double getStandardDeviations()

get the number of standard deviations for the overlay

Returns:

Number of standard deviations from mean

standardDeviationsTipText

public String standardDeviationsTipText()

return a string for the standard deviations option

Returns:

String for the property

shortName

public String shortName()

Description copied from class: AbstractZScoreOverlay

Return a short name for the overlay to display in the key

Specified by:

shortName in class AbstractZScoreOverlay

Returns: