Package org.geotools.api.coverage

Interface SampleDimension

  • All Known Implementing Classes:
    GridSampleDimension
    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.
    Since:
    GeoAPI 1.0
    Author:
    Martin Desruisseaux (IRD)

    • Method Detail

      • getDescription

        InternationalString getDescription()
        Sample dimension title or description. This string may be null or empty if no description is present.
        Returns:
        A description for this sample dimension.

      • getSampleDimensionType

        SampleDimensionType getSampleDimensionType()
        A code value indicating grid value data type. This will also indicate the number of bits for the data type.
        Returns:
        A code value indicating grid value data type.

      • getCategoryNames

        InternationalString[] getCategoryNames()
        Sequence of category names for the values contained in a sample dimension. This allows for names to be assigned to numerical values. The first entry in the sequence relates to a cell value of zero. For grid coverages, category names are only valid for a classified grid data.

        For example:

        • 0 Background
        • 1 Water
        • 2 Forest
        • 3 Urban
        Note: If no category names exist, an empty sequence is returned.
        Returns:
        The category names.

      • getNoDataValues

        double[] getNoDataValues()
        Values to indicate no data values for the sample dimension. For low precision sample dimensions, this will often be no data values.
        Returns:
        The values to indicate no data values for the sample dimension.
        See Also:
        getMinimumValue(), getMaximumValue()

      • getMinimumValue

        double getMinimumValue()
        The minimum value occurring in the sample dimension. If this value is not available, this value can be determined from the org.geotools.api.coverage.processing.GridAnalysis#getMinValue operation. This value can be empty if this value is not provided by the implementation.
        Returns:
        The minimum value occurring in the sample dimension.
        See Also:
        getMaximumValue(), getNoDataValues()

      • getMaximumValue

        double getMaximumValue()
        The maximum value occurring in the sample dimension. If this value is not available, this value can be determined from the org.geotools.api.coverage.processing.GridAnalysis#getMaxValue operation. This value can be empty if this value is not provided by the implementation.
        Returns:
        The maximum value occurring in the sample dimension.
        See Also:
        getMinimumValue(), getNoDataValues()

      • getUnits

        Unit<?> getUnits()
        The unit information for this sample dimension. This interface typically is provided with grid coverages which represent digital elevation data. This value will be null if no unit information is available.
        Returns:
        The unit information for this sample dimension.

      • getOffset

        double getOffset()
        Offset is the value to add to grid values for this sample dimension. This attribute is typically used when the sample dimension represents elevation data. The default for this value is 0.
        Returns:
        The offset.
        See Also:
        getScale()

      • getScale

        double getScale()
        Scale is the value which is multiplied to grid values for this sample dimension. This attribute is typically used when the sample dimension represents elevation data. The default for this value is 1.
        Returns:
        The scale factor.
        See Also:
        getOffset()