public class TransferFunction extends Object implements Cloneable, Serializable
Type | Equation |
---|---|
LINEAR |
y = scale⋅x + offset |
LOGARITHMIC |
y = scale⋅logbase(x) + offset |
EXPONENTIAL |
y = scale⋅basex + offset |
TransferFunction
class handles only the continuous part of transfer functions.
This class does not handle missing values other than NaN
.
For a more complete class with support for non-NaN missing values,
see org.apache.sis.coverage.grid.GridSampleDimension
.
Defined in the sis-referencing
module
Constructor and Description |
---|
TransferFunction()
Creates a transfer function initialized to the identity transform.
|
Modifier and Type | Method and Description |
---|---|
double |
getBase()
Returns the logarithm or exponent base in the transfer function.
|
double |
getOffset()
Returns the offset of the transfer function.
|
double |
getScale()
Returns the scale factor of the transfer function.
|
MathTransform1D |
getTransform()
Returns the transform from sample values to geophysics values, as specified by the
current properties of this
TransferFunction . |
TransferFunctionType |
getType()
Returns the transfer function type (linear, logarithmic or exponential).
|
void |
setBase(double base)
Sets the logarithm or exponent base in the transfer function.
|
void |
setOffset(double offset)
Sets the offset of the transfer function.
|
void |
setScale(double scale)
Sets the scale factor of the transfer function.
|
void |
setTransform(MathTransform1D function)
Sets the transform from sample values to geophysics values.
|
void |
setType(TransferFunctionType type)
Sets the transfer function type.
|
String |
toString()
Returns a string representation of this transfer function for debugging purpose.
|
public TransferFunction()
public TransferFunctionType getType()
public void setType(TransferFunctionType type)
TransferFunctionType.LINEAR
.type
- The transfer function type.public double getBase()
TransferFunctionType.LINEAR
,
and usually (but not necessarily) 10 for the logarithmic and exponential types.public void setBase(double base)
TransferFunctionType.LINEAR
.
For other supported types, the default value is 10.base
- The new logarithm or exponent base.public double getScale()
public void setScale(double scale)
scale
- The new scale factor.public double getOffset()
public void setOffset(double offset)
offset
- The new offset.public MathTransform1D getTransform()
TransferFunction
.public void setTransform(MathTransform1D function) throws IllegalArgumentException
function
- The transform to set.IllegalArgumentException
- if this method does not recognize the given transform.Copyright © 2010–2015 The Apache Software Foundation. All rights reserved.