@Equality public abstract class Scaling extends java.lang.Object
Modifier and Type | Field | Description |
---|---|---|
static Scaling |
AUTO |
Asinh-based scaling with default parameters.
|
static Scaling |
LINEAR |
Linear scaling.
|
static Scaling |
LOG |
Logarithmic scaling.
|
static Scaling |
SQRT |
Square root scaling.
|
static Scaling |
SQUARE |
Square scaling.
|
Modifier | Constructor | Description |
---|---|---|
protected |
Scaling(java.lang.String name,
java.lang.String description,
boolean isLogLike) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
static Scaling |
createAsinhScaling(java.lang.String name,
double delta) |
Constructs an asinh-based scaling.
|
static Scaler |
createRangeScaler(Scaling scaling,
Range range) |
Utility method to return a scaler based on a Range object.
|
abstract Scaler |
createScaler(double lo,
double hi) |
Returns a scaler instance that can scale input values in a given range.
|
java.lang.String |
getDescription() |
Returns a short description of this scaling.
|
java.lang.String |
getName() |
Returns the name of this scaling.
|
static Scaling[] |
getStretchOptions() |
Returns a list of standard options for colour map stretch.
|
boolean |
isLogLike() |
Indicates whether this scaling is logarithmic.
|
static Scaling |
subrangeScaling(Scaling scaling,
Subrange subrange) |
Adjusts a scaling by applying a fractional subrange to the
scaler inputs before scaling is applied,
so that the input range is subranged, rather than the output range.
|
java.lang.String |
toString() |
public static final Scaling LINEAR
public static final Scaling LOG
public static final Scaling SQRT
public static final Scaling SQUARE
public static final Scaling AUTO
protected Scaling(java.lang.String name, java.lang.String description, boolean isLogLike)
name
- scaling namedescription
- short description of scaling ruleisLogLike
- whether the scaling is logarithmic,
for instance should be displayed on a log axispublic java.lang.String getName()
public java.lang.String getDescription()
public boolean isLogLike()
public abstract Scaler createScaler(double lo, double hi)
s
:
s.scaleValue(x) == s.scaleValue(lo) for x<lo s.scaleValue(x) == s.scaleValue(hi) for x>hi
lo
- lower bound of unclipped input data valuehi
- upper bound of unclipped input data valuepublic java.lang.String toString()
toString
in class java.lang.Object
public static final Scaling[] getStretchOptions()
public static Scaling subrangeScaling(Scaling scaling, Subrange subrange)
scaling
- base scalingsubrange
- fractional subrange to apply to input valuespublic static Scaler createRangeScaler(Scaling scaling, Range range)
scaling
- scalingrange
- value rangepublic static Scaling createAsinhScaling(java.lang.String name, double delta)
name
- scaling namedelta
- output difference for lower-end input unit differenceCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.