Package adams.gui.visualization.sequence

Class StdDevOverlayPaintlet

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.gui.visualization.core.AbstractPaintlet

adams.gui.visualization.core.AbstractStrokePaintlet

adams.gui.visualization.sequence.AbstractXYSequencePaintlet

adams.gui.visualization.sequence.StdDevOverlayPaintlet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, HitDetectorSupporter<AbstractXYSequencePointHitDetector>, PaintletWithCustomDataSupport, PaintletWithOptionalPointPreprocessor, XYSequencePaintlet, XYSequencePaintletWithCustomerContainerManager, Serializable

public class StdDevOverlayPaintlet
extends AbstractXYSequencePaintlet
implements PaintletWithCustomDataSupport

Draws the standard deviation as straight line.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-stroke-thickness <float> (property: strokeThickness)
    The thickness of the stroke.
    default: 1.0
    minimum: 0.01
 

-factor <double> (property: factor)
    The factor to multiple the standard deviation, eg to display +/- 2 stdev.
    default: 1.0
 

-is-sample <boolean> (property: isSample)
    If enabled, the data are treated as samples and not as populations.
    default: true
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	m_Factor	the factor to multiply the standard deviation with.
protected boolean	m_IsSample	whether the arrays are samples or populations.

Fields inherited from class adams.gui.visualization.sequence.AbstractXYSequencePaintlet

m_CustomerContainerManager, m_HitDetector, m_PointPreprocessor

Fields inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

m_StrokeThickness

Fields inherited from class adams.gui.visualization.core.AbstractPaintlet

m_Enabled, m_Initializing, m_Panel, m_RepaintOnChange

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doDrawCustomData(Graphics g, PaintEvent.PaintMoment moment, XYSequence data, Color color)	Draws the custom data with the given color.
protected void	doPerformPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
void	drawCustomData(Graphics g, PaintEvent.PaintMoment moment, XYSequence data, Color color)	Draws the data with the given color.
String	factorTipText()	Returns the tip text for this property.
double	getFactor()	Returns the factor to multiply the standard deviation with.
boolean	getIsSample()	Returns whether the data represent samples instead of populations.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
String	globalInfo()	Returns a string describing the object.
String	isSampleTipText()	Returns the tip text for this property.
AbstractXYSequencePointHitDetector	newHitDetector()	Returns a new instance of the hit detector to use.
void	setFactor(double value)	Sets the factor to multiply the standard deviation with.
void	setIsSample(boolean value)	Sets whether the data represent samples instead of populations.

Methods inherited from class adams.gui.visualization.sequence.AbstractXYSequencePaintlet

getActualContainerManager, getColor, getCustomerContainerManager, getHitDetector, getPointPreprocessor, getSequencePanel, initialize, memberChanged, newPointPreprocessor, pointPreprocessorTipText, setCustomContainerManager, setLoggingLevel, setPanel, setPointPreprocessor, supportsPointPreprocessor, updateHitDetector

Methods inherited from class adams.gui.visualization.core.AbstractStrokePaintlet

applyStroke, getStrokeThickness, getStrokeWidth, performPaint, setStrokeThickness, strokeThicknessTipText

Methods inherited from class adams.gui.visualization.core.AbstractPaintlet

canPaint, finishInit, forCommandLine, forName, getPaintlets, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, isInitializing, memberChanged, paint, repaint, setEnabled, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, 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

Methods inherited from interface adams.gui.visualization.core.Paintlet

canPaint, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, paint, performPaint, setEnabled, setPanel, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Methods inherited from interface adams.gui.visualization.sequence.XYSequencePaintlet

getSequencePanel

Field Detail

m_Factor

protected double m_Factor

the factor to multiply the standard deviation with.

m_IsSample

protected boolean m_IsSample

whether the arrays are samples or populations.

Constructor Detail

StdDevOverlayPaintlet

public StdDevOverlayPaintlet()

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 AbstractXYSequencePaintlet

setFactor

public void setFactor(double value)

Sets the factor to multiply the standard deviation with.

Parameters:

value - the factor

getFactor

public double getFactor()

Returns the factor to multiply the standard deviation with.

Returns:

the factor

factorTipText

public String factorTipText()

Returns the tip text for this property.

Returns:

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

setIsSample

public void setIsSample(boolean value)

Sets whether the data represent samples instead of populations.

Parameters:

value - true if data are samples and not populations

getIsSample

public boolean getIsSample()

Returns whether the data represent samples instead of populations.

Returns:

true if data are samples and not populations

isSampleTipText

public String isSampleTipText()

Returns the tip text for this property.

Returns:

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

getPaintMoment

public PaintEvent.PaintMoment getPaintMoment()

Returns when this paintlet is to be executed.

Specified by:

getPaintMoment in interface Paintlet

Overrides:

getPaintMoment in class AbstractXYSequencePaintlet

Returns:

when this paintlet is to be executed

newHitDetector

public AbstractXYSequencePointHitDetector newHitDetector()

Returns a new instance of the hit detector to use.

Specified by:

newHitDetector in interface XYSequencePaintlet

Specified by:

newHitDetector in class AbstractXYSequencePaintlet

Returns:

always null

doDrawCustomData

protected void doDrawCustomData(Graphics g,
                                PaintEvent.PaintMoment moment,
                                XYSequence data,
                                Color color)

Draws the custom data with the given color.

Parameters:

g - the graphics context

moment - the paint moment

data - the data to draw

color - the color to draw in

drawCustomData

public void drawCustomData(Graphics g,
                           PaintEvent.PaintMoment moment,
                           XYSequence data,
                           Color color)

Draws the data with the given color.

Specified by:

drawCustomData in interface PaintletWithCustomDataSupport

Parameters:

g - the graphics context

moment - the paint moment

data - the data to draw

color - the color to draw in

doPerformPaint

protected void doPerformPaint(Graphics g,
                              PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

doPerformPaint in class AbstractStrokePaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted