|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.AuxScale
public class AuxScale
Represents a ranged value that can differ according to the content of a plot. To calculate the range of an AuxScale it is not necessary to have detailed information about the geometry of the plot surface (the Surface object required for final plotting). That means it is not required to generate the actual plot surface geometry. However, an approximate plot surface may be required for range calculations.
Field Summary | |
---|---|
static AuxScale |
COLOR
AuxRange object used for the standard colour scaling axis. |
Constructor Summary | |
---|---|
AuxScale(String name)
Constructor. |
Method Summary | |
---|---|
static Map<AuxScale,Range> |
calculateAuxRanges(AuxScale[] scales,
PlotLayer[] layers,
Surface surface,
DataStore dataStore)
Fills in range information for a submitted list of AuxScale objects from the data in a given list of layers. |
static Range |
clipRange(Range dataRange,
Range fixRange,
Subrange subrange,
boolean isLog)
Amalgamates range requirements for a single scale to return the actual range to use. |
static AuxScale[] |
getAuxScales(PlotLayer[] layers)
Utility method to acquire all the scales that are used in an array of layers. |
static Map<AuxScale,Range> |
getClippedRanges(AuxScale[] scales,
Map<AuxScale,Range> dataRanges,
Map<AuxScale,Range> fixRanges,
Map<AuxScale,Subrange> subranges,
Map<AuxScale,Boolean> logFlags)
Amalgamates range requirements for a set of scales to return actual ranges to be used. |
static AuxScale[] |
getMissingScales(AuxScale[] reqScales,
Map<AuxScale,Range> dataRanges,
Map<AuxScale,Range> fixRanges)
Returns a list of scale objects for which calculations are required. |
String |
getName()
Returns the scale name. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static AuxScale COLOR
Constructor Detail |
---|
public AuxScale(String name)
name
- scale name for human consumptionMethod Detail |
---|
public String getName()
public String toString()
toString
in class Object
public static AuxScale[] getAuxScales(PlotLayer[] layers)
layers
- layers that may reference scales
public static Map<AuxScale,Range> calculateAuxRanges(AuxScale[] scales, PlotLayer[] layers, Surface surface, DataStore dataStore)
scales
- scales to calculate ranges forlayers
- plot layerssurface
- approximate plot surfacedataStore
- data repository
scales
public static Map<AuxScale,Range> getClippedRanges(AuxScale[] scales, Map<AuxScale,Range> dataRanges, Map<AuxScale,Range> fixRanges, Map<AuxScale,Subrange> subranges, Map<AuxScale,Boolean> logFlags)
scales
- list of scales for which output ranges are requireddataRanges
- actual data ranges acquired by scanning the data,
keyed by scale (optional per scale)fixRanges
- single- or double-ended fixed data ranges,
keyed by scale (optional per scale)subranges
- subrange keyed by scale; optional per scale,
if absent 0-1 is assumedlogFlags
- flags indicating logarithmic scale; optional
per scale, absent equivalent to false indicates
linear scaling
public static Range clipRange(Range dataRange, Range fixRange, Subrange subrange, boolean isLog)
dataRange
- actual data range acquired by scanning the data,
or nullfixRange
- single- or double-ended fixed data range, or nullsubrange
- subrange, if null 0-1 is assumedisLog
- true for logarithmic scale, false for linear
public static AuxScale[] getMissingScales(AuxScale[] reqScales, Map<AuxScale,Range> dataRanges, Map<AuxScale,Range> fixRanges)
getClippedRanges(uk.ac.starlink.ttools.plot2.AuxScale[], java.util.Map, java.util.Map, java.util.Map, java.util.Map)
method, is returned.
reqScales
- scales neededdataRanges
- ranges acquired by scanning data keyed by scale,
(optional per scale)fixRanges
- single- or double-ended fixed data ranges,
keyed by scale (optional per scale)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |