Class ErrorBarPolicyRelative
- All Implemented Interfaces:
IErrorBarPolicy<AErrorBarPolicyConfigurable>
,IPointPainter<AErrorBarPolicyConfigurable>
,ITracePainter<AErrorBarPolicyConfigurable>
,PropertyChangeListener
,Serializable
,Comparable<AErrorBarPolicyConfigurable>
,EventListener
IErrorBarPolicy
that adds a relative error (relative to the absolute values) to the points to
render.
You should not use this if you have a small value range but very high values: The relative value will cause exteremely long lines (be much higher than the value range to display) and fold the trace to a minimum line.
- Version:
- $Revision: 1.23 $
- Author:
- Achim Westermann
- See Also:
-
Field Summary
Fields inherited from class info.monitorenter.gui.chart.errorbars.AErrorBarPolicyConfigurable
m_lastPoint, m_lastX, m_lastY, m_propertyChangeSupport
Fields inherited from interface info.monitorenter.gui.chart.IErrorBarPolicy
PROPERTY_CONFIGURATION, PROPERTY_ERRORBARPAINTER
-
Constructor Summary
ConstructorsConstructorDescriptionErrorBarPolicyRelative
(double relativeError) Creates an instance with the given relative errors.ErrorBarPolicyRelative
(double relativeXError, double relativeYError) Creates an instance with the given relative errors. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Allows an implementation to return aJComponent
that takes care of custom configuration properties for the UI support of error bar policies.final double
Returns the relative x error between 0 and 1.final double
Returns the relative y error between 0 and 1.final double
getXError
(double xValue) Returns the relative x error (value domain) that is added to / subtracted from the values to display.final double
getYError
(double yValue) Returns the relative y error (value domain) that is added to / subtracted from the values to display.int
hashCode()
protected int
internalGetNegativeXError
(int xPixel, int yPixel, ITracePoint2D original) Internally compute the negative x error for the given point as a pixel value (not relative to the the origin value).protected int
internalGetNegativeYError
(int xPixel, int yPixel, ITracePoint2D original) Internally compute the negative y error for the given point as a pixel value (not relative to the the origin value).protected int
internalGetPositiveXError
(int xPixel, int yPixel, ITracePoint2D original) Internally compute the positive x error in pixel for the given point as an absolute value (not relative to the the origin value).protected int
internalGetPositiveYError
(int xPixel, int yPixel, ITracePoint2D original) Internally compute the positive y error in pixel for the given point as an absolute value (not relative to the the origin value).final void
setRelativeXError
(double relativeXError) Sets the relative X error to add to each error bar.final void
setRelativeYError
(double relativeYError) Sets the relative Y error to add to each error bar.Methods inherited from class info.monitorenter.gui.chart.errorbars.AErrorBarPolicyConfigurable
addErrorBarPainter, addPropertyChangeListener, calculateErrorBar, compareTo, discontinue, endPaintIteration, firePropertyChange, getErrorBarPainters, getTrace, isShowNegativeXErrors, isShowNegativeYErrors, isShowPositiveXErrors, isShowPositiveYErrors, paintPoint, propertyChange, removeErrorBarPainter, removePropertyChangeListener, removePropertyChangeListener, setErrorBarPainter, setShowNegativeXErrors, setShowNegativeYErrors, setShowPositiveXErrors, setShowPositiveYErrors, setTrace, startPaintIteration
-
Constructor Details
-
ErrorBarPolicyRelative
Creates an instance with the given relative errors.The relative error is related to the absolut x and y values to render. It has to be between 0.0 and 1.0.
- Parameters:
relativeError
- the relative error value between 0.0 and 1.0 for x and y dimension.- Throws:
IllegalArgumentException
- if the argument is not between 0.0 and 1.0.- See Also:
-
ErrorBarPolicyRelative
public ErrorBarPolicyRelative(double relativeXError, double relativeYError) throws IllegalArgumentException Creates an instance with the given relative errors.The relative error is related to the absolut x and y values to render. It has to be between 0.0 and 1.0.
- Parameters:
relativeXError
- the relative x error value between 0.0 and 1.0.relativeYError
- the relative y error value between 0.0 and 1.0.- Throws:
IllegalArgumentException
- if the argument is not between 0.0 and 1.0.
-
-
Method Details
-
equals
- Overrides:
equals
in classAErrorBarPolicyConfigurable
- See Also:
-
getCustomConfigurator
Description copied from interface:IErrorBarPolicy
Allows an implementation to return aJComponent
that takes care of custom configuration properties for the UI support of error bar policies.Returns a
JComponent
that - stand alone - takes care of configuring custom properties or null if nothing is required. This will be integrated in the error bar wizard UI of jchart2d.- Specified by:
getCustomConfigurator
in interfaceIErrorBarPolicy<AErrorBarPolicyConfigurable>
- Overrides:
getCustomConfigurator
in classAErrorBarPolicyConfigurable
- Returns:
- a
JComponent
that - stand alone - takes care of configuring custom properties or null if nothing is required. - See Also:
-
getRelativeXError
public final double getRelativeXError()Returns the relative x error between 0 and 1.- Returns:
- the relative x error.
-
getRelativeYError
public final double getRelativeYError()Returns the relative y error between 0 and 1.- Returns:
- the relative y Error.
-
getXError
public final double getXError(double xValue) Description copied from interface:IErrorBarPolicy
Returns the relative x error (value domain) that is added to / subtracted from the values to display.- Parameters:
xValue
- the absolute x value (not pixel) to get the error for.- Returns:
- the relative x error in value domain that is added to / subtracted from the values to display.
- See Also:
-
getYError
public final double getYError(double yValue) Description copied from interface:IErrorBarPolicy
Returns the relative y error (value domain) that is added to / subtracted from the values to display.- Parameters:
yValue
- the absolute y value (not pixel) to get the error for.- Returns:
- the relative y error in value domain that is added to / subtracted from the values to display.
- See Also:
-
hashCode
public int hashCode()- Overrides:
hashCode
in classAErrorBarPolicyConfigurable
- See Also:
-
internalGetNegativeXError
Description copied from class:AErrorBarPolicyConfigurable
Internally compute the negative x error for the given point as a pixel value (not relative to the the origin value).- Specified by:
internalGetNegativeXError
in classAErrorBarPolicyConfigurable
- Parameters:
xPixel
- the x value in pixel for the error to render.yPixel
- the y value in pixel for the error to render.original
- the original point, possibly useful for calculations.- Returns:
- the negative x error in pixel for the given point as an absolute value (not relative to the the origin value).
- See Also:
-
internalGetNegativeYError
Description copied from class:AErrorBarPolicyConfigurable
Internally compute the negative y error for the given point as a pixel value (not relative to the the origin value).- Specified by:
internalGetNegativeYError
in classAErrorBarPolicyConfigurable
- Parameters:
xPixel
- the x value in pixel for the error to render.yPixel
- the y value in pixel for the error to render.original
- the original point, possibly useful for calculations.- Returns:
- the negative y error in pixel for the given point as an absolute value (not relative to the the origin value).
- See Also:
-
internalGetPositiveXError
Description copied from class:AErrorBarPolicyConfigurable
Internally compute the positive x error in pixel for the given point as an absolute value (not relative to the the origin value).- Specified by:
internalGetPositiveXError
in classAErrorBarPolicyConfigurable
- Parameters:
xPixel
- the x value in pixel for the error to render.yPixel
- the y value in pixel for the error to render.original
- the original point, possibly useful for calculations.- Returns:
- the positive x error in pixel for the given point as an absolute value (not relative to the the origin value).
- See Also:
-
internalGetPositiveYError
Description copied from class:AErrorBarPolicyConfigurable
Internally compute the positive y error in pixel for the given point as an absolute value (not relative to the the origin value).- Specified by:
internalGetPositiveYError
in classAErrorBarPolicyConfigurable
- Parameters:
xPixel
- the x coordinate in pixel for the error to render.yPixel
- the y coordinate in pixel for the error to render.original
- the original point, possibly useful for calculations.- Returns:
- the positive y error in pixel for the given point as an absolute value (not relative to the the origin value).
- See Also:
-
setRelativeXError
Sets the relative X error to add to each error bar.The relative error is related to the absolute x values to render. It has to be between 0.0 and 1.0.
- Parameters:
relativeXError
- a value between 0.0 and 1.0.- Throws:
IllegalArgumentException
- if the argument is not between 0.0 and 1.0.
-
setRelativeYError
Sets the relative Y error to add to each error bar.The relative error is related to the absolut y values to render. It has to be between 0.0 and 1.0.
- Parameters:
relativeYError
- a value between 0.0 and 1.0.- Throws:
IllegalArgumentException
- if the argument is not between 0.0 and 1.0.
-