public abstract class EnhancementFunction extends Function implements java.lang.Cloneable, java.io.Serializable
Note that since this class implements Cloneable
, all
concrete child classes must have a valid clone()
method.
Modifier and Type | Field and Description |
---|---|
protected double[] |
range
The enhancement range as [min, max].
|
protected boolean |
reverse
The enhancement reverse flag.
|
Modifier | Constructor and Description |
---|---|
protected |
EnhancementFunction(double[] range)
Creates an enhancement function with the specified range.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Creates and returns a copy of this object.
|
abstract java.lang.String |
describe()
Gets a description of the function.
|
boolean |
equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.
|
abstract double |
getInverse(double normValue)
Gets the inverse enhancement value.
|
double[] |
getRange()
Gets the enhancement range.
|
boolean |
getReverse()
Gets the enhancement reversal flag.
|
double |
getValue(double dataValue)
Gets the enhancement value.
|
void |
normalize(Statistics stats,
double units)
Sets the range based on statistical data.
|
protected void |
reset()
Resets the enhancement function.
|
void |
setRange(double[] range)
Sets the enhancement range.
|
void |
setReverse(boolean flag)
Sets the enhancement reversal flag.
|
evaluate, getEncoding, useEncoding
protected double[] range
protected boolean reverse
protected EnhancementFunction(double[] range)
range
- the enhancement range as [min, max].public boolean getReverse()
setReverse(boolean)
public java.lang.Object clone()
clone
in class java.lang.Object
public void setReverse(boolean flag)
public void setRange(double[] range)
range
- the enhancement range as [min, max].public abstract double getInverse(double normValue)
normValue
- the normalized data value.public double getValue(double dataValue)
dataValue
- the data value to convert.public void normalize(Statistics stats, double units)
stats
- the data statistics.units
- the number of standard deviation units above and
below the mean for the data range.DataVariable.getStatistics(double)
protected void reset()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public double[] getRange()
public abstract java.lang.String describe()