Package adams.flow.sink.sequenceplotter

Class SimpleErrorPaintlet

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.SimpleErrorPaintlet

All Implemented Interfaces:

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

public class SimpleErrorPaintlet
extends AbstractErrorPaintlet

Simple error plots: line, errorbar, box.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

SimpleErrorPaintlet.PlotType, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimpleErrorPaintlet.PlotType	how to paint the errors.

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MarkerLength	the length of the markers in case of SimpleErrorPaintlet.PlotType.BAR.
protected SimpleErrorPaintlet.PlotType	m_PlotType	the plot type.

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

Method Summary

Modifier and Type	Method	Description
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.
protected void	drawErrorBar(Graphics g, AxisPanel axisX, AxisPanel axisY, SequencePlotPoint point)	Draws a bars representing the errors.
protected void	drawErrorBox(Graphics g, AxisPanel axisX, AxisPanel axisY, SequencePlotPoint point)	Draws a box representing the errors.
protected void	drawErrorLine(Graphics g, AxisPanel axisX, AxisPanel axisY, SequencePlotPoint point)	Draws a simple line representing the errors.
int	getMarkerLength()	Returns the length of the markers in case of SimpleErrorPaintlet.PlotType.BAR.
SimpleErrorPaintlet.PlotType	getPlotType()	Returns the type of plot.
String	globalInfo()	Returns a string describing the object.
String	markerLengthTipText()	Returns the tip text for this property.
String	plotTypeTipText()	Returns the tip text for this property.
void	setMarkerLength(int value)	Sets the length of the markers in case of SimpleErrorPaintlet.PlotType.BAR.
void	setPlotType(SimpleErrorPaintlet.PlotType value)	Sets the type of plot.

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

doPerformPaint, getColor, getPaintMoment, getPlotterPanel

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, initialize, 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, 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_PlotType

protected SimpleErrorPaintlet.PlotType m_PlotType

the plot type.

m_MarkerLength

protected int m_MarkerLength

the length of the markers in case of SimpleErrorPaintlet.PlotType.BAR.

Constructor Detail

SimpleErrorPaintlet

public SimpleErrorPaintlet()

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 AbstractStrokePaintlet

setPlotType

public void setPlotType(SimpleErrorPaintlet.PlotType value)

Sets the type of plot.

Parameters:

value - the type

getPlotType

public SimpleErrorPaintlet.PlotType getPlotType()

Returns the type of plot.

Returns:

the type

plotTypeTipText

public String plotTypeTipText()

Returns the tip text for this property.

Returns:

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

setMarkerLength

public void setMarkerLength(int value)

Sets the length of the markers in case of SimpleErrorPaintlet.PlotType.BAR.

Parameters:

value - the length in pixels

getMarkerLength

public int getMarkerLength()

Returns the length of the markers in case of SimpleErrorPaintlet.PlotType.BAR.

Returns:

the length in pixels

markerLengthTipText

public String markerLengthTipText()

Returns the tip text for this property.

Returns:

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

drawErrorLine

protected void drawErrorLine(Graphics g,
                             AxisPanel axisX,
                             AxisPanel axisY,
                             SequencePlotPoint point)

Draws a simple line representing the errors.

Parameters:

g - the graphics context

axisX - the X axis

axisY - the Y axis

point - the point to draw

drawErrorBar

protected void drawErrorBar(Graphics g,
                            AxisPanel axisX,
                            AxisPanel axisY,
                            SequencePlotPoint point)

Draws a bars representing the errors.

Parameters:

g - the graphics context

axisX - the X axis

axisY - the Y axis

point - the point to draw

drawErrorBox

protected void drawErrorBox(Graphics g,
                            AxisPanel axisX,
                            AxisPanel axisY,
                            SequencePlotPoint point)

Draws a box representing the errors.

Parameters:

g - the graphics context

axisX - the X axis

axisY - the Y axis

point - the point to draw

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