browser-image
    Preparing search index...

    Options for EnhancedGeoTIFF: those of ol/source/GeoTIFF, plus the correction.

    interface EnhancedGeoTIFFOptions {
        normalize?: boolean | "auto";
        pipeline?: Pipeline;
        worker?: boolean;
        correctTiles?: boolean;
        gpuStretch?: boolean;
        rawStretch?: AutoStretchOptions | RasterStretch;
        select?: BandSelection;
        bandNames?: readonly (string | null)[];
        noData?: NoDataOptions;
        rawCacheSize?: number;
        draSampleSize?: number;
        draMaxTiles?: number;
        cpuReprojection?: boolean;
        transition?: number;
    }

    Hierarchy

    • Omit<GeoTIFFOptions, "normalize">
      • EnhancedGeoTIFFOptions
    Index
    normalize?: boolean | "auto"

    true (default): OpenLayers scales values to 0-255 over the data type's range (or the min/max given). false: raw values are stretched here, from their own statistics (see rawStretch). 'auto': 8-bit images as with true, deeper ones (16-bit, float) as with false.

    pipeline?: Pipeline

    Correction to apply. Default: an empty pipeline (no change).

    worker?: boolean

    Run corrections in Web Workers (default true).

    correctTiles?: boolean

    Correct each tile as it loads (default true). With false, tiles are drawn as read and the pipeline is applied when the map is drawn, by a GpuCorrectedTileLayer.

    gpuStretch?: boolean

    With correctTiles: false and raw values (normalize: false, or 'auto' on an image deeper than 8 bits): hand the layer the raw values as float tiles and let GpuCorrectedTileLayer stretch them to 0-255 in its shader, at full precision (default true). A new raw stretch then redraws the map instead of rebuilding every tile. Needs float textures that can be filtered (OES_texture_float_linear); without them, or with false, tiles are stretched to 8 bits here as they load.

    With normalize: false: how raw values become 0-255 before the pipeline. A fixed RasterStretch, or automatic stretch options (default {}: percentClip, 0.5 % at each end, band by band) applied to the statistics of the whole image. When the pipeline has autoStretch, its options are used instead, on the visible area (see updateDra).

    select?: BandSelection

    The bands (0-based, alpha not counted) that R, G and B show: [3, 2, 1] shows band 3 as red, 2 as green and 1 as blue; one index shows that band in gray. Not to be confused with sources[].bands, which picks (1-based) the bands that are read at all. Default: the bands as read (bands 0, 1, 2 for images with more than 4 bands). Needs an image with at least 3 bands.

    bandNames?: readonly (string | null)[]

    Names of the bands (0-based, alpha not counted), shown by the band selects of EnhanceControl. Default: read from the file (DESCRIPTION in GDAL's metadata, e.g. NIR); see getBandNames.

    noData?: NoDataOptions

    Which pixels are no data and drawn transparent (see NoDataOptions). Default { auto: true }: the file's no-data value and the usual fill values. Can be changed later with setNoData.

    rawCacheSize?: number

    Raw tiles kept for re-correction. Default 256 (about 64 MB for RGBA 256×256 tiles).

    draSampleSize?: number

    DRA statistics are read from the overview level where the visible area is about this many pixels on its longer side. Default 1024.

    draMaxTiles?: number

    At most this many tiles are read for DRA statistics; a coarser level is used if needed. Default 64.

    cpuReprojection?: boolean

    Reproject tiles on the CPU when the map's projection differs from the image's (default true). OpenLayers' own reprojection draws every tile in a WebGL context of its own and reads it back, which stalls the main thread far longer than the JS that replaces it. False: OpenLayers' way.

    transition?: number

    How long a new tile fades in, in milliseconds; 0 for none. Default 100 (OpenLayers' own is 250).