adams.gui.visualization.stats.zscore
Class StdDev

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.gui.visualization.stats.zscore.AbstractZScoreOverlay
              adams.gui.visualization.stats.zscore.StdDev

All Implemented Interfaces:

Debuggable, Destroyable, 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: 4584 $

Author:

msf8

See Also:

Serialized Form

Field Summary

protected double

m_StdDev Number of standard deviations from the mean

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

m_Color, m_Instances, m_Paintlet, m_Parent, m_Thickness

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

StdDev()

Method Summary

void	defineOptions()
double	getStandardDeviations() get the number of standard deviations for the overlay
String	globalInfo()
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, setInstances, setParent, setThickness, shallowCopy, shallowCopy, thicknessTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debug, debugLevelTipText, destroy, finishInit, getDebugLevel, getOptionManager, initialize, isDebugOn, newOptionManager, reset, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Specified by:

globalInfo in class AbstractOptionHandler

defineOptions

public void defineOptions()

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: