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:
    Since:
    3.1

    • Method Detail

      • 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.

      • 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 specification:
        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.

      • 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 specification:
        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