|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@UML(identifier="CV_SampleDimension", specification=OGC_01004) public interface SampleDimension
Contains information for an individual sample dimension of coverage. This interface is applicable to any coverage type. For grid coverages, the sample dimension refers to an individual band.
WARNING: THIS CLASS WILL CHANGE. Current API is derived from OGC Grid Coverages Implementation specification 1.0. We plan to replace it by new interfaces derived from ISO 19123 (Schema for coverage geometry and functions). Current interfaces should be considered as legacy and are included in this distribution only because they were part of GeoAPI 1.0 release. We will try to preserve as much compatibility as possible, but no migration plan has been determined yet. |
Method Summary | |
---|---|
InternationalString[] |
getCategoryNames()
Sequence of category names for the values contained in a sample dimension. |
ColorInterpretation |
getColorInterpretation()
Deprecated. No replacement. |
InternationalString |
getDescription()
Sample dimension title or description. |
double |
getMaximumValue()
The maximum value occurring in the sample dimension. |
String[] |
getMetaDataNames()
Deprecated. No replacement. |
String |
getMetadataValue(String name)
Deprecated. No replacement. |
double |
getMinimumValue()
The minimum value occurring in the sample dimension. |
double[] |
getNoDataValues()
Values to indicate no data values for the sample dimension. |
double |
getOffset()
Offset is the value to add to grid values for this sample dimension. |
int[][] |
getPalette()
Deprecated. No replacement. |
PaletteInterpretation |
getPaletteInterpretation()
Deprecated. No replacement. |
SampleDimensionType |
getSampleDimensionType()
A code value indicating grid value data type. |
MathTransform1D |
getSampleToGeophysics()
The transform which is applied to grid values for this sample dimension. |
double |
getScale()
Scale is the value which is multiplied to grid values for this sample dimension. |
Unit |
getUnits()
The unit information for this sample dimension. |
Method Detail |
---|
@UML(identifier="description", obligation=MANDATORY, specification=OGC_01004) InternationalString getDescription()
@UML(identifier="sampleDimensionType", obligation=MANDATORY, specification=OGC_01004) SampleDimensionType getSampleDimensionType()
@UML(identifier="categoryNames", obligation=MANDATORY, specification=OGC_01004) InternationalString[] getCategoryNames()
@UML(identifier="colorInterpretation", obligation=MANDATORY, specification=OGC_01004) ColorInterpretation getColorInterpretation()
UNDEFINED
.
@UML(identifier="paletteInterpretation", obligation=MANDATORY, specification=OGC_01004) PaletteInterpretation getPaletteInterpretation()
GRAY_INDEX
or PALETTE_INDEX
.
A palette entry type can be Gray, RGB, CMYK or HLS.
@UML(identifier="palette", obligation=MANDATORY, specification=OGC_01004) int[][] getPalette()
null
will be returned.
getPaletteInterpretation()
,
getColorInterpretation()
,
IndexColorModel
@UML(identifier="noDataValue", obligation=MANDATORY, specification=OGC_01004) double[] getNoDataValues()
getMinimumValue()
,
getMaximumValue()
@UML(identifier="minimumValue", obligation=MANDATORY, specification=OGC_01004) double getMinimumValue()
GridAnalysis.getMinValue(int)
operation.
This value can be empty if this value is not provided by the implementation.
getMaximumValue()
,
getNoDataValues()
@UML(identifier="maximumValue", obligation=MANDATORY, specification=OGC_01004) double getMaximumValue()
GridAnalysis.getMaxValue(int)
operation.
This value can be empty if this value is not provided by the implementation.
getMinimumValue()
,
getNoDataValues()
@UML(identifier="units", obligation=MANDATORY, specification=OGC_01004) Unit getUnits()
null
if no unit information is available.
@UML(identifier="offset", obligation=MANDATORY, specification=OGC_01004) double getOffset()
getScale()
@UML(identifier="scale", obligation=MANDATORY, specification=OGC_01004) double getScale()
getOffset()
MathTransform1D getSampleToGeophysics()
scale
×x where
x is the grid value and y is the geophysics value.
However, this transform may also defines more complex relationship, for
example a logarithmic one. In order words, this transform is a generalization of
getScale()
, getOffset()
and getNoDataValues()
methods.
null
if
it doesn't apply.getScale()
,
getOffset()
,
getNoDataValues()
@UML(identifier="metadataNames", obligation=MANDATORY, specification=OGC_01004) String[] getMetaDataNames()
getMetadataValue(java.lang.String)
,
PropertySource
@UML(identifier="getMetadataValue", obligation=MANDATORY, specification=OGC_01004) String getMetadataValue(String name) throws MetadataNameNotFoundException
name
- Metadata keyword for which to retrieve metadata.
MetadataNameNotFoundException
- if there is no value for the specified metadata name.getMetaDataNames()
,
PropertySource
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |