Package adams.flow.sink.sequenceplotter

Class ErrorBandPaintlet

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.flow.sink.sequenceplotter.AbstractErrorPaintlet

adams.flow.sink.sequenceplotter.ErrorBandPaintlet

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, ShallowCopySupporter<Paintlet>, SizeOfHandler, Paintlet, PaintletWithOptionalPointPreprocessor, Serializable

public class ErrorBandPaintlet
extends AbstractErrorPaintlet

Plots a band around the values, using the Y errors to define the width of the band.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Alpha	the alpha value to use for the band.
protected HashMap<Color,Color>	m_BandColors	the color to use for the band.

Fields inherited from class adams.flow.sink.sequenceplotter.AbstractErrorPaintlet

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

Method Summary

Modifier and Type	Method	Description
String	alphaTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected void	drawData(Graphics g, SequencePlotSequence data, Color color)	Draws the error data with the given color.
int	getAlpha()	Returns the alpha value for the band (0-255).
String	globalInfo()	Returns a string describing the object.
protected void	initialize()	Initializes the members.
protected void	reset()	Resets the scheme.
void	setAlpha(int value)	Sets the alpha value for the band (0-255).
boolean	supportsPointPreprocessor()	Returns whether point preprocessing is actually supported.

Methods inherited from class adams.flow.sink.sequenceplotter.AbstractErrorPaintlet

doPerformPaint, getColor, getPaintMoment, getPlotterPanel, getPointPreprocessor, newPointPreprocessor, pointPreprocessorTipText, setPointPreprocessor

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, memberChanged, paint, repaint, setEnabled, setPanel, setPanel, setRepaintOnChange, shallowCopy, shallowCopy, updatePanel

Methods inherited from class adams.core.option.AbstractOptionHandler

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

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

Field Detail

m_Alpha

protected int m_Alpha

the alpha value to use for the band.

m_BandColors

protected HashMap<Color,Color> m_BandColors

the color to use for the band.

Constructor Detail

ErrorBandPaintlet

public ErrorBandPaintlet()

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

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractErrorPaintlet

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class AbstractOptionHandler

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractErrorPaintlet

setAlpha

public void setAlpha(int value)

Sets the alpha value for the band (0-255).

Parameters:

value - the alpha value

getAlpha

public int getAlpha()

Returns the alpha value for the band (0-255).

Returns:

the alpha value

alphaTipText

public String alphaTipText()

Returns the tip text for this property.

Returns:

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

supportsPointPreprocessor

public boolean supportsPointPreprocessor()

Returns whether point preprocessing is actually supported.

Specified by:

supportsPointPreprocessor in interface PaintletWithOptionalPointPreprocessor

Overrides:

supportsPointPreprocessor in class AbstractErrorPaintlet

Returns:

true if supported

drawData

protected void drawData(Graphics g,
                        SequencePlotSequence data,
                        Color color)

Draws the error data with the given color.

Specified by:

drawData in class AbstractErrorPaintlet

Parameters:

g - the graphics context

data - the error data to draw

color - the color to draw in