gis-tools-ts
Version:
A collection of geospatial tools primarily designed for WGS84, Web Mercator, and S2.
88 lines • 3.21 kB
JavaScript
// https://docs.ogc.org/is/19-008r4/19-008r4.html#_requirements_class_tiff
import { GeoTIFFHeaderReader } from './header.js';
import { GeoTIFFImage } from './image.js';
import { toReader } from '../index.js';
export * from './color.js';
export * from './constants.js';
export * from './decoder.js';
export * from './header.js';
export * from './image.js';
export * from './imageUtil.js';
export * from './predictor.js';
export * from './proj.js';
/**
* # GeoTIFF Reader
*
* ## Description
* This class reads a GeoTIFF file and returns a list of GeoTIFF images.
* Implements the {@link FeatureIterator} interface.
*
* ## Usage
* ```ts
* import { ALL_DEFINITIONS, EPSG_CODES, GeoTIFFReader } from 'gis-tools-ts';
* import { FileReader } from 'gis-tools-ts/file';
*
* const fileReader = new FileReader(`${__dirname}/fixtures/utm.tif`);
* const geotiffReader = new GeoTIFFReader(fileReader, ALL_DEFINITIONS, EPSG_CODES);
* ```
*
* ## Links
* - https://www.ogc.org/publications/standard/geotiff/
* - https://download.osgeo.org/geotiff/spec/tiff6.pdf
* - https://geospatialworld.net/article/geotiff-a-standard-image-file-format-for-gis-applications/
* - https://docs.ogc.org/is/19-008r4/19-008r4.html
*/
export class GeoTIFFReader extends GeoTIFFHeaderReader {
definitions;
epsgCodes;
gridStore = [];
/**
* @param input - the geotiff input to parse data from
* @param definitions - an array of projection definitions for the transformer if needed
* @param epsgCodes - a record of EPSG codes to use for the transformer if needed
* @param gridStores - an array of grid readers if needed
*/
constructor(input, definitions = [], epsgCodes = {}, gridStores) {
const reader = toReader(input);
super(reader);
this.definitions = definitions;
this.epsgCodes = epsgCodes;
if (gridStores !== undefined)
this.gridStore = gridStores;
}
/**
* Add a grid reader
* @param key - the key or name of the grid
* @param input - the input data to parse
*/
addGridReader(key, input) {
const reader = toReader(input);
this.gridStore.push({ key, reader });
}
/**
* Get the n-th internal subfile of an image. By default, the first is returned.
* @param index - the index of the image to get [Default=0]
* @returns - the image at the given index
*/
getImage(index = 0) {
if (index >= this.length)
throw new Error('Index out of bounds.');
return new GeoTIFFImage(this.reader, this.imageDirectories[index], this.littleEndian, this.definitions, this.epsgCodes, this.gridStore);
}
/**
* Iterate through each image and return a vector feature
* @yields {VectorFeature}
*/
async *[Symbol.asyncIterator]() {
for (let i = 0; i < this.length; i++) {
const { geometry, width, height, alpha } = await this.getImage(i).getMultiPointVector();
yield {
type: 'VectorFeature',
geometry,
properties: {},
metadata: { width, height, alpha },
};
}
}
}
//# sourceMappingURL=index.js.map