| java.lang.Object
 org.geotools.image.io.metadata.MetadataAccessor
org.geotools.image.io.metadata.Band
| Band | | public class Band extends MetadataAccessor (Code) | | A
element in
.
since:
2.4
version:
$Id: Band.java 27583 2007-10-23 11:29:26Z desruisseaux $
author:
Martin Desruisseaux
See Also: org.opengis.coverage.SampleDimension |
| Method Summary | |
| public String | getName()
Returns the name for this band, or
null if none. | | public double[] | getNoDataValues()
Returns the fill values for this band, or
null if none. | | public double | getOffset()
Returns the offset from packed to geophysics values, or
0 if none. | | public double | getScale()
Returns the scale factor from packed to geophysics values, or
1 if none. | | public NumberRange | getValidRange()
Returns the range of valid values for this band. | | public void | setName(String name)
Sets the name for this band. | | public void | setNoDataValues(double[] fillValues)
Sets the fill values for this band. | | public void | setOffset(double offset)
Sets the offset for this band. | | public void | setPackedValues(double minValue, double maxValue, double[] fillValues, int dataType)
Defines valid and fill packed values as a combinaison of
(minValue, maxValue)
and {linkplain #setNoDataValues(double[]) setNoDataValues}(fillValues). | | public void | setScale(double scale)
Sets the scale factor for this band. | | public void | setValidRange(double minValue, double maxValue)
Sets the range of valid values. |
| Band | | protected Band(GeographicMetadata metadata, int bandIndex)(Code) | | Creates a parser for a band. This constructor should not be invoked
directly; use
GeographicMetadata.getBand instead.
Parameters:
metadata - The metadata which contains this band.
Parameters:
bandIndex - The band index for this instance. |
| Band | | Band(ChildList parent, int bandIndex)(Code) | | Creates a parser for a band. This constructor should not be invoked
directly; use
GeographicMetadata.getBand instead.
Parameters:
parent - The set of all bands.
Parameters:
bandIndex - The band index for this instance. |
| getName | | public String getName()(Code) | | Returns the name for this band, or
null if none.
|
| getNoDataValues | | public double[] getNoDataValues()(Code) | | Returns the fill values for this band, or
null if none.
|
| getOffset | | public double getOffset()(Code) | | Returns the offset from packed to geophysics values, or
0 if none.
|
| getScale | | public double getScale()(Code) | | Returns the scale factor from packed to geophysics values, or
1 if none.
|
| getValidRange | | public NumberRange getValidRange()(Code) | | Returns the range of valid values for this band. The range use the
Integer type if possible, or the
Double type otherwise. Note that range
,
or both may be null if no
"minValue" or
"maxValue" attribute were found for the
"SampleDimensions/SampleDimension" element.
|
| setName | | public void setName(String name)(Code) | | Sets the name for this band.
Parameters:
name - The band name, or null if none. |
| setNoDataValues | | public void setNoDataValues(double[] fillValues)(Code) | | Sets the fill values for this band. This method formats all fill values as integers
if possible, or all values as floating points otherwise. We apply a "all or nothing"
rule for consistency.
Parameters:
fillValues - The packed values used for missing data, or null if none.
See Also: Band.setPackedValues |
| setOffset | | public void setOffset(double offset)(Code) | | Sets the offset for this band.
Parameters:
offset - The offset from packed to geophysics values, or 0 if none. |
| setPackedValues | | public void setPackedValues(double minValue, double maxValue, double[] fillValues, int dataType)(Code) | | Defines valid and fill packed values as a combinaison of
(minValue, maxValue)
and {linkplain #setNoDataValues(double[]) setNoDataValues}(fillValues).
If the minimal or maximal value is
and the data
type is an integer type, then this method replaces the infinite values by default bounds
inferred from the data type and the fill values.
Parameters:
minValue - The minimal valid packed value,or Double.NEGATIVE_INFINITY if unknown.
Parameters:
maxValue - The maximal valid packed value,or Double.POSITIVE_INFINITY if unknown.
Parameters:
fillValues - The packed values used for missing data, or null if none.
Parameters:
dataType - The raw data type as one of DataBuffer constants, orDataBuffer.TYPE_UNDEFINED if unknown.
See Also: Band.setValidRange
See Also: Band.setNoDataValues |
| setScale | | public void setScale(double scale)(Code) | | Sets the scale factor for this band.
Parameters:
scale - The scale from packed to geophysics values, or 1 if none. |
| setValidRange | | public void setValidRange(double minValue, double maxValue)(Code) | | Sets the range of valid values. The values should be integers most of the time since
they are packed values (often index in a color palette). But floating point values
are allowed too.
If the minimal or maximal value may be unknown, consider invoking
Band.setPackedValues setPackedValues (minValue, maxValue, …)
instead. The later can infers default bounds according a given data type.
Parameters:
minValue - The minimal valid packed value,or Double.NEGATIVE_INFINITY if none.
Parameters:
maxValue - The maximal valid packed value,or Double.POSITIVE_INFINITY if none.
See Also: Band.setPackedValues |
| Methods inherited from org.geotools.image.io.metadata.MetadataAccessor | protected int appendChild()(Code)(Java Doc)
protected int childCount()(Code)(Java Doc)
protected Date getDate(String attribute)(Code)(Java Doc)
protected Double getDouble(String attribute)(Code)(Java Doc)
protected double[] getDoubles(String attribute, boolean unique)(Code)(Java Doc)
protected Integer getInteger(String attribute)(Code)(Java Doc)
protected int[] getIntegers(String attribute, boolean unique)(Code)(Java Doc)
protected String getString(String attribute)(Code)(Java Doc)
protected Object getUserObject()(Code)(Java Doc)
protected Object getUserObject(Class type) throws ClassCastException(Code)(Java Doc)
protected void selectChild(int index) throws IndexOutOfBoundsException(Code)(Java Doc)
protected void selectParent() throws NoSuchElementException(Code)(Java Doc)
protected void setDate(String attribute, Date value)(Code)(Java Doc)
protected void setDouble(String attribute, double value)(Code)(Java Doc)
protected void setDoubles(String attribute, double[] values)(Code)(Java Doc)
final void setEnum(String attribute, String value, Collection enums)(Code)(Java Doc)
protected void setInteger(String attribute, int value)(Code)(Java Doc)
protected void setIntegers(String attribute, int[] values)(Code)(Java Doc)
protected void setString(String attribute, String value)(Code)(Java Doc)
protected void setUserObject(Object value) throws UnsupportedImplementationException(Code)(Java Doc)
protected boolean setWarningsEnabled(boolean enabled)(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public static String trimFractionalPart(String value)(Code)(Java Doc)
final void warning(String method, int key, Object value)(Code)(Java Doc)
protected void warningOccurred(LogRecord record)(Code)(Java Doc)
|
|
|