|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot.ErrorMode
public class ErrorMode
Enumeration class which describes, for each dimension, what is the error reporting regime.
Nested Class Summary | |
---|---|
static class |
ErrorMode.Extent
Enumeration class which lists the distance quantities used by different error modes. |
Field Summary | |
---|---|
static ErrorMode |
BOTH
Both lower and upper bounds specified independently. |
static ErrorMode.Extent |
BOTH_EXTENT
Extent describing errors symmetrically lower and higher than the point value. |
static ErrorMode |
LOWER
Lower error bound only. |
static ErrorMode.Extent |
LOWER_EXTENT
Extent describing errors only lower than the point value. |
static ErrorMode |
NONE
No error bounds. |
static ErrorMode |
SYMMETRIC
The same error value in both directions. |
static ErrorMode |
UPPER
Upper error bound only. |
static ErrorMode.Extent |
UPPER_EXTENT
Extent describing errors only higher than the point value. |
Method Summary | |
---|---|
static boolean |
allBlank(ErrorMode[] modes)
Indicates whether an array of error modes represents drawing no error information at all. |
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. |
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. |
ErrorMode.Extent[] |
getExtents()
Returns the extent objects which characterise this mode. |
static ErrorMode[] |
getOptions()
Returns a list of all the error bar options. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ErrorMode NONE
public static final ErrorMode SYMMETRIC
public static final ErrorMode LOWER
public static final ErrorMode UPPER
public static final ErrorMode BOTH
public static final ErrorMode.Extent LOWER_EXTENT
public static final ErrorMode.Extent UPPER_EXTENT
public static final ErrorMode.Extent BOTH_EXTENT
Method Detail |
---|
public ErrorMode.Extent[] getExtents()
public double getExampleLower()
public double getExampleUpper()
public String toString()
toString
in class Object
public static ErrorMode[] getOptions()
public static boolean allBlank(ErrorMode[] modes)
modes
- list of error modes, one per dimension
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |