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 full)

ImageSource
- GeoTIFFSource

Index

Constructors

constructor

new GeoTIFFSource(options): GeoTIFFSource
Creates a GeoTIFFSource source.
Parameters
- options: GeoTIFFSourceOptions
  options
Returns GeoTIFFSource
Overrides ImageSource.constructor
- Defined in sources/GeoTIFFSource.ts:278

Properties

`Readonly`containsFn

containsFn: undefined | CustomContainsFn

`Readonly`crs

crs: string

datatype

datatype: TextureDataType

Gets the datatype of images generated by this source.

`Readonly`flipY

flipY: boolean

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

`Readonly`isGeoTIFFSource

isGeoTIFFSource: boolean = ...

`Readonly`isImageSource

isImageSource: boolean = true

`Readonly`isMemoryUsage

isMemoryUsage: true = ...

Readonly flag to indicate that his object implements MemoryUsage.

`Readonly`synchronous

synchronous: boolean = false

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

`Readonly`type

type: "GeoTIFFSource" = ...

`Readonly`url

url: string

Accessors

channels

get channels(): ChannelMapping
Gets or sets the channel mapping.

Returns ChannelMapping
- Defined in sources/GeoTIFFSource.ts:576
set channels(value): void
Parameters
- value: ChannelMapping
Returns void
- Defined in sources/GeoTIFFSource.ts:580

colorSpace

get colorSpace(): ColorSpace
Gets the color space of the textures generated by this source.

Returns ColorSpace
Inherited from ImageSource.colorSpace
- Defined in sources/ImageSource.ts:170

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ImageSourceEvents[T], T, GeoTIFFSource>
  The function that gets called when the event is fired.
Returns void
Inherited from ImageSource.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:52
addEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, GeoTIFFSource>
Returns void
Inherited from ImageSource.addEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:56

adjustExtentAndPixelSize

adjustExtentAndPixelSize(requestExtent, requestWidth, requestHeight, margin?): {
    extent: Extent;
    height: number;
    width: number;
}
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 {
    extent: Extent;
    height: number;
    width: number;
}
The adjusted parameters.
- extent: Extent
- height: number
- width: number
Overrides ImageSource.adjustExtentAndPixelSize
- Defined in sources/GeoTIFFSource.ts:349

contains

contains(extent): boolean
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
Inherited from ImageSource.contains
- Defined in sources/ImageSource.ts:236

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "updated"
Parameters
- event: BaseEvent<T> & ImageSourceEvents[T]
  The event that gets fired.
Returns void
Inherited from ImageSource.dispatchEvent
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:84

dispose

dispose(): void
Disposes unmanaged resources of this source.

Returns void
Overrides ImageSource.dispose
- Defined in sources/GeoTIFFSource.ts:803

getCrs

getCrs(): string
Returns the CRS of this source.

Returns string
The CRS.
Overrides ImageSource.getCrs
- Defined in sources/GeoTIFFSource.ts:325

getExtent

getExtent(): Extent
Returns the extent of this source expressed in the CRS of the source.

Returns Extent
The extent of the source.
Overrides ImageSource.getExtent
- Defined in sources/GeoTIFFSource.ts:321

getImages

getImages(options): {
id: string;
request: (() => Promise<ImageResult>);
}[]
Gets the images for the specified extent and pixel size.
Parameters
- options: {
      extent: Extent;
      height: number;
      id: string;
      signal?: AbortSignal;
      width: number;
  }
  The options.
  - extent: Extent
  - height: number
  - id: string
  - Optionalsignal?: AbortSignal
  - width: number
Returns {
id: string;
request: (() => Promise<ImageResult>);
}[]
An array containing the functions to generate the images asynchronously.
Overrides ImageSource.getImages
- Defined in sources/GeoTIFFSource.ts:785

getMemoryUsage

getMemoryUsage(context): void
Returns an approximation of the memory used by this object, in bytes.
Parameters
- context: GetMemoryUsageContext
Returns void
Overrides ImageSource.getMemoryUsage
- Defined in sources/GeoTIFFSource.ts:301

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of event to listen to.
- listener: EventListener<ImageSourceEvents[T], T, GeoTIFFSource>
  The function that gets called when the event is fired.
Returns boolean
Inherited from ImageSource.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:63
hasEventListener<T>(type, listener): boolean
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, GeoTIFFSource>
Returns boolean
Inherited from ImageSource.hasEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:67

initialize

initialize(): Promise<void>
Initializes the source.

Returns Promise<void>
A promise that resolves when the source is initialized.
Overrides ImageSource.initialize
- Defined in sources/GeoTIFFSource.ts:389

intersects

intersects(extent): boolean
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.
Inherited from ImageSource.intersects
- Defined in sources/ImageSource.ts:253

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "updated"
Parameters
- type: T
  The type of the listener that gets removed.
- listener: EventListener<ImageSourceEvents[T], T, GeoTIFFSource>
  The listener function that gets removed.
Returns void
Inherited from ImageSource.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:74
removeEventListener<T>(type, listener): void
Type Parameters
- T extends string
Parameters
- type: T
- listener: EventListener<{}, T, GeoTIFFSource>
Returns void
Inherited from ImageSource.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

update

update(extent?): void
Raises an event to reload the source.
Parameters
- Optionalextent: Extent
Returns void
Inherited from ImageSource.update
- Defined in sources/ImageSource.ts:222

`Static`computeExtent

computeExtent(crs, tiffImage): Extent
Attemps to compute the exact extent of the TIFF image.
Parameters
- crs: string
  The CRS.
- tiffImage: GeoTIFFImage
  The TIFF image.
Returns Extent
- Defined in sources/GeoTIFFSource.ts:335

Class GeoTIFFSource

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GeoTIFFSource

Properties

ReadonlycontainsFn

Readonlycrs

datatype

ReadonlyflipY

ReadonlyisGeoTIFFSource

ReadonlyisImageSource

ReadonlyisMemoryUsage

Readonlysynchronous

Readonlytype

Readonlyurl

Accessors

channels

Returns ChannelMapping

Parameters

Returns void

colorSpace

Returns ColorSpace

Methods

addEventListener

Type Parameters

Parameters

Returns void

Type Parameters

Parameters

Returns void

adjustExtentAndPixelSize

Parameters

Returns { extent: Extent; height: number; width: number; }

extent: Extent

height: number

width: number

contains

Parameters

Returns boolean

dispatchEvent

Type Parameters

Parameters

Returns void

dispose

Returns void

getCrs

Returns string

getExtent

Returns Extent

getImages

Parameters

extent: Extent

height: number

id: string

Optionalsignal?: AbortSignal

width: number

Returns { id: string; request: (() => Promise<ImageResult>); }[]

getMemoryUsage

Parameters

Returns void

hasEventListener

Type Parameters

Parameters

Returns boolean

Type Parameters

Parameters

Returns boolean

initialize

Returns Promise<void>

intersects

Parameters

Returns boolean

removeEventListener

`Readonly`containsFn

`Readonly`crs

`Readonly`flipY

`Readonly`isGeoTIFFSource

`Readonly`isImageSource

`Readonly`isMemoryUsage

`Readonly`synchronous

`Readonly`type

`Readonly`url

Returns {
extent: Extent;
height: number;
width: number;
}

`Optional`signal?: AbortSignal

Returns {
id: string;
request: (() => Promise<ImageResult>);
}[]

`Static`computeExtent