Package uk.ac.starlink.ttools.plot
Class ErrorMode
java.lang.Object
uk.ac.starlink.ttools.plot.ErrorMode
Enumeration class which describes, for each dimension, what is the
error reporting regime.
- Author:
- Mark Taylor
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Enumeration class which lists the distance quantities used by different error modes. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ErrorMode
Both lower and upper bounds specified independently.static final ErrorMode.Extent
Extent describing errors symmetrically lower and higher than the point value.static final ErrorMode
Lower error bound only.static final ErrorMode.Extent
Extent describing errors only lower than the point value.static final ErrorMode
No error bounds.static final ErrorMode
The same error value in both directions.static final ErrorMode
Upper error bound only.static final ErrorMode.Extent
Extent describing errors only higher than the point value. -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
Indicates whether an array of error modes represents drawing no error information at all.double
Returns a value between 0 and 1 which represents an example lower bound for this mode, for instance 1 if the bound is in use and 0 if not.double
Returns a value between 0 and 1 which represents an example upper bound for this mode, for instance 1 if the bound is in use and 0 if it is not.Returns the extent objects which characterise this mode.static ErrorMode[]
Returns a list of all the error bar options.toString()
-
Field Details
-
NONE
No error bounds. -
SYMMETRIC
The same error value in both directions. -
LOWER
Lower error bound only. -
UPPER
Upper error bound only. -
BOTH
Both lower and upper bounds specified independently. -
LOWER_EXTENT
Extent describing errors only lower than the point value. -
UPPER_EXTENT
Extent describing errors only higher than the point value. -
BOTH_EXTENT
Extent describing errors symmetrically lower and higher than the point value.
-
-
Method Details
-
getExtents
Returns the extent objects which characterise this mode.- Returns:
- extent array
-
getExampleLower
public double getExampleLower()Returns a value between 0 and 1 which represents an example lower bound for this mode, for instance 1 if the bound is in use and 0 if not.- Returns:
- exemplary lower bound
-
getExampleUpper
public double getExampleUpper()Returns a value between 0 and 1 which represents an example upper bound for this mode, for instance 1 if the bound is in use and 0 if it is not.- Returns:
- examplary upper bound
-
toString
-
getOptions
Returns a list of all the error bar options.- Returns:
- error bar count list
-
allBlank
Indicates whether an array of error modes represents drawing no error information at all.- Parameters:
modes
- list of error modes, one per dimension- Returns:
- true if none of the dimensions contains error information
-