Package adams.flow.sink.sequenceplotter

Class AbstractErrorPaintlet

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ByNameErrorPaintlet, ErrorBandPaintlet, NoErrorPaintlet, SimpleErrorPaintlet

public abstract class AbstractErrorPaintlet
extends AbstractStrokePaintlet
implements PaintletWithOptionalPointPreprocessor

Ancestor for error paintlets.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected PointPreprocessor	m_PointPreprocessor	the preprocessor.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected void	doPerformPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.
protected abstract void	drawData(Graphics g, SequencePlotSequence data, Color color)	Draws the error data with the given color.
Color	getColor(int index)	Returns the color for the data with the given index.
PaintEvent.PaintMoment	getPaintMoment()	Returns when this paintlet is to be executed.
SequencePlotterPanel	getPlotterPanel()	Returns the plotter panel.
PointPreprocessor	getPointPreprocessor()	Returns the point preprocessor in use.
protected void	initialize()	Initializes the members.
PointPreprocessor	newPointPreprocessor()	Returns the point preprocessor in use.
String	pointPreprocessorTipText()	Returns the tip text for this property.
void	setPointPreprocessor(PointPreprocessor value)	Sets the point preprocessor to use.
boolean	supportsPointPreprocessor()	Returns whether point preprocessing is actually supported.

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, globalInfo, 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

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_PointPreprocessor

protected PointPreprocessor m_PointPreprocessor

the preprocessor.

Constructor Detail

AbstractErrorPaintlet

public AbstractErrorPaintlet()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractStrokePaintlet

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractPaintlet

newPointPreprocessor

public PointPreprocessor newPointPreprocessor()

Returns the point preprocessor in use.

Returns:

the preprocessor

supportsPointPreprocessor

public boolean supportsPointPreprocessor()

Returns whether point preprocessing is actually supported.

Specified by:

supportsPointPreprocessor in interface PaintletWithOptionalPointPreprocessor

Returns:

true if supported

setPointPreprocessor

public void setPointPreprocessor(PointPreprocessor value)

Sets the point preprocessor to use.

Specified by:

setPointPreprocessor in interface PaintletWithOptionalPointPreprocessor

Parameters:

value - the preprocessor

getPointPreprocessor

public PointPreprocessor getPointPreprocessor()

Returns the point preprocessor in use.

Specified by:

getPointPreprocessor in interface PaintletWithOptionalPointPreprocessor

Returns:

the preprocessor

pointPreprocessorTipText

public String pointPreprocessorTipText()

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

Specified by:

getPaintMoment in class AbstractPaintlet

Returns:

when this paintlet is to be executed

getPlotterPanel

public SequencePlotterPanel getPlotterPanel()

Returns the plotter panel.

Returns:

the plotter panel

getColor

public Color getColor(int index)

Returns the color for the data with the given index.

Parameters:

index - the index of the spectrum

Returns:

the color for the spectrum

drawData

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

Draws the error data with the given color.

Parameters:

g - the graphics context

data - the error 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