Class RasterTilesFileReader<T, P>

Raster Tiles File Reader

Description

Read an entire archive of raster tiles, where the max zoom data is iterated upon

Supports reading either RGB(A) data and/or RGB(A) encoded elevation data.

Usage

import { convertTerrariumElevationData } from 'gis-tools-ts';
import { RasterTilesFileReader } from 'gis-tools-ts/file';

// creates a reader for a tile set treating the max zoom as 3 instead of the metadata's max zoom
const reader = new RasterTilesFileReader('./raster-tiles-top-level-folder', 3);
// example of reading in an elevation dataset
const reader2 = new RasterTilesFileReader('./terrariumData', -1, convertTerrariumElevationData);

// grab the metadata
const metadata = await reader.getMetadata();

// grab a WM tile
const tile1 = await reader.getTile(0, 0, 0);
// or if it's an S2 tile spec
const tile2 = await reader.getTileS2(0, 0, 0, 0);

// grab all the max zoom tiles:
for await (const tile of reader) {
  console.log(tile);
}

Constructors

constructor

new RasterTilesFileReader<
    T extends Properties = RGBA
    | ElevationPoint,
    P extends Properties = T,
>(
    input: string | S2PMTilesReader,
    threshold?: number,
    converter?: ElevationConverter,
): RasterTilesFileReader<T, P>
Type Parameters
- T extends Properties = RGBA | ElevationPoint
- P extends Properties = T
Parameters
- input: string | S2PMTilesReader
  the file path or S2PMTilesReader to read from
- threshold: number = -1
  if non-zero its the max zoom to read all tiles in the FeatureIterator
- Optionalconverter: ElevationConverter
  the elevation converter
Returns RasterTilesFileReader<T, P>

Properties

`Optional` `Readonly`converter

converter?: ElevationConverter

the elevation converter

`Readonly`input

input: string | S2PMTilesReader

the file path or S2PMTilesReader to read from

`Readonly`threshold

threshold: number = -1

if non-zero its the max zoom to read all tiles in the FeatureIterator

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<
| S2Feature<S2TileMetadata, T, P, VectorGeometry<T>>
| VectorFeature<TileMetadata, T, P>,
>
Iterate over all tiles in the archive

Returns AsyncGenerator<
| S2Feature<S2TileMetadata, T, P, VectorGeometry<T>>
| VectorFeature<TileMetadata, T, P>,
>
Yields
- the each of the tile's pixel RGBA data as lon-lat or S2 s-t coordinates with the RGBA as m-values
Implementation of FeatureIterator.[asyncIterator]

getMetadata

getMetadata(): Promise<Metadata>
Get the metadata of the archive

Returns Promise<Metadata>
- the metadata
Implementation of TileReader.getMetadata

getTileS2

getTileS2(
    face: Face,
    zoom: number,
    x: number,
    y: number,
): Promise<undefined | RasterS2TileReader<T, P>>
Grab the tile at the given (face, zoom, x, y) coordinates
Parameters
- face: Face
  the Open S2 projection face
- zoom: number
  the zoom level of the tile
- x: number
  the x coordinate of the tile
- y: number
  the y coordinate of the tile
Returns Promise<undefined | RasterS2TileReader<T, P>>
- the tile
Implementation of TileReader.getTileS2

getTileWM

getTileWM(
    zoom: number,
    x: number,
    y: number,
): Promise<undefined | RasterTileReader<T, P>>
Grab the tile at the given zoom-x-y coordinates
Parameters
- zoom: number
  the zoom level of the tile
- x: number
  the x coordinate of the tile
- y: number
  the y coordinate of the tile
Returns Promise<undefined | RasterTileReader<T, P>>
- the tile
Implementation of TileReader.getTileWM

hasTileS2

hasTileS2(face: Face, zoom: number, x: number, y: number): Promise<boolean>
Return true if the tile exists
Parameters
- face: Face
  the Open S2 projection face
- zoom: number
  the zoom level of the tile
- x: number
  the x coordinate of the tile
- y: number
  the y coordinate of the tile
Returns Promise<boolean>
- true if the tile exists
Implementation of TileReader.hasTileS2

hasTileWM

hasTileWM(zoom: number, x: number, y: number): Promise<boolean>
Return true if the tile exists
Parameters
- zoom: number
  the zoom level of the tile
- x: number
  the x coordinate of the tile
- y: number
  the y coordinate of the tile
Returns Promise<boolean>
- true if the tile exists
Implementation of TileReader.hasTileWM

Class RasterTilesFileReader<T, P>

Raster Tiles File Reader

Description

Usage

Links

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RasterTilesFileReader<T, P>

Properties

`Optional` `Readonly`converter

`Readonly`input

`Readonly`threshold

Methods

[asyncIterator]

Returns AsyncGenerator<
| S2Feature<S2TileMetadata, T, P, VectorGeometry<T>>
| VectorFeature<TileMetadata, T, P>,
>

Yields

getMetadata

Returns Promise<Metadata>

getTileS2

Parameters

Returns Promise<undefined | RasterS2TileReader<T, P>>

getTileWM

Parameters

Returns Promise<undefined | RasterTileReader<T, P>>

hasTileS2

Parameters

Returns Promise<boolean>

hasTileWM

Parameters

Returns Promise<boolean>

Settings

On This Page

Class RasterTilesFileReader<T, P>

Raster Tiles File Reader

Description

Usage

Links

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RasterTilesFileReader<T, P>

Properties

Optional Readonlyconverter

Readonlyinput

Readonlythreshold

Methods

[asyncIterator]

Returns AsyncGenerator< | S2Feature<S2TileMetadata, T, P, VectorGeometry<T>> | VectorFeature<TileMetadata, T, P>,>

Yields

getMetadata

Returns Promise<Metadata>

getTileS2

Parameters

Returns Promise<undefined | RasterS2TileReader<T, P>>

getTileWM

Parameters

Returns Promise<undefined | RasterTileReader<T, P>>

hasTileS2

Parameters

Returns Promise<boolean>

hasTileWM

Parameters

Returns Promise<boolean>

Settings

On This Page

`Optional` `Readonly`converter

`Readonly`input

`Readonly`threshold

Returns AsyncGenerator<
| S2Feature<S2TileMetadata, T, P, VectorGeometry<T>>
| VectorFeature<TileMetadata, T, P>,
>