node-gdal-next node-gdal-next

  • API Docs for Version: 1.0.0

    • Show:

    gdal.RasterBandOverviews

    An encapsulation of a RasterBand overview functionality.

    Table of Contents

    Methods

    count () Integer

    Defined in src/collections/rasterband_overviews.cpp:142

    Returns the number of overviews.

    Returns:

    Integer
    forEach
    (
    • callback
    )

    Defined in lib/gdal.js:422

    Iterates through all overviews using a callback function.

    Parameters:

    • callback Function

    Example:

    band.overviews.forEach(function(overviewBand, i) { ... });`
    get
    (
    • index
    )
    gdal.RasterBand

    Defined in src/collections/rasterband_overviews.cpp:77

    Fetches the overview at the provided index.

    Parameters:

    • index Integer

      0-based index

    Returns:

    gdal.RasterBand
    getBySampleCount
    (
    • samples
    )
    gdal.RasterBand

    Defined in src/collections/rasterband_overviews.cpp:110

    Fetch best sampling overview.

    Returns the most reduced overview of the given band that still satisfies the desired number of samples. This function can be used with zero as the number of desired samples to fetch the most reduced overview. The same band as was passed in will be returned if it has not overviews, or if none of the overviews have enough samples.

    Parameters:

    • samples Integer

    Returns:

    gdal.RasterBand
    map
    (
    • callback
    )

    Defined in lib/gdal.js:435

    Iterates through all raster overviews using a callback function and builds an array of the returned values.

    Parameters:

    • callback Function

      The callback to be called with each Geometry

    Example:

    var result = band.overviews.map(function(overviewBand, i) {
    return value;
});`