org.geotools.coverage.processing
Class RangeSpecifier

java.lang.Object
  org.geotools.coverage.processing.RangeSpecifier

All Implemented Interfaces:

java.lang.Cloneable, org.opengis.util.Cloneable, java.io.Serializable

public class RangeSpecifier

extends java.lang.Object

implements java.io.Serializable, org.opengis.util.Cloneable

Argument type for DefaultProcessor operations for specifying the range, colors and units of a computation result. are used for tuning the Category object to be constructed. For example the 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 operations try to guess a raisonable range for output values. This default behavior can be overriden with an explicit argument.

All 's properties are optional; it is up to processor's operation to replace values by a default one.

Since:

2.2

Version:

$Id: RangeSpecifier.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

To Do:

Move into the package as a subclass. Rename as .

Constructor Summary

RangeSpecifier()
Constructs a default with no value set.

RangeSpecifier(org.opengis.referencing.operation.MathTransform1D transform)
Constructs a initialised to the specified "sample to geophysics" transform.

RangeSpecifier(NumberRange range)
Constructs a initialised to the sp?cified range.

Method Summary

java.lang.Object	clone() Returns a clone of this object.
boolean	equals(java.lang.Object object) Compares this range specifier with the specified object for equality.
java.awt.Color[]	getColors() Returns the target colors, or if none.
NumberRange	getRange() Returns the target range, or if none.
org.opengis.referencing.operation.MathTransform1D	getSampleToGeophysics() Returns the target "sample to geophysics" transform, or if none.
javax.units.Unit	getUnit() Returns the target range units, or if none.
int	hashCode() Returns a hash code value for this range specifier.
void	setColors(java.awt.Color[] colors) Set the target colors to the specified value.
void	setRange(NumberRange range) Set the target range to the specified values.
void	setSampleToGeophysics(org.opengis.referencing.operation.MathTransform1D transform) Set the target "sample to geophysics" transform to the specified value.
void	setUnit(javax.units.Unit unit) Set the target range units to the specified value.
java.lang.String	toString() Returns a string representation of this range specifier.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RangeSpecifier

public RangeSpecifier()

Constructs a default with no value set.

RangeSpecifier

public RangeSpecifier(NumberRange range)

Constructs a initialised to the sp?cified range.

RangeSpecifier

public RangeSpecifier(org.opengis.referencing.operation.MathTransform1D transform)

Constructs a initialised to the specified "sample to geophysics" transform.

Method Detail

getRange

public NumberRange getRange()

Returns the target range, or if none.

setRange

public void setRange(NumberRange range)

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

public org.opengis.referencing.operation.MathTransform1D getSampleToGeophysics()

Returns the target "sample to geophysics" transform, or if none.

setSampleToGeophysics

public void setSampleToGeophysics(org.opengis.referencing.operation.MathTransform1D transform)

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.

getUnit

public javax.units.Unit getUnit()

Returns the target range units, or if none.

setUnit

public void setUnit(javax.units.Unit unit)

Set the target range units to the specified value.

getColors

public java.awt.Color[] getColors()

Returns the target colors, or if none.

setColors

public void setColors(java.awt.Color[] colors)

Set the target colors to the specified value.

clone

public java.lang.Object clone()

Returns a clone of this object.

Specified by:

clone in interface org.opengis.util.Cloneable

hashCode

public int hashCode()

Returns a hash code value for this range specifier.

equals

public boolean equals(java.lang.Object object)

Compares this range specifier with the specified object for equality.

toString

public java.lang.String toString()

Returns a string representation of this range specifier.