Module org.opengis.geoapi

Package org.opengis.metadata.content

Interface SampleDimension

All Superinterfaces:

RangeDimension

All Known Subinterfaces:

Band

@UML(identifier="MD_SampleDimension",
     specification=ISO_19115)
public interface SampleDimension
extends RangeDimension

The characteristics of each dimension (layer) included in the resource.

Conditional properties:

Following property has default method but shall nevertheless be implemented if the corresponding condition is met:

• Units are mandatory if any of the minimum, maximum or mean value properties are provided.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
default Integer	getBitsPerValue()	Maximum number of significant bits in the uncompressed representation for the value in each band of each pixel.
default Double	getMaxValue()	Maximum value of data values in each dimension included in the resource.
default Double	getMeanValue()	Mean value of data values in each dimension included in the resource.
default Double	getMinValue()	Minimum value of data values in each dimension included in the resource.
default Double	getNominalSpatialResolution()	Smallest distance between which separate points can be distinguished, as specified in instrument design.
default Integer	getNumberOfValues()	Number of values used in a thematic classification resource.
default Double	getOffset()	Physical value corresponding to a cell value of zero.
default Record	getOtherProperty()	Instance of other attribute type that defines attributes not explicitly included in CoverageContentType.
default RecordType	getOtherPropertyType()	Type of other attribute description.
default Collection<? extends RangeElementDescription>	getRangeElementDescriptions()	Provides the description and values of the specific range elements of a sample dimension.
default Double	getScaleFactor()	Scale factor which has been applied to the cell value.
default Double	getStandardDeviation()	Standard deviation of data values in each dimension included in the resource.
default TransferFunctionType	getTransferFunctionType()	Type of transfer function to be used when scaling a physical value for a given element.
default javax.measure.Unit<?>	getUnits()	Units of data in each dimension included in the resource.

Methods inherited from interface org.opengis.metadata.content.RangeDimension

getDescription, getDescriptor, getNames, getSequenceIdentifier

Method Details

getMinValue

@UML(identifier="minValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getMinValue()

Minimum value of data values in each dimension included in the resource. May be null if unspecified.

Returns:

minimum value of data values in each dimension included in the resource, or null if none.

getMaxValue

@UML(identifier="maxValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getMaxValue()

Maximum value of data values in each dimension included in the resource. May be null if unspecified.

Returns:

maximum value of data values in each dimension included in the resource, or null if none.

getMeanValue

@UML(identifier="meanValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getMeanValue()

Mean value of data values in each dimension included in the resource. May be null if unspecified.

Returns:

the mean value of data values in each dimension included in the resource, or null if none.

getNumberOfValues

@UML(identifier="numberOfValues",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Integer getNumberOfValues()

Number of values used in a thematic classification resource. May be null if unspecified.

Example: the number of classes in a Land Cover Type coverage or the number of cells with data in other types of coverages.

Returns:

the number of values used in a thematic classification resource, or null if none.

getStandardDeviation

@UML(identifier="standardDeviation",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getStandardDeviation()

Standard deviation of data values in each dimension included in the resource. May be null if unspecified.

Returns:

standard deviation of data values in each dimension included in the resource, or null if none.

getUnits

@UML(identifier="units",
     obligation=CONDITIONAL,
     specification=ISO_19115)
default javax.measure.Unit<?> getUnits()

Units of data in each dimension included in the resource. May be null if unspecified.

Returns:

units of data in each dimension included in the resource, or null if none.

Condition:

Mandatory if minimum, maximum or mean value are provided.

getScaleFactor

@UML(identifier="scaleFactor",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getScaleFactor()

Scale factor which has been applied to the cell value. May be null if unspecified.

Returns:

scale factor which has been applied to the cell value, or null if none.

getOffset

@UML(identifier="offset",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getOffset()

Physical value corresponding to a cell value of zero. May be null if unspecified.

Returns:

physical value corresponding to a cell value of zero, or null if none.

getTransferFunctionType

@UML(identifier="transferFunctionType",
     obligation=OPTIONAL,
     specification=ISO_19115_2)
default TransferFunctionType getTransferFunctionType()

Type of transfer function to be used when scaling a physical value for a given element.

Returns:

type of transfer function.

Departure from OGC/ISO standard for harmonization between different specifications

ISO 19115-2 defines this property in the MI_Band type (a MD_Band subtype) for historical reasons. GeoAPI moves this property up in the hierarchy to a more natural place when not constrained by historical reasons, which is together with the offset and scale factor.

getBitsPerValue

@UML(identifier="bitsPerValue",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Integer getBitsPerValue()

Maximum number of significant bits in the uncompressed representation for the value in each band of each pixel. May be null if unspecified.

Returns:

maximum number of significant bits in the uncompressed representation for the value in each band of each pixel, or null if none.

getRangeElementDescriptions

@UML(identifier="rangeElementDescription",
     obligation=OPTIONAL,
     specification=ISO_19115,
     version=2018)
default Collection<? extends RangeElementDescription> getRangeElementDescriptions()

Provides the description and values of the specific range elements of a sample dimension. Example: missing data.

Returns:

description and values of the specific range elements.

getNominalSpatialResolution

@UML(identifier="nominalSpatialResolution",
     obligation=OPTIONAL,
     specification=ISO_19115_2)
default Double getNominalSpatialResolution()

Smallest distance between which separate points can be distinguished, as specified in instrument design.

Upcoming API change — units of measurement
The return type of this method may change in GeoAPI 4.0. It may be replaced by the Length type in order to provide unit of measurement together with the value.

Returns:

smallest distance between which separate points can be distinguished.

Departure from OGC/ISO standard for harmonization between different specifications

ISO 19115-2 defines this property in the MI_Band type (a MD_Band subtype) for historical reasons. GeoAPI moves this property up in the hierarchy since this property can apply to any sample dimension, not only the measurements in the electromagnetic spectrum.

Unit:

Distance

getOtherPropertyType

@UML(identifier="otherPropertyType",
     obligation=OPTIONAL,
     specification=ISO_19115)
default RecordType getOtherPropertyType()

Type of other attribute description. May be null if unspecified.

Returns:

type of other attribute description, or null if none.

getOtherProperty

@UML(identifier="otherProperty",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Record getOtherProperty()

Instance of other attribute type that defines attributes not explicitly included in CoverageContentType. May be null if unspecified.

Returns:

instance of other/attributeType that defines attributes, or null if none.