API (v2.0.0) - Giro3D
    Preparing search index...

    Class GeoTIFFSource

    Provides data from a remote GeoTIFF file.

    Features:

    • supports tiled and untiled TIFF images
    • supports Cloud Optimized GeoTIFF (COG),
    • supports various compression (LZW, DEFLATE, JPEG...)
    • supports RGB and YCbCr color spaces
    • supports grayscale (e.g elevation data) and color images,
    • support high-dynamic range colors (8-bit, 16-bit and 32-bit floating point pixels),
    • dynamic channel mapping,
    Note

    Performance might be degraded if the GeoTIFF is not optimized for streaming. We recommend using Cloud Optimized GeoTIFFs (COGs) for best performance.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    containsFn crs datatype flipY isGeoTIFFSource isImageSource isMemoryUsage priority synchronous transparent type url

    Accessors

    channels colorSpace

    Methods

    adjustExtentAndPixelSize contains dispose getCrs getExtent getImages getMemoryUsage initialize intersects update computeExtent

    Constructors

    Properties

    containsFn: CustomContainsFn | undefined
    crs: CoordinateSystem
    datatype: TextureDataType

    Gets the datatype of images generated by this source.

    flipY: boolean

    Gets whether images generated from this source should be flipped vertically.

    isGeoTIFFSource: boolean = ...
    isImageSource: boolean = ...
    isMemoryUsage: true = ...

    Readonly flag to indicate that his object implements MemoryUsage.

    priority: RequestPriority = 'auto'
    synchronous: boolean = false

    If true, this source can immediately generate images without any delay.

    transparent: boolean
    type: "GeoTIFFSource" = ...
    url: string

    Accessors

    • get colorSpace(): ColorSpace

      Gets the color space of the textures generated by this source.

      Returns ColorSpace

    Methods

    • Parameters

      • requestExtent: Extent

        The request extent.

      • requestWidth: number

        The width, in pixels, of the request extent.

      • requestHeight: number

        The height, in pixels, of the request extent.

      • margin: number = 0

        The margin, in pixels.

      Returns GridExtent

      The adjusted parameters.

    • Gets whether this source contains the specified extent. If a custom contains function is provided, it will be used. Otherwise, intersects is used.

      This method is mainly used to discard non-relevant requests (i.e don't process regions that are not relevant to this source).

      Parameters

      • extent: Extent

        The extent to test.

      Returns boolean

    • Gets the images for the specified extent and pixel size.

      Parameters

      • options: {
            extent: Extent;
            height: number;
            id: string;
            signal?: AbortSignal;
            width: number;
        }

        The options.

      Returns ImageResponse[]

      An array containing the functions to generate the images asynchronously.

    • Test the intersection between the specified extent and this source's extent. This method may be overriden to perform special logic.

      Parameters

      • extent: Extent

        The extent to test.

      Returns boolean

      true if the extent and this source extent intersects, false otherwise.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods