@developmentseed/geotiff 0.3.0-beta.3 → 0.3.0

package/dist/fetch.js

@@ -1,20 +1,17 @@
-import { TiffTag } from "@cogeotiff/core";
+import { Compression, PlanarConfiguration, TiffTag } from "@cogeotiff/core";
 import { compose, translation } from "@developmentseed/affine";
 import { decode } from "./decode.js";
-export async function fetchTile(self, x, y, options = {}) {
-    if (self.maskImage != null) {
-        throw new Error("Mask fetching not implemented yet");
-    }
-    const tile = await self.image.getTile(x, y, options);
-    if (tile === null) {
-        throw new Error("Tile not found");
-    }
-    const { bitsPerSample: bitsPerSamples, predictor, planarConfiguration, sampleFormat: sampleFormats, } = self.cachedTags;
-    const { bytes, compression } = tile;
+export async function fetchTile(self, x, y, { boundless = true, pool, signal, } = {}) {
+    const tileFetch = fetchCogBytes(self, x, y, { signal });
+    const maskFetch = self.maskImage != null
+        ? getTile(self.maskImage, x, y, self.dataSource, { signal })
+        : Promise.resolve(null);
+    const [tileBytes, maskBytes] = await Promise.all([tileFetch, maskFetch]);
+    const { bitsPerSample: bitsPerSamples, predictor, planarConfiguration, sampleFormat: sampleFormats, lercParameters, } = self.cachedTags;
     const { sampleFormat, bitsPerSample } = getUniqueSampleFormat(sampleFormats, bitsPerSamples);
     const tileTransform = compose(self.transform, translation(x * self.tileWidth, y * self.tileHeight));
     const samplesPerPixel = self.image.value(TiffTag.SamplesPerPixel) ?? 1;
-    const decodedPixels = await decode(bytes, compression, {
+    const decoderMetadata = {
         sampleFormat,
         bitsPerSample,
         samplesPerPixel,
@@ -22,13 +19,20 @@ export async function fetchTile(self, x, y, options = {}) {
         height: self.tileHeight,
         predictor,
         planarConfiguration,
-    });
+        lercParameters,
+    };
+    const [decodedPixels, mask] = await Promise.all([
+        decodeTile(tileBytes, decoderMetadata, pool),
+        maskBytes != null && self.maskImage != null
+            ? decodeMask(maskBytes, self.maskImage, pool)
+            : Promise.resolve(null),
+    ]);
     const array = {
         ...decodedPixels,
         count: samplesPerPixel,
         height: self.tileHeight,
         width: self.tileWidth,
-        mask: null,
+        mask,
         transform: tileTransform,
         crs: self.crs,
         nodata: self.nodata,
@@ -36,11 +40,147 @@ export async function fetchTile(self, x, y, options = {}) {
     return {
         x,
         y,
-        array: options.boundless === false
-            ? clipToImageBounds(self, x, y, array)
-            : array,
+        array: boundless === true ? array : clipToImageBounds(self, x, y, array),
     };
 }
+async function decodeMask(mask, maskImage, pool) {
+    const maskSampleFormats = maskImage.value(TiffTag.SampleFormat) ?? [1];
+    const maskBitsPerSample = maskImage.value(TiffTag.BitsPerSample) ?? [8];
+    const { sampleFormat, bitsPerSample } = getUniqueSampleFormat(maskSampleFormats, new Uint16Array(maskBitsPerSample));
+    const { width, height } = maskImage.tileSize;
+    const metadata = {
+        sampleFormat,
+        bitsPerSample,
+        samplesPerPixel: maskImage.value(TiffTag.SamplesPerPixel) ?? 1,
+        width,
+        height,
+        predictor: maskImage.value(TiffTag.Predictor) ?? 1,
+        planarConfiguration: maskImage.value(TiffTag.PlanarConfiguration) ??
+            PlanarConfiguration.Contig,
+    };
+    const decoderFn = (bytes, compression, meta) => pool
+        ? pool.decode(bytes, compression, meta)
+        : decode(bytes, compression, meta);
+    const { bytes, compression } = mask;
+    const decoded = await decoderFn(bytes, compression, metadata);
+    const data = decoded.layout === "pixel-interleaved" ? decoded.data : decoded.bands[0];
+    if (data instanceof Uint8Array) {
+        return data;
+    }
+    throw new Error("Expected mask data to decode to Uint8Array");
+}
+async function decodeTile(tile, metadata, pool) {
+    const decoderFn = (bytes, compression, meta) => pool
+        ? pool.decode(bytes, compression, meta)
+        : decode(bytes, compression, meta);
+    if (Array.isArray(tile)) {
+        // Band-separate: each element is one band's compressed tile
+        const bandMetadata = { ...metadata, samplesPerPixel: 1 };
+        const decodedBands = await Promise.all(tile.map(({ bytes, compression }) => decoderFn(bytes, compression, bandMetadata)));
+        const bands = decodedBands.map((result) => result.layout === "band-separate" ? result.bands[0] : result.data);
+        return { layout: "band-separate", bands };
+    }
+    else {
+        // Pixel-interleaved: single compressed buffer covering all bands
+        // interleaved
+        const { bytes, compression } = tile;
+        return decoderFn(bytes, compression, metadata);
+    }
+}
+/** Fetch bytes from a COG, handling whether pixel/band interleaving. */
+async function fetchCogBytes(self, x, y, { signal, } = {}) {
+    switch (self.cachedTags.planarConfiguration) {
+        case PlanarConfiguration.Contig: {
+            const tile = await getTile(self.image, x, y, self.dataSource, { signal });
+            if (tile === null) {
+                throw new Error(`Tile at (${x}, ${y}) not found`);
+            }
+            return tile;
+        }
+        case PlanarConfiguration.Separate:
+            return await fetchBandSeparateTileBytes(self, x, y, { signal });
+        default:
+            throw new Error(`Unsupported PlanarConfiguration: ${self.cachedTags.planarConfiguration}`);
+    }
+}
+async function findBandSeparateTileByteRanges(self, x, y) {
+    // TODO: error here if user-provided band-indexes are out of bounds
+    const { x: tilesPerRow, y: tilesPerColumn } = self.image.tileCount;
+    const tilesPerBand = tilesPerRow * tilesPerColumn;
+    const numBands = self.cachedTags.samplesPerPixel;
+    const tileSizes = [...Array(numBands).keys()].map((band) => {
+        const bandIdx = band * tilesPerBand + y * tilesPerRow + x;
+        return self.image.getTileSize(bandIdx);
+    });
+    return Promise.all(tileSizes);
+}
+async function fetchBandSeparateTileBytes(self, x, y, { signal, } = {}) {
+    const byteRanges = await findBandSeparateTileByteRanges(self, x, y);
+    const buffers = byteRanges.map(async ({ offset, imageSize }) => {
+        const tile = await getBytes(self.image, offset, imageSize, self.dataSource, { signal });
+        if (tile === null) {
+            throw new Error(`Tile at (${x}, ${y}) not found`);
+        }
+        return tile;
+    });
+    return Promise.all(buffers);
+}
+/**
+ * Load a tile into a ArrayBuffer
+ *
+ * if the tile compression is JPEG, This will also apply the JPEG compression tables to the resulting ArrayBuffer see {@link getJpegHeader}
+ *
+ * Though this function lives upstream in @cogeotiff/core, we vendor it here so
+ * that we can use a custom fetch.
+ *
+ * This is to separate the source used for fetching header/IFD data (which is
+ * typically small and benefits from caching) from the source used for fetching
+ * tile data (which can be large and should avoid unnecessary copying through
+ * cache layers).
+ */
+async function getTile(image, x, y, source, options) {
+    const { size, tileSize: tiles } = image;
+    if (tiles == null)
+        throw new Error("Tiff is not tiled");
+    // TODO support GhostOptionTileOrder
+    const nyTiles = Math.ceil(size.height / tiles.height);
+    const nxTiles = Math.ceil(size.width / tiles.width);
+    if (x >= nxTiles || y >= nyTiles) {
+        throw new Error(`Tile index is outside of range x:${x} >= ${nxTiles} or y:${y} >= ${nyTiles}`);
+    }
+    const idx = y * nxTiles + x;
+    const totalTiles = nxTiles * nyTiles;
+    if (idx >= totalTiles)
+        throw new Error(`Tile index is outside of tile range: ${idx} >= ${totalTiles}`);
+    const { offset, imageSize } = await image.getTileSize(idx);
+    return getBytes(image, offset, imageSize, source, options);
+}
+/** Read image bytes at the given offset.
+ *
+ * Though this function lives upstream in @cogeotiff/core, we vendor it here so
+ * that we can use a custom fetch.
+ *
+ * This is to separate the source used for fetching header/IFD data (which is
+ * typically small and benefits from caching) from the source used for fetching
+ * tile data (which can be large and should avoid unnecessary copying through
+ * cache layers).
+ */
+async function getBytes(image, offset, byteCount, source, options) {
+    if (byteCount === 0)
+        return null;
+    const bytes = await source.fetch(offset, byteCount, options);
+    if (bytes.byteLength < byteCount) {
+        throw new Error(`Failed to fetch bytes from offset:${offset} wanted:${byteCount} got:${bytes.byteLength}`);
+    }
+    const compression = image.value(TiffTag.Compression) ?? Compression.None;
+    if (compression === Compression.Jpeg) {
+        return {
+            bytes: image.getJpegHeader(bytes),
+            compression,
+        };
+    }
+    return { bytes, compression };
+}
 /**
  * Clip a decoded tile array to the valid image bounds.
  *
@@ -59,41 +199,45 @@ function clipToImageBounds(self, x, y, array) {
     if (clippedWidth === self.tileWidth && clippedHeight === self.tileHeight) {
         return array;
     }
+    const clippedMask = array.mask
+        ? clipRows(array.mask, self.tileWidth, clippedWidth, clippedHeight, 1)
+        : array.mask;
     if (array.layout === "pixel-interleaved") {
         const { count, data } = array;
-        const Ctor = data.constructor;
-        const clipped = new Ctor(clippedWidth * clippedHeight * count);
-        for (let r = 0; r < clippedHeight; r++) {
-            const srcOffset = r * self.tileWidth * count;
-            const dstOffset = r * clippedWidth * count;
-            clipped.set(data.subarray(srcOffset, srcOffset + clippedWidth * count), dstOffset);
-        }
+        const clipped = clipRows(data, self.tileWidth, clippedWidth, clippedHeight, count);
         return {
             ...array,
             width: clippedWidth,
             height: clippedHeight,
             data: clipped,
+            mask: clippedMask,
         };
     }
     // band-separate
     const { bands } = array;
-    const Ctor = bands[0].constructor;
-    const clippedBands = bands.map((band) => {
-        const clipped = new Ctor(clippedWidth * clippedHeight);
-        for (let r = 0; r < clippedHeight; r++) {
-            const srcOffset = r * self.tileWidth;
-            const dstOffset = r * clippedWidth;
-            clipped.set(band.subarray(srcOffset, srcOffset + clippedWidth), dstOffset);
-        }
-        return clipped;
-    });
+    const clippedBands = bands.map((band) => clipRows(band, self.tileWidth, clippedWidth, clippedHeight, 1));
     return {
         ...array,
         width: clippedWidth,
         height: clippedHeight,
         bands: clippedBands,
+        mask: clippedMask,
     };
 }
+/**
+ * Copy rows from a strided typed array, keeping only `clippedWidth * samplesPerPixel`
+ * values per row out of `tileWidth * samplesPerPixel`.
+ */
+function clipRows(src, tileWidth, clippedWidth, clippedHeight, samplesPerPixel) {
+    const srcStride = tileWidth * samplesPerPixel;
+    const dstStride = clippedWidth * samplesPerPixel;
+    // @ts-expect-error — typed array constructors are not in a common interface
+    const dst = new src.constructor(dstStride * clippedHeight);
+    for (let r = 0; r < clippedHeight; r++) {
+        dst.set(src.subarray(r * srcStride, r * srcStride + dstStride), r * dstStride);
+    }
+    return dst;
+}
 function getUniqueSampleFormat(sampleFormats, bitsPerSamples) {
     const uniqueSampleFormats = new Set(sampleFormats);
     const uniqueBitsPerSample = new Set(bitsPerSamples);

package/dist/fetch.js.map

@@ -1 +1 @@
-{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AA4BrC,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,IAAsB,EACtB,CAAS,EACT,CAAS,EACT,UAAyD,EAAE;IAE3D,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;IACpC,CAAC;IAED,MAAM,EACJ,aAAa,EAAE,cAAc,EAC7B,SAAS,EACT,mBAAmB,EACnB,YAAY,EAAE,aAAa,GAC5B,GAAG,IAAI,CAAC,UAAU,CAAC;IACpB,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACpC,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,qBAAqB,CAC3D,aAAa,EACb,cAAc,CACf,CAAC;IAEF,MAAM,aAAa,GAAG,OAAO,CAC3B,IAAI,CAAC,SAAS,EACd,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CACrD,CAAC;IAEF,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAEvE,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE;QACrD,YAAY;QACZ,aAAa;QACb,eAAe;QACf,KAAK,EAAE,IAAI,CAAC,SAAS;QACrB,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,SAAS;QACT,mBAAmB;KACpB,CAAC,CAAC;IAEH,MAAM,KAAK,GAAgB;QACzB,GAAG,aAAa;QAChB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,KAAK,EAAE,IAAI,CAAC,SAAS;QACrB,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,aAAa;QACxB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,MAAM,EAAE,IAAI,CAAC,MAAM;KACpB,CAAC;IAEF,OAAO;QACL,CAAC;QACD,CAAC;QACD,KAAK,EACH,OAAO,CAAC,SAAS,KAAK,KAAK;YACzB,CAAC,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;YACtC,CAAC,CAAC,KAAK;KACZ,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,iBAAiB,CACxB,IAAsB,EACtB,CAAS,EACT,CAAS,EACT,KAAkB;IAElB,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,GAClD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEjC,mCAAmC;IACnC,IAAI,YAAY,KAAK,IAAI,CAAC,SAAS,IAAI,aAAa,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;QACzE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,KAAK,CAAC,MAAM,KAAK,mBAAmB,EAAE,CAAC;QACzC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,WAA6C,CAAC;QAChE,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,YAAY,GAAG,aAAa,GAAG,KAAK,CAAC,CAAC;QAC/D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YAC7C,MAAM,SAAS,GAAG,CAAC,GAAG,YAAY,GAAG,KAAK,CAAC;YAC3C,OAAO,CAAC,GAAG,CACT,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,YAAY,GAAG,KAAK,CAAC,EAC1D,SAAS,CACV,CAAC;QACJ,CAAC;QACD,OAAO;YACL,GAAG,KAAK;YACR,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,OAAO;SACd,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACxB,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,WAEI,CAAC;IAC5B,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACtC,MAAM,OAAO,GAAG,IAAI,IAAI,CAAC,YAAY,GAAG,aAAa,CAAC,CAAC;QACvD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;YACrC,MAAM,SAAS,GAAG,CAAC,GAAG,YAAY,CAAC;YACnC,OAAO,CAAC,GAAG,CACT,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,YAAY,CAAC,EAClD,SAAS,CACV,CAAC;QACJ,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,KAAK;QACR,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,YAAY;KACpB,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAC5B,aAA6B,EAC7B,cAA2B;IAE3B,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC;IACnD,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;IAEpD,IAAI,mBAAmB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,mBAAmB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAExC,IAAI,YAAY,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO;QACL,YAAY;QACZ,aAAa;KACd,CAAC;AACJ,CAAC"}
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC5E,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAI/D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAgCrC,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,IAAsB,EACtB,CAAS,EACT,CAAS,EACT,EACE,SAAS,GAAG,IAAI,EAChB,IAAI,EACJ,MAAM,MAKJ,EAAE;IAEN,MAAM,SAAS,GAAG,aAAa,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;IACxD,MAAM,SAAS,GACb,IAAI,CAAC,SAAS,IAAI,IAAI;QACpB,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC;QAC5D,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5B,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;IAEzE,MAAM,EACJ,aAAa,EAAE,cAAc,EAC7B,SAAS,EACT,mBAAmB,EACnB,YAAY,EAAE,aAAa,EAC3B,cAAc,GACf,GAAG,IAAI,CAAC,UAAU,CAAC;IACpB,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,qBAAqB,CAC3D,aAAa,EACb,cAAc,CACf,CAAC;IAEF,MAAM,aAAa,GAAG,OAAO,CAC3B,IAAI,CAAC,SAAS,EACd,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CACrD,CAAC;IAEF,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAEvE,MAAM,eAAe,GAAG;QACtB,YAAY;QACZ,aAAa;QACb,eAAe;QACf,KAAK,EAAE,IAAI,CAAC,SAAS;QACrB,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,SAAS;QACT,mBAAmB;QACnB,cAAc;KACf,CAAC;IACF,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC9C,UAAU,CAAC,SAAS,EAAE,eAAe,EAAE,IAAI,CAAC;QAC5C,SAAS,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI;YACzC,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC;YAC7C,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;KAC1B,CAAC,CAAC;IAEH,MAAM,KAAK,GAAgB;QACzB,GAAG,aAAa;QAChB,KAAK,EAAE,eAAe;QACtB,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,KAAK,EAAE,IAAI,CAAC,SAAS;QACrB,IAAI;QACJ,SAAS,EAAE,aAAa;QACxB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,MAAM,EAAE,IAAI,CAAC,MAAM;KACpB,CAAC;IAEF,OAAO;QACL,CAAC;QACD,CAAC;QACD,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;KACzE,CAAC;AACJ,CAAC;AAKD,KAAK,UAAU,UAAU,CACvB,IAAsB,EACtB,SAAoB,EACpB,IAA6B;IAE7B,MAAM,iBAAiB,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvE,MAAM,iBAAiB,GAAG,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxE,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,qBAAqB,CAC3D,iBAAmC,EACnC,IAAI,WAAW,CAAC,iBAA6B,CAAC,CAC/C,CAAC;IACF,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC,QAAQ,CAAC;IAC7C,MAAM,QAAQ,GAAoB;QAChC,YAAY;QACZ,aAAa;QACb,eAAe,EAAE,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC;QAC9D,KAAK;QACL,MAAM;QACN,SAAS,EAAE,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC;QAClD,mBAAmB,EACjB,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC;YAC5C,mBAAmB,CAAC,MAAM;KAC7B,CAAC;IAEF,MAAM,SAAS,GAAG,CAChB,KAAkB,EAClB,WAAwB,EACxB,IAAqB,EACG,EAAE,CAC1B,IAAI;QACF,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC;QACvC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAEvC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;IACpC,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC9D,MAAM,IAAI,GACR,OAAO,CAAC,MAAM,KAAK,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC;IAC5E,IAAI,IAAI,YAAY,UAAU,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;AAChE,CAAC;AAED,KAAK,UAAU,UAAU,CACvB,IAA2C,EAC3C,QAAyB,EACzB,IAA6B;IAE7B,MAAM,SAAS,GAAG,CAChB,KAAkB,EAClB,WAAwB,EACxB,IAAqB,EACG,EAAE,CAC1B,IAAI;QACF,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC;QACvC,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC;IAEvC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,4DAA4D;QAC5D,MAAM,YAAY,GAAG,EAAE,GAAG,QAAQ,EAAE,eAAe,EAAE,CAAC,EAAE,CAAC;QACzD,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CACpC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAClC,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,YAAY,CAAC,CAC5C,CACF,CAAC;QACF,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CACxC,MAAM,CAAC,MAAM,KAAK,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CACnE,CAAC;QACF,OAAO,EAAE,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,CAAC;IAC5C,CAAC;SAAM,CAAC;QACN,iEAAiE;QACjE,cAAc;QACd,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC;QACpC,OAAO,SAAS,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAED,wEAAwE;AACxE,KAAK,UAAU,aAAa,CAC1B,IAAsB,EACtB,CAAS,EACT,CAAS,EACT,EACE,MAAM,MAGJ,EAAE;IAEN,QAAQ,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC;QAC5C,KAAK,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;YAChC,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YAC1E,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;YACpD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,KAAK,mBAAmB,CAAC,QAAQ;YAC/B,OAAO,MAAM,0BAA0B,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;QAClE;YACE,MAAM,IAAI,KAAK,CACb,oCAAoC,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAC1E,CAAC;IACN,CAAC;AACH,CAAC;AAED,KAAK,UAAU,8BAA8B,CAC3C,IAAsB,EACtB,CAAS,EACT,CAAS;IAET,mEAAmE;IACnE,MAAM,EAAE,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IACnE,MAAM,YAAY,GAAG,WAAW,GAAG,cAAc,CAAC;IAClD,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACzD,MAAM,OAAO,GAAG,IAAI,GAAG,YAAY,GAAG,CAAC,GAAG,WAAW,GAAG,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAChC,CAAC;AAED,KAAK,UAAU,0BAA0B,CACvC,IAAsB,EACtB,CAAS,EACT,CAAS,EACT,EACE,MAAM,MAGJ,EAAE;IAEN,MAAM,UAAU,GAAG,MAAM,8BAA8B,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE;QAC7D,MAAM,IAAI,GAAG,MAAM,QAAQ,CACzB,IAAI,CAAC,KAAK,EACV,MAAM,EACN,SAAS,EACT,IAAI,CAAC,UAAU,EACf,EAAE,MAAM,EAAE,CACX,CAAC;QACF,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,KAAK,UAAU,OAAO,CACpB,KAAgB,EAChB,CAAS,EACT,CAAS,EACT,MAA6B,EAC7B,OAAkC;IAKlC,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IAExC,IAAI,KAAK,IAAI,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAExD,oCAAoC;IACpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;IAEpD,IAAI,CAAC,IAAI,OAAO,IAAI,CAAC,IAAI,OAAO,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,oCAAoC,CAAC,OAAO,OAAO,SAAS,CAAC,OAAO,OAAO,EAAE,CAC9E,CAAC;IACJ,CAAC;IAED,MAAM,GAAG,GAAG,CAAC,GAAG,OAAO,GAAG,CAAC,CAAC;IAC5B,MAAM,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IACrC,IAAI,GAAG,IAAI,UAAU;QACnB,MAAM,IAAI,KAAK,CACb,wCAAwC,GAAG,OAAO,UAAU,EAAE,CAC/D,CAAC;IAEJ,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAE3D,OAAO,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,QAAQ,CACrB,KAAgB,EAChB,MAAc,EACd,SAAiB,EACjB,MAA6B,EAC7B,OAAkC;IAKlC,IAAI,SAAS,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC7D,IAAI,KAAK,CAAC,UAAU,GAAG,SAAS,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CACb,qCAAqC,MAAM,WAAW,SAAS,QAAQ,KAAK,CAAC,UAAU,EAAE,CAC1F,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC;IACzE,IAAI,WAAW,KAAK,WAAW,CAAC,IAAI,EAAE,CAAC;QACrC,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC;YACjC,WAAW;SACZ,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC;AAChC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAS,iBAAiB,CACxB,IAAsB,EACtB,CAAS,EACT,CAAS,EACT,KAAkB;IAElB,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,GAClD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEjC,mCAAmC;IACnC,IAAI,YAAY,KAAK,IAAI,CAAC,SAAS,IAAI,aAAa,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;QACzE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI;QAC5B,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC,CAAC;QACtE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC;IAEf,IAAI,KAAK,CAAC,MAAM,KAAK,mBAAmB,EAAE,CAAC;QACzC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAC9B,MAAM,OAAO,GAAG,QAAQ,CACtB,IAAI,EACJ,IAAI,CAAC,SAAS,EACd,YAAY,EACZ,aAAa,EACb,KAAK,CACN,CAAC;QACF,OAAO;YACL,GAAG,KAAK;YACR,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,aAAa;YACrB,IAAI,EAAE,OAAsB;YAC5B,IAAI,EAAE,WAAW;SAClB,CAAC;IACJ,CAAC;IAED,gBAAgB;IAChB,MAAM,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;IACxB,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAC5B,CAAC,IAAI,EAAE,EAAE,CACP,QAAQ,CACN,IAAI,EACJ,IAAI,CAAC,SAAS,EACd,YAAY,EACZ,aAAa,EACb,CAAC,CACa,CACnB,CAAC;IAEF,OAAO;QACL,GAAG,KAAK;QACR,KAAK,EAAE,YAAY;QACnB,MAAM,EAAE,aAAa;QACrB,KAAK,EAAE,YAAY;QACnB,IAAI,EAAE,WAAW;KAClB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,SAAS,QAAQ,CAMf,GAAM,EACN,SAAiB,EACjB,YAAoB,EACpB,aAAqB,EACrB,eAAuB;IAEvB,MAAM,SAAS,GAAG,SAAS,GAAG,eAAe,CAAC;IAC9C,MAAM,SAAS,GAAG,YAAY,GAAG,eAAe,CAAC;IACjD,4EAA4E;IAC5E,MAAM,GAAG,GAAM,IAAI,GAAG,CAAC,WAAW,CAAC,SAAS,GAAG,aAAa,CAAC,CAAC;IAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,EAAE,CAAC,EAAE,EAAE,CAAC;QACvC,GAAG,CAAC,GAAG,CACL,GAAG,CAAC,QAAQ,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC,GAAG,SAAS,GAAG,SAAS,CAAC,EACtD,CAAC,GAAG,SAAS,CACd,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,qBAAqB,CAC5B,aAA6B,EAC7B,cAA2B;IAE3B,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC;IACnD,MAAM,mBAAmB,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC;IAEpD,IAAI,mBAAmB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IACD,IAAI,mBAAmB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;IACxE,CAAC;IACD,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IACtC,MAAM,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAExC,IAAI,YAAY,KAAK,SAAS,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAC9D,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IAED,OAAO;QACL,YAAY;QACZ,aAAa;KACd,CAAC;AACJ,CAAC"}

package/dist/gdal-metadata.d.ts

@@ -0,0 +1,17 @@
+export type BandStatistics = {
+    max: number | null;
+    min: number | null;
+    mean: number | null;
+    std: number | null;
+    validPercent: number | null;
+};
+export type GDALMetadata = {
+    /** Mapping of 1-based band index to statistics. */
+    bandStatistics: Map<number, BandStatistics>;
+    offsets: number[];
+    scales: number[];
+};
+export declare function parseGDALMetadata(gdalMetadata: string | null | undefined, { count }: {
+    count: number;
+}): GDALMetadata | null;
+//# sourceMappingURL=gdal-metadata.d.ts.map

package/dist/gdal-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gdal-metadata.d.ts","sourceRoot":"","sources":["../src/gdal-metadata.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,mDAAmD;IACnD,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,wBAAgB,iBAAiB,CAC/B,YAAY,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACvC,EAAE,KAAK,EAAE,EAAE;IAAE,KAAK,EAAE,MAAM,CAAA;CAAE,GAC3B,YAAY,GAAG,IAAI,CAgErB"}

package/dist/gdal-metadata.js

@@ -0,0 +1,59 @@
+export function parseGDALMetadata(gdalMetadata, { count }) {
+    if (gdalMetadata == null)
+        return null;
+    const parser = new DOMParser();
+    const doc = parser.parseFromString(gdalMetadata, "text/xml");
+    const root = doc.documentElement;
+    if (root.tagName !== "GDALMetadata") {
+        throw new Error("Not a GDALMetadata XML block");
+    }
+    const bandStatistics = new Map();
+    const offsets = Array(count).fill(0);
+    const scales = Array(count).fill(1);
+    const getOrCreateBand = (sample) => {
+        const idx = parseInt(sample, 10) + 1; // 1-based
+        if (!bandStatistics.has(idx)) {
+            bandStatistics.set(idx, {
+                max: null,
+                min: null,
+                mean: null,
+                std: null,
+                validPercent: null,
+            });
+        }
+        return bandStatistics.get(idx);
+    };
+    for (const elem of Array.from(root.querySelectorAll("Item"))) {
+        const name = elem.getAttribute("name");
+        const sample = elem.getAttribute("sample");
+        const text = elem.textContent ?? "";
+        if (sample === null) {
+            continue;
+        }
+        switch (name) {
+            case "STATISTICS_MAXIMUM":
+                getOrCreateBand(sample).max = parseFloat(text);
+                break;
+            case "STATISTICS_MEAN":
+                getOrCreateBand(sample).mean = parseFloat(text);
+                break;
+            case "STATISTICS_MINIMUM":
+                getOrCreateBand(sample).min = parseFloat(text);
+                break;
+            case "STATISTICS_STDDEV":
+                getOrCreateBand(sample).std = parseFloat(text);
+                break;
+            case "STATISTICS_VALID_PERCENT":
+                getOrCreateBand(sample).validPercent = parseFloat(text);
+                break;
+            case "OFFSET":
+                offsets[parseInt(sample, 10)] = parseFloat(text);
+                break;
+            case "SCALE":
+                scales[parseInt(sample, 10)] = parseFloat(text);
+                break;
+        }
+    }
+    return { bandStatistics, offsets, scales };
+}
+//# sourceMappingURL=gdal-metadata.js.map

package/dist/gdal-metadata.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gdal-metadata.js","sourceRoot":"","sources":["../src/gdal-metadata.ts"],"names":[],"mappings":"AAeA,MAAM,UAAU,iBAAiB,CAC/B,YAAuC,EACvC,EAAE,KAAK,EAAqB;IAE5B,IAAI,YAAY,IAAI,IAAI;QAAE,OAAO,IAAI,CAAC;IAEtC,MAAM,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;IAC/B,MAAM,GAAG,GAAG,MAAM,CAAC,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,GAAG,CAAC,eAAe,CAAC;IAEjC,IAAI,IAAI,CAAC,OAAO,KAAK,cAAc,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IAClD,CAAC;IAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAA0B,CAAC;IACzD,MAAM,OAAO,GAAG,KAAK,CAAS,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAG,KAAK,CAAS,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE5C,MAAM,eAAe,GAAG,CAAC,MAAc,EAAkB,EAAE;QACzD,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,UAAU;QAChD,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC7B,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE;gBACtB,GAAG,EAAE,IAAI;gBACT,GAAG,EAAE,IAAI;gBACT,IAAI,EAAE,IAAI;gBACV,GAAG,EAAE,IAAI;gBACT,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;QACL,CAAC;QACD,OAAO,cAAc,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;IAClC,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;QAEpC,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YACpB,SAAS;QACX,CAAC;QAED,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,oBAAoB;gBACvB,eAAe,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,iBAAiB;gBACpB,eAAe,CAAC,MAAM,CAAC,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAChD,MAAM;YACR,KAAK,oBAAoB;gBACvB,eAAe,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,mBAAmB;gBACtB,eAAe,CAAC,MAAM,CAAC,CAAC,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAC/C,MAAM;YACR,KAAK,0BAA0B;gBAC7B,eAAe,CAAC,MAAM,CAAC,CAAC,YAAY,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBACxD,MAAM;YACR,KAAK,QAAQ;gBACX,OAAO,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBACjD,MAAM;YACR,KAAK,OAAO;gBACV,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAChD,MAAM;QACV,CAAC;IACH,CAAC;IAED,OAAO,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;AAC7C,CAAC"}

package/dist/geotiff.d.ts

@@ -1,30 +1,46 @@
-import type { Source, TiffImage } from "@cogeotiff/core";
+import type { Source, TiffImage, TiffImageTileCount } from "@cogeotiff/core";
 import { Tiff } from "@cogeotiff/core";
 import type { Affine } from "@developmentseed/affine";
 import type { ProjJson } from "./crs.js";
+import type { BandStatistics, GDALMetadata } from "./gdal-metadata.js";
 import type { CachedTags, GeoKeyDirectory } from "./ifd.js";
 import { Overview } from "./overview.js";
+import type { DecoderPool } from "./pool/pool.js";
 import type { Tile } from "./tile.js";
 /**
- * A higher-level GeoTIFF abstraction built on @cogeotiff/core.
+ * A high-level GeoTIFF abstraction built on
+ * {@link https://github.com/blacha/cogeotiff | @cogeotiff/core}'s `Tiff` and
+ * `TiffImage` classes.
  *
- * Separates data IFDs from mask IFDs, pairs them by resolution level,
- * and exposes sorted overviews.  Mirrors the Python async-geotiff API.
+ * This class separates data IFDs from mask IFDs, pairs them by resolution
+ * level, and exposes sorted overviews. Intentionally mirrors the Python
+ * {@link https://github.com/developmentseed/async-geotiff | async-geotiff} API
+ * as closely as possible.
  *
- * Construct via `GeoTIFF.open(source)` or `GeoTIFF.fromTiff(tiff)`.
+ * Construct via {@link GeoTIFF.fromUrl}, {@link GeoTIFF.fromArrayBuffer},
+ * {@link GeoTIFF.open} or {@link GeoTIFF.fromTiff}.
+ *
+ * @see {@link Overview} for reduced-resolution overview images.
  */
 export declare class GeoTIFF {
     /**
      * Reduced-resolution overview levels, sorted finest-to-coarsest.
      *
-     * Does not include the full-resolution image — use `fetchTile` / methods
-     * on the GeoTIFF instance itself for that.
+     * Does not include the full-resolution image — use {@link fetchTile} on the
+     * GeoTIFF instance itself for that.
      */
     readonly overviews: Overview[];
     /** A cached CRS value. */
     private _crs?;
     /** Cached TIFF tags that are pre-fetched when opening the GeoTIFF. */
     readonly cachedTags: CachedTags;
+    /** The data source used for fetching tile data.
+     *
+     * This is typically the raw source (e.g. HTTP or memory) rather than a
+     * layered source with caching and chunking, to avoid unnecessary copying of
+     * tile data through cache layers.
+     */
+    readonly dataSource: Pick<Source, "fetch">;
     /** The underlying Tiff instance. */
     readonly tiff: Tiff;
     /** The primary (full-resolution) TiffImage. */
@@ -33,21 +49,53 @@ export declare class GeoTIFF {
     readonly maskImage: TiffImage | null;
     /** The GeoKeyDirectory of the primary IFD. */
     readonly gkd: GeoKeyDirectory;
+    /** Parsed GDALMetadata tag, if present. */
+    readonly gdalMetadata: GDALMetadata | null;
     private constructor();
     /**
      * Open a GeoTIFF from a @cogeotiff/core Source.
      *
      * This creates and initialises the underlying Tiff, then classifies IFDs.
+     *
+     * @param options.dataSource A source for fetching tile data. This is separate from the source used to construct the TIFF to allow for separate caching implementations.
+     * @param options.headerSource The source used to construct the TIFF. This is typically a layered source with caching and chunking, to optimise access to TIFF tags and IFDs.
+     * @param options.prefetch Number of bytes to prefetch when reading TIFF tags and IFDs. Defaults to 32KB, which is enough for most tags and small IFDs. Increase if you have many tags or large IFDs.
      */
-    static open(source: Source): Promise<GeoTIFF>;
+    static open(options: {
+        dataSource: Pick<Source, "fetch">;
+        headerSource: Source;
+        prefetch?: number;
+    }): Promise<GeoTIFF>;
     /**
      * Create a GeoTIFF from an already-initialised Tiff instance.
      *
      * All IFDs are walked; mask IFDs are matched to data IFDs by matching
      * (width, height).  Overviews are sorted from finest to coarsest resolution.
+     *
+     * @param dataSource A source for fetching tile data. This is separate from the source used to construct the TIFF to allow for separate caching implementations.
+     */
+    static fromTiff(tiff: Tiff, dataSource: Pick<Source, "fetch">): Promise<GeoTIFF>;
+    /**
+     * Create a GeoTIFF from an ArrayBuffer containing the entire file.
+     *
+     * This is a convenience method that wraps the ArrayBuffer in a memory source
+     * and calls {@link GeoTIFF.open}. For large files, consider using
+     * {@link GeoTIFF.fromUrl} or {@link GeoTIFF.open} with a chunked HTTP source
+     * to avoid loading the entire file into memory at once.
+     *
+     * @param input The ArrayBuffer containing the GeoTIFF file data.
+     * @returns A Promise that resolves to a GeoTIFF instance.
      */
-    static fromTiff(tiff: Tiff): Promise<GeoTIFF>;
     static fromArrayBuffer(input: ArrayBuffer): Promise<GeoTIFF>;
+    /**
+     * Create a new GeoTIFF from a URL.
+     *
+     * @param url The URL of the GeoTIFF to open.
+     * @param options Optional parameters for chunk size and cache size.
+     * @param options.chunkSize The minimum size for each request made to the source while reading header metadata. Defaults to 32KB.
+     * @param options.cacheSize The size of the cache for recently accessed header chunks. Currently no caching is applied to data fetches. Defaults to 1MB.
+     * @returns A Promise that resolves to a GeoTIFF instance.
+     */
     static fromUrl(url: string | URL, { chunkSize, cacheSize, }?: {
         chunkSize?: number;
         cacheSize?: number;
@@ -65,14 +113,37 @@ export declare class GeoTIFF {
     get width(): number;
     /** Image height in pixels. */
     get height(): number;
+    /** The number of tiles in the x and y directions */
+    get tileCount(): TiffImageTileCount;
     /** Tile width in pixels. */
     get tileWidth(): number;
     /** Tile height in pixels. */
     get tileHeight(): number;
-    /** The NoData value, or null if not set. */
+    /** The no data value, or null if not set. */
     get nodata(): number | null;
     /** Whether the primary image is tiled. */
     get isTiled(): boolean;
+    /**
+     * The pre-existing statistics for each band, if available.
+     *
+     * Extracted from the GDALMetadata TIFF tag; never computed on demand.
+     * Keys are **1-based** band indices to match GDAL's convention.
+     *
+     * Returns `null` if no statistics are stored in the file.
+     */
+    get storedStats(): ReadonlyMap<number, BandStatistics> | null;
+    /**
+     * The offset for each band (0-indexed), defaulting to 0.
+     *
+     * Extracted from the GDALMetadata TIFF tag.
+     */
+    get offsets(): number[];
+    /**
+     * The scale for each band (0-indexed), defaulting to 1.
+     *
+     * Extracted from the GDALMetadata TIFF tag.
+     */
+    get scales(): number[];
     /** Number of bands (samples per pixel). */
     get count(): number;
     /** Bounding box [minX, minY, maxX, maxY] in the CRS. */
@@ -81,9 +152,18 @@ export declare class GeoTIFF {
      * Return the dataset's georeferencing transformation matrix.
      */
     get transform(): Affine;
-    /** Fetch a single tile from the full-resolution image. */
+    /** Fetch a single tile from the full-resolution image.
+     *
+     * @param x The tile column index (0-based).
+     * @param y The tile row index (0-based).
+     * @param options Optional parameters for fetching the tile.
+     * @param options.boundless Whether to clip tiles that are partially outside the image bounds. When `true`, no clipping is applied. Defaults to `true`.
+     * @param options.pool An optional {@link DecoderPool} for decoding the tile data. If not provided, a new decoder will be created for each tile.
+     * @param options.signal An optional {@link AbortSignal} to cancel the fetch request.
+     */
     fetchTile(x: number, y: number, options?: {
         boundless?: boolean;
+        pool?: DecoderPool;
         signal?: AbortSignal;
     }): Promise<Tile>;
     /**

package/dist/geotiff.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"geotiff.d.ts","sourceRoot":"","sources":["../src/geotiff.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAA4B,IAAI,EAAW,MAAM,iBAAiB,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE5D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGtC;;;;;;;GAOG;AACH,qBAAa,OAAO;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;IAE/B,0BAA0B;IAC1B,OAAO,CAAC,IAAI,CAAC,CAAoB;IAEjC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,+CAA+C;IAC/C,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAE1B,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAErC,8CAA8C;IAC9C,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC;IAE9B,OAAO;IAgBP;;;;OAIG;WACU,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKnD;;;;;OAKG;WACU,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;WAmEtC,eAAe,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;WAKrD,OAAO,CAClB,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,EACE,SAAqB,EACrB,SAA8B,GAC/B,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACjD,OAAO,CAAC,OAAO,CAAC;IAcnB;;;;;;;OAOG;IACH,IAAI,GAAG,IAAI,MAAM,GAAG,QAAQ,CAK3B;IAED,6BAA6B;IAC7B,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,8BAA8B;IAC9B,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,4BAA4B;IAC5B,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,6BAA6B;IAC7B,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,4CAA4C;IAC5C,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAE1B;IAED,0CAA0C;IAC1C,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,2CAA2C;IAC3C,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,wDAAwD;IACxD,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAE3C;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CA2BtB;IAID,0DAA0D;IACpD,SAAS,CACb,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,OAAO,GAAE;QAAE,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,WAAW,CAAA;KAAO,GAC1D,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;;;;;OAQG;IACH,KAAK,CACH,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,EAAE,GAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAmB,GACrC,CAAC,MAAM,EAAE,MAAM,CAAC;IAInB;;;;;;;OAOG;IACH,EAAE,CACA,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAe,GACtD,CAAC,MAAM,EAAE,MAAM,CAAC;CAGpB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CASnD"}
+{"version":3,"file":"geotiff.d.ts","sourceRoot":"","sources":["../src/geotiff.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAA4B,IAAI,EAAW,MAAM,iBAAiB,CAAC;AAC1E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAGzC,OAAO,KAAK,EAAE,cAAc,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvE,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE5D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAGtC;;;;;;;;;;;;;;GAcG;AACH,qBAAa,OAAO;IAClB;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,QAAQ,EAAE,CAAC;IAE/B,0BAA0B;IAC1B,OAAO,CAAC,IAAI,CAAC,CAAoB;IAEjC,sEAAsE;IACtE,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE3C,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,+CAA+C;IAC/C,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC;IAE1B,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC;IAErC,8CAA8C;IAC9C,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC;IAE9B,2CAA2C;IAC3C,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAE3C,OAAO;IAoBP;;;;;;;;OAQG;WACU,IAAI,CAAC,OAAO,EAAE;QACzB,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,GAAG,OAAO,CAAC,OAAO,CAAC;IAQpB;;;;;;;OAOG;WACU,QAAQ,CACnB,IAAI,EAAE,IAAI,EACV,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,OAAO,CAAC,OAAO,CAAC;IA+EnB;;;;;;;;;;OAUG;WACU,eAAe,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;IAQlE;;;;;;;;OAQG;WACU,OAAO,CAClB,GAAG,EAAE,MAAM,GAAG,GAAG,EACjB,EACE,SAAqB,EACrB,SAAuB,GACxB,GAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAO,GACjD,OAAO,CAAC,OAAO,CAAC;IAiCnB;;;;;;;OAOG;IACH,IAAI,GAAG,IAAI,MAAM,GAAG,QAAQ,CAK3B;IAED,6BAA6B;IAC7B,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,8BAA8B;IAC9B,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,oDAAoD;IACpD,IAAI,SAAS,IAAI,kBAAkB,CAElC;IAED,4BAA4B;IAC5B,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,6BAA6B;IAC7B,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,6CAA6C;IAC7C,IAAI,MAAM,IAAI,MAAM,GAAG,IAAI,CAE1B;IAED,0CAA0C;IAC1C,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;;;;OAOG;IACH,IAAI,WAAW,IAAI,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,GAAG,IAAI,CAG5D;IAED;;;;OAIG;IACH,IAAI,OAAO,IAAI,MAAM,EAAE,CAEtB;IAED;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,EAAE,CAErB;IAED,2CAA2C;IAC3C,IAAI,KAAK,IAAI,MAAM,CAElB;IAED,wDAAwD;IACxD,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAE3C;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAStB;IAID;;;;;;;;OAQG;IACG,SAAS,CACb,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,OAAO,GAAE;QACP,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,IAAI,CAAC,EAAE,WAAW,CAAC;QACnB,MAAM,CAAC,EAAE,WAAW,CAAC;KACjB,GACL,OAAO,CAAC,IAAI,CAAC;IAMhB;;;;;;;;OAQG;IACH,KAAK,CACH,CAAC,EAAE,MAAM,EACT,CAAC,EAAE,MAAM,EACT,EAAE,GAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAmB,GACrC,CAAC,MAAM,EAAE,MAAM,CAAC;IAInB;;;;;;;OAOG;IACH,EAAE,CACA,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,QAAQ,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAe,GACtD,CAAC,MAAM,EAAE,MAAM,CAAC;CAGpB;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CASnD"}