node-gdal-next node-gdal-next

  • API Docs for Version: 1.0.0

    • Show:

    gdal.RasterBand

    A single raster band (or channel).

    Table of Contents

    Methods

    computeStatistics
    (
    • allow_approximation
    )
    Object

    Defined in src/gdal_rasterband.cpp:340

    Computes image statistics.

    Returns the minimum, maximum, mean and standard deviation of all pixel values in this band. If approximate statistics are sufficient, the allow_approximation argument can be set to true in which case overviews, or a subset of image tiles may be used in computing the statistics.

    Parameters:

    • allow_approximation Boolean

      If true statistics may be computed based on overviews or a subset of all tiles.

    Returns:

    Object:

    Statistics containing "min", "max", "mean", "std_dev" properties.

    createMaskBand
    (
    • flags
    )

    Defined in src/gdal_rasterband.cpp:199

    Adds a mask band to the current band.

    Parameters:

    • flags Integer

      Mask flags

    fill
    (
    • real_value
    • imaginary_value
    )

    Defined in src/gdal_rasterband.cpp:237

    Fill this band with a constant value.

    Parameters:

    • real_value Number
    • [imaginary_value] Number optional
    flush ()

    Defined in src/gdal_rasterband.cpp:170

    Saves changes to disk.

    getMaskBand () gdal.RasterBand

    Defined in src/gdal_rasterband.cpp:210

    Return the mask band associated with the band.

    Returns:

    gdal.RasterBand
    getMaskFlags () Integer

    Defined in src/gdal_rasterband.cpp:177

    Return the status flags of the mask band associated with the band.

    The result will be a bitwise OR-ed set of status flags with the following available definitions that may be extended in the future:

    • GMF_ALL_VALID (0x01): There are no invalid pixels, all mask values will be 255. When used this will normally be the only flag set.
    • GMF_PER_DATASET (0x02): The mask band is shared between all bands on the dataset.
    • GMF_ALPHA (0x04): The mask band is actually an alpha band and may have values other than 0 and 255.
    • GMF_NODATA (0x08): Indicates the mask is actually being generated from nodata values. (mutually exclusive of GMF_ALPHA)

    Returns:

    Integer:

    Mask flags

    getMetadata
    (
    • domain
    )

    Defined in src/gdal_rasterband.cpp:425

    Returns band metadata

    Parameters:

    • [domain] String optional
    getStatistics
    (
    • allow_approximation
    • force
    )
    Object

    Defined in src/gdal_rasterband.cpp:285

    Fetch image statistics.

    Returns the minimum, maximum, mean and standard deviation of all pixel values in this band. If approximate statistics are sufficient, the allow_approximation argument can be set to true in which case overviews, or a subset of image tiles may be used in computing the statistics.

    Parameters:

    • allow_approximation Boolean

      If true statistics may be computed based on overviews or a subset of all tiles.

    • force Boolean

      If false statistics will only be returned if it can be done without rescanning the image.

    Returns:

    Object:

    Statistics containing "min", "max", "mean", "std_dev" properties.

    setStatistics
    (
    • min
    • max
    • mean
    • std_dev
    )

    Defined in src/gdal_rasterband.cpp:388

    Set statistics on the band. This method can be used to store min/max/mean/standard deviation statistics.

    Parameters:

    • min Number
    • max Number
    • mean Number
    • std_dev Number

    Attributes

    blockSize

    Object readonly

    Defined in src/gdal_rasterband.cpp:552

    Size object containing "x" and "y" properties.

    categoryNames

    Array

    Defined in src/gdal_rasterband.cpp:785

    List of list of category names for this raster.

    colorInterpretation

    String

    Defined in src/gdal_rasterband.cpp:816

    Color interpretation mode (see GCI constants).

    dataType

    String | Undefined readonly

    Defined in src/gdal_rasterband.cpp:715

    Pixel data type (see GDT constants) used for this band.

    description

    String readonly

    Defined in src/gdal_rasterband.cpp:505

    Name of of band.

    ds

    gdal.Dataset readonly

    Defined in src/gdal_rasterband.cpp:449

    hasArbitraryOverviews

    Boolean readonly

    Defined in src/gdal_rasterband.cpp:760

    An indicator if the underlying datastore can compute arbitrary overviews efficiently, such as is the case with OGDI over a network. Datastores with arbitrary overviews don't generally have any fixed overviews, but GDAL's RasterIO() method can be used in downsampling mode to get overview data efficiently.

    id

    Integer | Null readonly

    Defined in src/gdal_rasterband.cpp:479

    maximum

    Number readonly

    Defined in src/gdal_rasterband.cpp:600

    Maximum value for this band.

    minimum

    Number readonly

    Defined in src/gdal_rasterband.cpp:578

    Minimum value for this band.

    noDataValue

    Number | Null

    Defined in src/gdal_rasterband.cpp:664

    No data value for this band.

    offset

    Number

    Defined in src/gdal_rasterband.cpp:622

    Raster value offset.

    readOnly

    Boolean readonly

    Defined in src/gdal_rasterband.cpp:739

    Indicates if the band is read-only.

    scale

    Number

    Defined in src/gdal_rasterband.cpp:643

    Raster value scale.

    size

    Object readonly

    Defined in src/gdal_rasterband.cpp:527

    Size object containing "x" and "y" properties.

    unitType

    String

    Defined in src/gdal_rasterband.cpp:692

    Raster unit type (name for the units of this raster's values). For instance, it might be "m" for an elevation model in meters, or "ft" for feet. If no units are available, a value of "" will be returned.