Package org.geotools.coverage.processing
Class RangeSpecifier
Object
RangeSpecifier
- All Implemented Interfaces:
Serializable
,Cloneable
,Cloneable
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. By default, most operations 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 operation
to replace null
values by a default one.
- Since:
- 2.2
- Author:
- Martin Desruisseaux (IRD)
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a defaultRangeSpecifier
with no value set.RangeSpecifier
(MathTransform1D transform) Constructs aRangeSpecifier
initialised to the specified "sample to geophysics" transform.RangeSpecifier
(NumberRange<?> range) Constructs aRangeSpecifier
initialised to the spécified range. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a clone of this object.boolean
Compares this range specifier with the specified object for equality.Color[]
Returns the target colors, ornull
if none.NumberRange<?>
getRange()
Returns the target range, ornull
if none.Returns the target "sample to geophysics" transform, ornull
if none.Unit<?>
getUnit()
Returns the target range units, ornull
if none.int
hashCode()
Returns a hash code value for this range specifier.void
Set the target colors to the specified value.void
setRange
(NumberRange<?> range) Set the target range to the specified values.void
setSampleToGeophysics
(MathTransform1D transform) Set the target "sample to geophysics" transform to the specified value.void
setUnit
(Unit<?> unit) Set the target range units to the specified value.toString()
Returns a string representation of this range specifier.
-
Constructor Details
-
RangeSpecifier
public RangeSpecifier()Constructs a defaultRangeSpecifier
with no value set. -
RangeSpecifier
Constructs aRangeSpecifier
initialised to the spécified range.- Parameters:
range
- The range
-
RangeSpecifier
Constructs aRangeSpecifier
initialised to the specified "sample to geophysics" transform.- Parameters:
transform
- The sample to geophysics transform.
-
-
Method Details
-
getRange
Returns the target range, ornull
if none.- Returns:
- The range
-
setRange
Set the target range to the specified values. Setting this property will clear the sample to geophysics transform, since those properties are mutually exclusive.- Parameters:
range
- The target range.
-
getSampleToGeophysics
Returns the target "sample to geophysics" transform, ornull
if none.- Returns:
- The current sample to geophysics transform.
-
setSampleToGeophysics
Set the target "sample to geophysics" transform to the specified value. Setting this property will clear the range property, since those properties are mutually exclusive.- Parameters:
transform
- The new sample to geophysics transform.
-
getUnit
public Unit<?> getUnit()Returns the target range units, ornull
if none.- Returns:
- The current units.
-
setUnit
public void setUnit(Unit<?> unit) Set the target range units to the specified value.- Parameters:
unit
- The new units.
-
getColors
Returns the target colors, ornull
if none.- Returns:
- The current colors.
-
setColors
Set the target colors to the specified value.- Parameters:
colors
- The new colors.
-
clone
Returns a clone of this object. -
hashCode
public int hashCode()Returns a hash code value for this range specifier. -
equals
Compares this range specifier with the specified object for equality. -
toString
Returns a string representation of this range specifier.
-