| java.lang.Object
 org.geotools.coverage.processing.RangeSpecifier
| RangeSpecifier | | public class RangeSpecifier implements Serializable,Cloneable(Code) | | Argument type for
DefaultProcessor operations for specifying the range,
colors and units of a computation result.
RangeSpecifier are used for tuning the
Category object to be constructed. For example the
"GradientMagnitude" operation will produces new
GridCoverage2D with sample values ranging from 0 to some
maximal value which may be very different from the source
GridCoverage2D range. By
default, most
try to guess a raisonable range for output
values. This default behavior can be overridden with an explicit
RangeSpecifier argument.
All
RangeSpecifier 's properties are optional; it is up to processor's
to replace
null values by a default
one.
since:
2.2
version:
$Id: RangeSpecifier.java 23632 2006-12-29 22:13:51Z desruisseaux $
author:
Martin Desruisseaux org.geotools.coverage.grid ImageLayout GridCoverageLayout |
| Constructor Summary | |
| public | RangeSpecifier()
Constructs a default
RangeSpecifier with no value set. | | public | RangeSpecifier(NumberRange range)
Constructs a
RangeSpecifier initialised to the spécified range. | | public | RangeSpecifier(MathTransform1D transform)
Constructs a
RangeSpecifier initialised to the specified
"sample to geophysics" transform. |
| Method Summary | |
| public Object | clone()
Returns a clone of this object. | | public boolean | equals(Object object)
Compares this range specifier with the specified object for equality. | | public Color[] | getColors()
Returns the target colors, or
null if none. | | public NumberRange | getRange()
Returns the target range, or
null if none. | | public MathTransform1D | getSampleToGeophysics()
Returns the target "sample to geophysics" transform, or
null if none. | | public Unit | getUnit()
Returns the target range units, or
null if none. | | public int | hashCode()
Returns a hash code value for this range specifier. | | public void | setColors(Color[] colors)
Set the target colors to the specified value. | | public void | setRange(NumberRange range)
Set the target range to the specified values. | | public void | setSampleToGeophysics(MathTransform1D transform)
Set the target "sample to geophysics" transform to the specified value. | | public void | setUnit(Unit unit)
Set the target range units to the specified value. | | public String | toString()
Returns a string representation of this range specifier. |
| RangeSpecifier | | public RangeSpecifier()(Code) | | Constructs a default
RangeSpecifier with no value set.
|
| RangeSpecifier | | public RangeSpecifier(NumberRange range)(Code) | | Constructs a
RangeSpecifier initialised to the spécified range.
|
| RangeSpecifier | | public RangeSpecifier(MathTransform1D transform)(Code) | | Constructs a
RangeSpecifier initialised to the specified
"sample to geophysics" transform.
|
| clone | | public Object clone()(Code) | | Returns a clone of this object.
|
| equals | | public boolean equals(Object object)(Code) | | Compares this range specifier with the specified object for equality.
|
| getColors | | public Color[] getColors()(Code) | | Returns the target colors, or
null if none.
|
| getRange | | public NumberRange getRange()(Code) | | Returns the target range, or
null if none.
|
| getSampleToGeophysics | | public MathTransform1D getSampleToGeophysics()(Code) | | Returns the target "sample to geophysics" transform, or
null if none.
|
| getUnit | | public Unit getUnit()(Code) | | Returns the target range units, or
null if none.
|
| hashCode | | public int hashCode()(Code) | | Returns a hash code value for this range specifier.
|
| setColors | | public void setColors(Color[] colors)(Code) | | Set the target colors to the specified value.
|
| setRange | | public void setRange(NumberRange range)(Code) | | Set the target range to the specified values. Setting this property will clear
the
, since
those properties are mutually exclusive.
Parameters:
range - The target range. |
| setSampleToGeophysics | | public void setSampleToGeophysics(MathTransform1D transform)(Code) | | Set the target "sample to geophysics" transform to the specified value.
Setting this property will clear the
property,
since those properties are mutually exclusive.
|
| setUnit | | public void setUnit(Unit unit)(Code) | | Set the target range units to the specified value.
|
| toString | | public String toString()(Code) | | Returns a string representation of this range specifier.
|
|
|