public class AuxScale
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static AuxScale |
COLOR
AuxRange object used for the standard colour scaling axis.
|
Constructor and Description |
---|
AuxScale(java.lang.String name)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static java.util.Map<AuxScale,Range> |
calculateAuxRanges(AuxScale[] scales,
PlotLayer[] layers,
Surface surface,
java.lang.Object[] knownPlans,
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 java.util.Map<AuxScale,Range> |
getClippedRanges(AuxScale[] scales,
java.util.Map<AuxScale,Range> dataRanges,
java.util.Map<AuxScale,Range> fixRanges,
java.util.Map<AuxScale,Subrange> subranges,
java.util.Map<AuxScale,java.lang.Boolean> logFlags)
Amalgamates range requirements for a set of scales to return
actual ranges to be used.
|
static AuxScale[] |
getMissingScales(AuxScale[] reqScales,
java.util.Map<AuxScale,Range> dataRanges,
java.util.Map<AuxScale,Range> fixRanges)
Returns a list of scale objects for which calculations are required.
|
java.lang.String |
getName()
Returns the scale name.
|
java.lang.String |
toString() |
public static AuxScale COLOR
public AuxScale(java.lang.String name)
name
- scale name for human consumptionpublic java.lang.String getName()
public java.lang.String toString()
toString
in class java.lang.Object
public static AuxScale[] getAuxScales(PlotLayer[] layers)
layers
- layers that may reference scalespublic static java.util.Map<AuxScale,Range> calculateAuxRanges(AuxScale[] scales, PlotLayer[] layers, Surface surface, java.lang.Object[] knownPlans, DataStore dataStore)
scales
- scales to calculate ranges forlayers
- plot layerssurface
- approximate plot surfaceknownPlans
- array of available plan objects; may be emptydataStore
- data repositoryscales
public static java.util.Map<AuxScale,Range> getClippedRanges(AuxScale[] scales, java.util.Map<AuxScale,Range> dataRanges, java.util.Map<AuxScale,Range> fixRanges, java.util.Map<AuxScale,Subrange> subranges, java.util.Map<AuxScale,java.lang.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 scalingpublic 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 linearpublic static AuxScale[] getMissingScales(AuxScale[] reqScales, java.util.Map<AuxScale,Range> dataRanges, java.util.Map<AuxScale,Range> fixRanges)
getClippedRanges(uk.ac.starlink.ttools.plot2.AuxScale[], java.util.Map<uk.ac.starlink.ttools.plot2.AuxScale, uk.ac.starlink.ttools.plot.Range>, java.util.Map<uk.ac.starlink.ttools.plot2.AuxScale, uk.ac.starlink.ttools.plot.Range>, java.util.Map<uk.ac.starlink.ttools.plot2.AuxScale, uk.ac.starlink.ttools.plot2.Subrange>, java.util.Map<uk.ac.starlink.ttools.plot2.AuxScale, java.lang.Boolean>)
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)Copyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.