Package adams.flow.sink.sequenceplotter

Class ErrorCrossPaintlet

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

adams.gui.visualization.sequence.CrossPaintlet

adams.flow.sink.sequenceplotter.ErrorCrossPaintlet

All Implemented Interfaces:

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

public class ErrorCrossPaintlet
extends CrossPaintlet

Paintlet for painting crosses with diameters based on the error at the specified X-Y position. Prefers X errors over Y errors.

-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
 

-diameter <int> (property: diameter)
    The diameter of the cross in pixels.
    default: 7
    minimum: 1
 

-anti-aliasing-enabled <boolean> (property: antiAliasingEnabled)
    If enabled, uses anti-aliasing for drawing the crosses.
    default: true
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

m_AntiAliasingEnabled, m_Diameter

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

m_MetaDataColor

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

Method Summary

Modifier and Type	Method	Description
void	drawCustomData(Graphics g, PaintEvent.PaintMoment moment, XYSequence data, Color color)	Draws the custom data with the given color.
int	getDiameter(XYSequencePoint curr)	Calculates the diameter for the given point (slow call).
int	getDiameter(AxisPanel axisX, AxisPanel axisY, double currX, double currY, XYSequencePoint curr)	Calculates the diameter for the given point (fast call).
int	getDiameter(AxisPanel axisX, AxisPanel axisY, XYSequencePoint curr)	Calculates the diameter for the given point (medium fast call).
String	globalInfo()	Returns a string describing the object.
AbstractXYSequencePointHitDetector	newHitDetector()	Returns a new instance of the hit detector to use.
void	performPaint(Graphics g, PaintEvent.PaintMoment moment)	The paint routine of the paintlet.

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

antiAliasingEnabledTipText, defineOptions, diameterTipText, doDrawCustomData, doPerformPaint, getDiameter, isAntiAliasingEnabled, setAntiAliasingEnabled, setDiameter, supportsPointPreprocessor

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

getMetaDataColor, metaDataColorTipText, setMetaDataColor

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

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

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

applyStroke, getStrokeThickness, getStrokeWidth, 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, getPaintMoment, getPanel, getPlot, getRepaintOnChange, hasPanel, isEnabled, paint, setEnabled, setPanel, setPanel, setRepaintOnChange

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

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

getSequencePanel

Constructor Detail

ErrorCrossPaintlet

public ErrorCrossPaintlet()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class CrossPaintlet

Returns:

a description suitable for displaying in the gui

newHitDetector

public AbstractXYSequencePointHitDetector newHitDetector()

Returns a new instance of the hit detector to use.

Specified by:

newHitDetector in interface XYSequencePaintlet

Overrides:

newHitDetector in class CrossPaintlet

Returns:

the hit detector

drawCustomData

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

Draws the custom data with the given color.

Specified by:

drawCustomData in interface PaintletWithCustomDataSupport

Overrides:

drawCustomData in class CrossPaintlet

Parameters:

g - the graphics context

moment - the paint moment

data - the data to draw

color - the color to draw in

getDiameter

public int getDiameter(XYSequencePoint curr)

Calculates the diameter for the given point (slow call).

Parameters:

curr - the current point

Returns:

the diameter in pixel

getDiameter

public int getDiameter(AxisPanel axisX,
                       AxisPanel axisY,
                       XYSequencePoint curr)

Calculates the diameter for the given point (medium fast call).

Parameters:

axisX - the X axis to use

axisY - the Y axis to use

curr - the current point

Returns:

the diameter in pixel

getDiameter

public int getDiameter(AxisPanel axisX,
                       AxisPanel axisY,
                       double currX,
                       double currY,
                       XYSequencePoint curr)

Calculates the diameter for the given point (fast call).

Parameters:

axisX - the X axis to use

axisY - the Y axis to use

currX - the current X value

currY - the current Y value

curr - the current point

Returns:

the diameter in pixel

performPaint

public void performPaint(Graphics g,
                         PaintEvent.PaintMoment moment)

The paint routine of the paintlet.

Specified by:

performPaint in interface Paintlet

Overrides:

performPaint in class AbstractStrokePaintlet

Parameters:

g - the graphics context to use for painting

moment - what PaintEvent.PaintMoment is currently being painted