|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectGridCoverageBuilder.Variable
public class GridCoverageBuilder.Variable
A variable to be mapped to a sample dimension.
Variables are created by GridCoverageBuilder.newVariable(java.lang.CharSequence, javax.measure.unit.Unit>)
.
Constructor Summary | |
---|---|
protected |
GridCoverageBuilder.Variable(CharSequence name,
Unit<?> units)
Creates a new variable of the given name and units. |
Method Summary | |
---|---|
void |
addNodataValue(CharSequence name,
int value)
Adds a "nodata" value. |
GridSampleDimension |
getSampleDimension()
Returns a sample dimension for the current range of sample values. |
MathTransform1D |
getTransform()
Returns the "sample to geophysics" transform, or null if none. |
void |
setLinearTransform(double scale,
double offset)
Sets the "sample to geophysics" transform from a scale and an offset. |
void |
setLogarithmicTransform(double base,
double offset)
Sets the "sample to geophysics" logarithmic transform from a scale and an offset. |
void |
setTransform(MathTransform1D transform)
Sets the "sample to geophysics" transform. |
String |
toString()
Returns a string representation of this variable. |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected GridCoverageBuilder.Variable(CharSequence name, Unit<?> units)
name
- The variable name, or null
for a default name.units
- The variable units, or null
if unknown.GridCoverageBuilder.newVariable(java.lang.CharSequence, javax.measure.unit.Unit>)
Method Detail |
---|
public MathTransform1D getTransform()
null
if none.
public void setTransform(MathTransform1D transform)
public void setLinearTransform(double scale, double offset)
geophysics =scale
× sample +offset
scale
- The scale
term in the linear equation.offset
- The offset
term in the linear equation.public void setLogarithmicTransform(double base, double offset)
geophysics = logbase
(sample) +offset
base
- The base of the logarithm (typically 10).offset
- The offset to add to the logarithm.public void addNodataValue(CharSequence name, int value) throws IllegalArgumentException
name
- The name for the "nodata" value.value
- The pixel value to assign to "nodata".
IllegalArgumentException
- if the given pixel value is already assigned.public GridSampleDimension getSampleDimension()
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |