Class CogSource

Provides data from a Cloud Optimized GeoTIFF (COG).

Hierarchy

ImageSource
- CogSource

Constructors

constructor

new CogSource(options): CogSource
Creates a COG source.
Parameters
- options: CogSourceOptions
  
  options
Returns CogSource
Overrides ImageSource.constructor
- Defined in sources/CogSource.ts:240

Properties

`Private` _bps

_bps: number

`Private` `Readonly` _cache

_cache: Cache = GlobalCache

`Private` `Readonly` _cacheId

_cacheId: string = ...

`Private` `Readonly` _cacheOptions

_cacheOptions: CogCacheOptions

`Private` _channels

_channels: number[]

`Private` _dimensions

_dimensions: Vector2

`Private` _extent

_extent: Extent

`Private` _format

_format: number

`Private` _imageCount

_imageCount: number

`Private` _images

_images: Level[]

`Private` _initializePromise

_initializePromise: Promise<void>

`Private` _initialized

_initialized: boolean

`Private` _masks

_masks: Level[]

`Private` _nodata

_nodata: number

`Private` _origin

_origin: number[]

`Private` `Readonly` _pool

_pool: Pool

`Private` _sampleCount

_sampleCount: number

`Private` _tiffImage

_tiffImage: GeoTIFF

`Readonly` containsFn

containsFn: 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` isCogSource

isCogSource: boolean = true

`Readonly` isImageSource

isImageSource: boolean = true

type

type: string

`Readonly` url

url: string

version

version: number

Accessors

channels

get channels(): number[]
Gets the channel mapping.

Returns number[]
- Defined in sources/CogSource.ts:501
set channels(value): void
Parameters
- value: number[]
Returns void
- Defined in sources/CogSource.ts:505

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:147

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, CogSource>
  
  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, CogSource>
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/CogSource.ts:283

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:214

`Private` createTexture

createTexture(buffers): DataTexture
Creates a texture from the pixel buffer(s).
Parameters
- buffers: SizedArray<NumberArray>
  
  The buffers (one buffer per band)
Returns DataTexture
The generated texture.
- Defined in sources/CogSource.ts:434

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
Inherited from ImageSource.dispose
- Defined in sources/ImageSource.ts:269

`Private` fetchBuffer

fetchBuffer(image, window, channels, signal?): Promise<TypedArray | TypedArray[]>
Parameters
- image: GeoTIFFImage
  
  The image to read.
- window: number[]
  
  The image region to read.
- channels: number[]
- Optional signal: AbortSignal
  
  The abort signal.
Returns Promise<TypedArray | TypedArray[]>
The buffers.
- Defined in sources/CogSource.ts:617

getCrs

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

Returns string
The CRS.
Overrides ImageSource.getCrs
- Defined in sources/CogSource.ts:259

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/CogSource.ts:255

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
  - Optional signal?: 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/CogSource.ts:691

`Private` getRegionBuffers

getRegionBuffers(extent, imageInfo, channels, signal, id): Promise<TypedArray[]>
Extract a region from the specified image.
Parameters
- extent: Extent
  
  The request extent.
- imageInfo: Level
  
  The image to sample.
- channels: number[]
- signal: AbortSignal
  
  The abort signal.
- id: string
  
  The request id.
Returns Promise<TypedArray[]>
The buffer(s).
- Defined in sources/CogSource.ts:655

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, CogSource>
  
  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, CogSource>
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/CogSource.ts:308

`Private` initializeOnce

initializeOnce(): Promise<void>
Returns Promise<void>
- Defined in sources/CogSource.ts:316

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:231

`Private` loadImage

loadImage(opts): Promise<ImageResult>
Parameters
- opts: {
      extent: Extent;
      height: number;
      id: string;
      signal?: AbortSignal;
      width: number;
  }
  - extent: Extent
  - height: number
  - id: string
  - Optional signal?: AbortSignal
  - width: number
Returns Promise<ImageResult>
- Defined in sources/CogSource.ts:510

`Private` makeWindowFromExtent

makeWindowFromExtent(extent, resolution): number[]
Returns a window in the image's coordinates that matches the requested extent.
Parameters
- extent: Extent
  
  The window extent.
- resolution: number[]
  
  The spatial resolution of the window.
Returns number[]
The window.
- Defined in sources/CogSource.ts:400

`Private` processTransparencyMask

processTransparencyMask(mask, extent, signal, id): Promise<TypedArray>
Parameters
- mask: Level
- extent: Extent
- signal: AbortSignal
- id: string
Returns Promise<TypedArray>
- Defined in sources/CogSource.ts:554

`Private` readWindow

readWindow(image, window, channels, signal?): Promise<ReadRasterResult>
Parameters
- image: GeoTIFFImage
- window: number[]
- channels: number[]
- Optional signal: AbortSignal
Returns Promise<ReadRasterResult>
- Defined in sources/CogSource.ts:579

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, CogSource>
  
  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, CogSource>
Returns void
Inherited from ImageSource.removeEventListener
- Defined in ../node_modules/@types/three/src/core/EventDispatcher.d.ts:78

`Private` selectLevel

selectLevel(requestExtent, requestWidth, requestHeight): {
image: Level;
mask: Level;
}
Select the best overview level (or the final image) to match the requested extent and pixel width and height.
Parameters
- requestExtent: Extent
  
  The window extent.
- requestWidth: number
  
  The pixel width of the window.
- requestHeight: number
  
  The pixel height of the window.
Returns {
image: Level;
mask: Level;
}
The selected zoom level.
- image: Level
- mask: Level
- Defined in sources/CogSource.ts:465

update

update(): void
Raises an event to reload the source.

Returns void
Inherited from ImageSource.update
- Defined in sources/ImageSource.ts:200

`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/CogSource.ts:269

Class CogSource

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: CogSourceOptions

Returns CogSource

Properties

Private _bps

Private Readonly _cache

Private Readonly _cacheId

Private Readonly _cacheOptions

Private _channels

Private _dimensions

Private _extent

Private _format

Private _imageCount

Private _images

Private _initializePromise

Private _initialized

Private _masks

Private _nodata

Private _origin

Private Readonly _pool

Private _sampleCount

Private _tiffImage

Readonly containsFn

Readonly crs

datatype

Readonly flipY

Readonly isCogSource

Readonly isImageSource

type

Readonly url

version

Accessors

channels

Returns number[]

Parameters

value: number[]

Returns void

colorSpace

Returns ColorSpace

Methods

addEventListener

Type Parameters

T extends "updated"

Parameters

type: T

listener: EventListener<ImageSourceEvents[T], T, CogSource>

Returns void

Type Parameters

T extends string

Parameters

type: T

listener: EventListener<{}, T, CogSource>

Returns void

adjustExtentAndPixelSize

Parameters

requestExtent: Extent

requestWidth: number

requestHeight: number

margin: number = 0

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

extent: Extent

height: number

width: number

contains

Parameters

extent: Extent

Returns boolean

Private createTexture

Parameters

buffers: SizedArray<NumberArray>

Returns DataTexture

`Private` _bps

`Private` `Readonly` _cache

`Private` `Readonly` _cacheId

`Private` `Readonly` _cacheOptions

`Private` _channels

`Private` _dimensions

`Private` _extent

`Private` _format

`Private` _imageCount

`Private` _images

`Private` _initializePromise

`Private` _initialized

`Private` _masks

`Private` _nodata

`Private` _origin

`Private` `Readonly` _pool

`Private` _sampleCount

`Private` _tiffImage

`Readonly` containsFn

`Readonly` crs

`Readonly` flipY

`Readonly` isCogSource

`Readonly` isImageSource

`Readonly` url

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

`Private` createTexture

`Private` fetchBuffer

`Optional` signal: AbortSignal

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

`Optional` signal?: AbortSignal

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

`Private` getRegionBuffers

`Private` initializeOnce

`Private` loadImage

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

`Optional` signal?: AbortSignal

`Private` makeWindowFromExtent