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

// get a specfic WM value given a longitude and latitude
const value = await reader.getLonLatValuesWM(0, 0, 0);
// get a specfic S2 value given a longitude and latitude
const value2 = await reader.getLonLatValuesS2(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 | S2TilesReader,
    threshold?: number,
    converter?: ElevationConverter,
): RasterTilesFileReader<T, P>
Type Parameters
- T extends Properties = RGBA | ElevationPoint
- P extends Properties = T
Parameters
- input: string | S2PMTilesReader | S2TilesReader
  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 | S2TilesReader

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<S2TileID, T, P, VectorGeometry<T>>
    | VectorFeature<WMTileID, T, P>,
>

Iterate over all tiles in the archive

Returns AsyncGenerator<
    | S2Feature<S2TileID, T, P, VectorGeometry<T>>
    | VectorFeature<WMTileID, 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]

getLonLatValuesS2

getLonLatValuesS2(
    zoom: number,
    lon: number,
    lat: number,
    tileSize?: number,
): Promise<RGBA | ElevationPoint | undefined>
Get the value of the given longitude and latitude
Parameters
- zoom: number
  the zoom level
- lon: number
  the longitude
- lat: number
  the latitude
- tileSize: number = 512
  in pixels
Returns Promise<RGBA | ElevationPoint | undefined>
- the value at the given longitude and latitude
Implementation of TileReader.getLonLatValuesS2

getLonLatValuesWM

getLonLatValuesWM(
    zoom: number,
    lon: number,
    lat: number,
    tileSize?: number,
): Promise<RGBA | ElevationPoint | undefined>
Get the value of the given longitude and latitude
Parameters
- zoom: number
  the zoom level
- lon: number
  the longitude
- lat: number
  the latitude
- tileSize: number = 512
  in pixels
Returns Promise<RGBA | ElevationPoint | undefined>
- the value at the given longitude and latitude
Implementation of TileReader.getLonLatValuesWM

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<RasterS2TileReader<T, P> | undefined>
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<RasterS2TileReader<T, P> | undefined>
- the tile
Implementation of TileReader.getTileS2

getTileWithPaddingWM

getTileWithPaddingWM(
    zoom: number,
    x: number,
    y: number,
    padding: number,
    size?: number,
    wantedSize?: number,
): Promise<RasterTileReader<T, T> | undefined>
Grab the tile at the given zoom-x-y coordinates.

This function adds the ability to pull from surrounding images and add them as padding

This function is also useful for just expanding the zoom level up. So if the image is 256x256, you can use this function to get a 512x512 image
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
- padding: number
  the amount of padding to add to each side of the tile
- size: number = 512
  the size of each tile width and height.
- wantedSize: number = size
  the size of the rendered center tile. For example if you want a 512x512 tile, but the source is 256x256, you can set this to 512.
Returns Promise<RasterTileReader<T, T> | undefined>
- the tile

getTileWM

getTileWM(
    zoom: number,
    x: number,
    y: number,
): Promise<RasterTileReader<T, P> | undefined>
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<RasterTileReader<T, P> | undefined>
- 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

iterate

iterate(): AsyncGenerator<TileID>
Iterate over all the tiles in the tileset and yield their positions

Returns AsyncGenerator<TileID>
- an iterator over all the tiles in the tileset
Yields
- the metadata of each tile
Implementation of TileReader.iterate

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<S2TileID, T, P, VectorGeometry<T>> | VectorFeature<WMTileID, T, P>,>

Yields

getLonLatValuesS2

Parameters

Returns Promise<RGBA | ElevationPoint | undefined>

getLonLatValuesWM

Parameters

Returns Promise<RGBA | ElevationPoint | undefined>

getMetadata

Returns Promise<Metadata>

getTileS2

Parameters

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

getTileWithPaddingWM

Parameters

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

getTileWM

Parameters

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

hasTileS2

Parameters

Returns Promise<boolean>

hasTileWM

Parameters

Returns Promise<boolean>

iterate

Returns AsyncGenerator<TileID>

Yields

Settings

On This Page

`Optional` `Readonly`converter

`Readonly`input

`Readonly`threshold

Returns AsyncGenerator<
| S2Feature<S2TileID, T, P, VectorGeometry<T>>
| VectorFeature<WMTileID, T, P>,
>