@openglobus/og 1.0.0-rc28 → 1.0.0-rc29

package/lib/Extent.d.ts

@@ -81,6 +81,13 @@ export declare class Extent {
      * @return {Extent} Extent clone.
      */
     clone(): Extent;
+    /**
+     * Creates union of this extent and another extent.
+     * @public
+     * @param {Extent} extent - Other extent.
+     * @return {Extent} Union extent.
+     */
+    createUnion(extent: Extent): Extent;
     /**
      * Gets the center coordinate of the extent.
      * @public

package/lib/layer/GeoTIFFLayer.d.ts

@@ -3,7 +3,7 @@ import { Material } from "./Material";
 import { BaseTileMaterialLayer } from "./BaseTileMaterialLayer";
 import type { LayerEventsList } from "./Layer";
 import type { Segment } from "../segment/Segment";
-import { GeoTIFFReader, type IGeoTIFFLayerParams, type IGeoTIFFMetadata, type IGeoTIFFRenderOptions, type DecodedTileData } from "./geotiff";
+import { type IGeoTIFFLayerParams, type IGeoTIFFMetadata, type IGeoTIFFReader, type IGeoTIFFRenderOptions, type IGeoTIFFSourceItem, type DecodedTileData } from "./geotiff";
 interface ICachedTile {
     image: ImageData;
     renderOptionsVersion: number;
@@ -20,7 +20,7 @@ type GeoTIFFEventsType = EventsHandler<GeoTIFFEventsList> & EventsHandler<LayerE
  */
 export declare class GeoTIFFLayer extends BaseTileMaterialLayer {
     events: GeoTIFFEventsType;
-    protected _reader: GeoTIFFReader;
+    protected _reader: IGeoTIFFReader;
     protected _renderOptions: IGeoTIFFRenderOptions;
     protected _tileSize: number;
     protected _tileCache: Map<string, ICachedTile>;
@@ -37,9 +37,10 @@ export declare class GeoTIFFLayer extends BaseTileMaterialLayer {
     constructor(name: string | null, options?: IGeoTIFFLayerParams);
     static fromUrl(name: string, url: string, options?: IGeoTIFFLayerParams): Promise<GeoTIFFLayer>;
     static fromBlob(name: string, blob: Blob | File, options?: IGeoTIFFLayerParams): Promise<GeoTIFFLayer>;
+    static fromSources(name: string, sources: IGeoTIFFSourceItem[], options?: IGeoTIFFLayerParams): Promise<GeoTIFFLayer>;
     get instanceName(): string;
     get isIdle(): boolean;
-    get reader(): GeoTIFFReader;
+    get reader(): IGeoTIFFReader;
     get metadata(): IGeoTIFFMetadata | null;
     get nodata(): number | null | undefined;
     set nodata(val: number | null | "nan" | "NaN" | undefined);
@@ -58,6 +59,7 @@ export declare class GeoTIFFLayer extends BaseTileMaterialLayer {
     redraw(): void;
     private _reapplyRenderOptions;
     private _initSource;
+    private _initSources;
     private _normalizeRenderOptions;
     private _updateReadSamples;
     loadMaterial(material: Material, forceLoading?: boolean): void;

package/lib/layer/geotiff/GeoTIFFReader.d.ts

@@ -1,10 +1,10 @@
 import { GeoTIFF, GeoTIFFImage, Pool } from "geotiff";
 import { Extent } from "../../Extent";
 import { Proj } from "../../proj/Proj";
-import type { DecodedTileData, IGeoTIFFLayerParams, IGeoTIFFMetadata, ProjFunc } from "./types";
+import type { DecodedTileData, GeoTIFFSource, IGeoTIFFMetadata, IGeoTIFFReader, IGeoTIFFReaderParams, IGeoTIFFRenderOptions, ProjFunc } from "./types";
 export declare function parseCrsCode(crs?: number | string): number | undefined;
-export declare class GeoTIFFReader {
-    options: IGeoTIFFLayerParams;
+export declare class GeoTIFFReader implements IGeoTIFFReader {
+    options: IGeoTIFFReaderParams;
     source: GeoTIFF | null;
     images: GeoTIFFImage[];
     workerPool: Pool | null;
@@ -16,13 +16,19 @@ export declare class GeoTIFFReader {
     reverseY: boolean;
     requestLevels: number[];
     isReady: boolean;
-    private _ownsWorkerPool;
+    private _poolHandle;
     private _projHelper;
-    constructor(options?: IGeoTIFFLayerParams);
+    private _activeReads;
+    private _destroyed;
+    constructor(options?: IGeoTIFFReaderParams);
     /**
      * Initializes and parses the GeoTIFF source and its overview pyramid.
      */
-    init(src: string | Blob | File | ArrayBuffer): Promise<IGeoTIFFMetadata>;
+    init(src: GeoTIFFSource): Promise<IGeoTIFFMetadata>;
+    /**
+     * Applies rendering options that affect decoding: nodata masking and the resampling method.
+     */
+    setRenderOptions(renderOptions: IGeoTIFFRenderOptions): void;
     /**
      * Reads raster data for a tile and warps it into the tile grid.
      *
@@ -35,7 +41,8 @@ export declare class GeoTIFFReader {
      * @param readSamples - Band indexes to read.
      * @param segmentProj - Projection of the segment the tile belongs to, EPSG:3857 by default.
      */
-    readTileRasters(tileExtentLonLat: Extent, _zoomLevel: number, tileSize?: number, readSamples?: number[], segmentProj?: Proj): Promise<DecodedTileData | null>;
+    readTileRasters(tileExtentLonLat: Extent, zoomLevel: number, tileSize?: number, readSamples?: number[], segmentProj?: Proj): Promise<DecodedTileData | null>;
+    private _readTileRasters;
     /**
      * Projects a lon/lat point into the raster coordinates, normalized to 0..1.
      */
@@ -63,6 +70,7 @@ export declare class GeoTIFFReader {
     private _getEffectiveNoData;
     private _getFillValue;
     private _checkIfReversed;
+    private _releasePool;
     /**
      * Cleans up worker pool and cached images.
      */

package/lib/layer/geotiff/MultiGeoTIFFReader.d.ts

@@ -0,0 +1,48 @@
+import { Extent } from "../../Extent";
+import type { Proj } from "../../proj/Proj";
+import type { Pool } from "geotiff";
+import { GeoTIFFReader } from "./GeoTIFFReader";
+import type { DecodedTileData, IGeoTIFFMetadata, IGeoTIFFReader, IGeoTIFFReaderParams, IGeoTIFFRenderOptions, IGeoTIFFSourceItem } from "./types";
+/**
+ * MultiGeoTIFFReader manages multiple Cloud-Optimized GeoTIFF (COG) sources,
+ * enabling multi-band compositing (e.g. RGB or NDVI across separate band files)
+ * and spatial mosaics (merging adjacent COG tiles into a unified layer).
+ */
+export declare class MultiGeoTIFFReader implements IGeoTIFFReader {
+    options: IGeoTIFFReaderParams;
+    childReaders: GeoTIFFReader[];
+    sources: IGeoTIFFSourceItem[];
+    metadata: IGeoTIFFMetadata | null;
+    extentWgs84: Extent;
+    isReady: boolean;
+    crsCode: number;
+    workerPool: Pool | null;
+    private _poolHandle;
+    private _bandMappings;
+    private _activeReads;
+    private _destroyed;
+    constructor(options?: IGeoTIFFReaderParams);
+    /**
+     * Initializes all GeoTIFF sources and builds unified extent and band mappings.
+     */
+    init(sources?: IGeoTIFFSourceItem[]): Promise<IGeoTIFFMetadata>;
+    /**
+     * Union of the native bounding boxes of all sources, valid only when they share a CRS.
+     */
+    private _unionNativeBBox;
+    /**
+     * Applies rendering options to this reader and to every child reader.
+     */
+    setRenderOptions(renderOptions: IGeoTIFFRenderOptions): void;
+    /**
+     * Reads rasters for a tile from the underlying GeoTIFF sources.
+     */
+    readTileRasters(tileExtentLonLat: Extent, zoomLevel: number, tileSize?: number, readSamples?: number[], segmentProj?: Proj): Promise<DecodedTileData | null>;
+    private _readMultiBandTileRasters;
+    private _readMosaicTileRasters;
+    private _releasePool;
+    /**
+     * Cleans up child readers and shared worker pool.
+     */
+    destroy(): void;
+}

package/lib/layer/geotiff/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./types";
 export * from "./ColorScale";
 export * from "./GeoTIFFReader";
+export * from "./MultiGeoTIFFReader";
+export * from "./workerPool";

package/lib/layer/geotiff/types.d.ts

@@ -1,7 +1,18 @@
 import type { IBaseTileMaterialLayerParams } from "../BaseTileMaterialLayer";
 import type { Pool, TypedArray } from "geotiff";
+import type { Extent } from "../../Extent";
+import type { Proj } from "../../proj/Proj";
 export type ColorScaleName = "viridis" | "inferno" | "turbo" | "magma" | "plasma" | "rainbow" | "jet" | "hsv" | "hot" | "cool" | "spring" | "summer" | "autumn" | "winter" | "bone" | "copper" | "greys" | "ylgnbu" | "greens" | "ylorrd" | "bluered" | "rdbu" | "picnic" | "portland" | "blackbody" | "earth" | "electric" | "redblue" | "coolwarm";
 export type ColorStop = [stopValue: number, color: string];
+/**
+ * GeoTIFF data source: a remote URL or a local binary.
+ */
+export type GeoTIFFSource = string | Blob | File | ArrayBuffer;
+export type NoDataValue = number | null | "nan" | "NaN";
+export interface IBandStats {
+    min: number;
+    max: number;
+}
 export interface ISingleBandRenderOptions {
     /** Band index (1-indexed), defaults to 1 */
     band?: number;
@@ -34,9 +45,9 @@ export interface IMultiBandRenderOptions {
 }
 export interface IGeoTIFFRenderOptions {
     /** NoData value (if not set, read from TIFF metadata). Set to null or NaN to disable nodata masking. */
-    nodata?: number | null | "nan" | "NaN";
+    nodata?: NoDataValue;
     /** Alias for nodata */
-    noData?: number | null | "nan" | "NaN";
+    noData?: NoDataValue;
     /** Treat 3-band/multi-band TIFF directly as RGB */
     convertToRGB?: boolean;
     /** Multi-band channel configuration */
@@ -62,27 +73,49 @@ export type ProjFunc = (code: number) => {
     project: (pos: number[]) => number[];
     unproject: (pos: number[]) => number[];
 } | undefined;
-export interface IGeoTIFFLayerParams extends IBaseTileMaterialLayerParams {
+/**
+ * Options shared by a single GeoTIFF source and by the reader that opens it.
+ */
+export interface IGeoTIFFSourceCommon {
     /** Remote URL or local Blob/File/ArrayBuffer */
-    src?: string | Blob | File | ArrayBuffer;
+    src?: GeoTIFFSource;
     /** Alias for src when passing a URL */
     url?: string;
     /** Custom NoData value. Set to null or NaN to disable nodata masking. */
-    nodata?: number | null | "nan" | "NaN";
+    nodata?: NoDataValue;
+    /** Alias for nodata */
+    noData?: NoDataValue;
     /** Optional CRS code or definition, e.g. 2193 or "EPSG:2193" */
     crs?: number | string;
-    /** Alias for nodata */
-    noData?: number | null | "nan" | "NaN";
-    /** Rendering and band options */
-    renderOptions?: IGeoTIFFRenderOptions;
     /** HTTP request options for geotiff.js range requests */
     requestOptions?: IGeoTIFFRequestOptions;
-    /** Custom geotiff Worker Pool instance */
+}
+export interface IGeoTIFFSourceItem extends IGeoTIFFSourceCommon {
+    /** Specific band indexes to read from this source (1-indexed). Defaults to all bands. */
+    bands?: number[];
+    /** Min value for this source's bands (used for contrast stretching) */
+    min?: number;
+    /** Max value for this source's bands (used for contrast stretching) */
+    max?: number;
+}
+/**
+ * Options used by a GeoTIFF reader.
+ */
+export interface IGeoTIFFReaderParams extends IGeoTIFFSourceCommon {
+    /** Multiple GeoTIFF/COG sources (like OpenLayers) */
+    sources?: IGeoTIFFSourceItem[];
+    /** When true, merges multiple sources spatially as a mosaic instead of stacking bands */
+    mosaic?: boolean;
+    /** Rendering and band options */
+    renderOptions?: IGeoTIFFRenderOptions;
+    /** Custom geotiff Worker Pool instance. It belongs to the caller and is never destroyed by a reader. */
     geotiffWorkerPool?: Pool;
-    /** Number of Web Workers for decompression (default: navigator.hardwareConcurrency || 2) */
+    /** Number of decompression workers. Uses a shared pool if not set. */
     workerPoolSize?: number;
     /** Custom projection mapping function for non-standard CRS */
     projFunc?: ProjFunc;
+}
+export interface IGeoTIFFLayerParams extends IBaseTileMaterialLayerParams, IGeoTIFFReaderParams {
     /** Output tile size (default: 256) */
     tileSize?: number;
     /** Maximum tile cache size (default: 500) */
@@ -90,6 +123,21 @@ export interface IGeoTIFFLayerParams extends IBaseTileMaterialLayerParams {
     /** Auto-calculate maximumLevel from COG overview count */
     useImageCountAsMaximumLevel?: boolean;
 }
+export interface IGeoTIFFReader {
+    options: IGeoTIFFReaderParams;
+    metadata: IGeoTIFFMetadata | null;
+    extentWgs84: Extent;
+    crsCode: number;
+    isReady: boolean;
+    workerPool: Pool | null;
+    init(src?: GeoTIFFSource | IGeoTIFFSourceItem[]): Promise<IGeoTIFFMetadata>;
+    /**
+     * Applies rendering options that affect decoding, such as nodata masking and the resampling method.
+     */
+    setRenderOptions(renderOptions: IGeoTIFFRenderOptions): void;
+    readTileRasters(tileExtentLonLat: Extent, zoomLevel: number, tileSize?: number, readSamples?: number[], segmentProj?: Proj): Promise<DecodedTileData | null>;
+    destroy(): void;
+}
 export interface IGeoTIFFMetadata {
     bbox: [number, number, number, number];
     crsCode: number;
@@ -99,10 +147,7 @@ export interface IGeoTIFFMetadata {
     noData: number | null;
     isTiled: boolean;
     overviewCount: number;
-    bands: Record<number, {
-        min: number;
-        max: number;
-    }>;
+    bands: Record<number, IBandStats | undefined>;
 }
 export interface DecodedTileData {
     rasters: TypedArray[];

package/lib/layer/geotiff/workerPool.d.ts

@@ -0,0 +1,23 @@
+import { Pool } from "geotiff";
+import type { IGeoTIFFReaderParams } from "./types";
+export declare const MAX_WORKER_POOL_SIZE = 4;
+/**
+ * A shared worker pool.
+ * Call release() when done.
+ * The pool is destroyed when no one uses it anymore.
+ */
+export interface IWorkerPoolHandle {
+    pool: Pool | null;
+    release(): void;
+}
+export declare function defaultWorkerPoolSize(): number;
+/**
+ * Gets a worker pool for a GeoTIFF reader.
+ *
+ * Uses the provided geotiffWorkerPool without destroying it.
+ * Creates a dedicated pool if workerPoolSize is set.
+ * Otherwise, shares a pool between readers.
+ *
+ * Returns null if workers are unavailable (decoding runs on the main thread).
+ */
+export declare function acquireWorkerPool(options: IGeoTIFFReaderParams): IWorkerPoolHandle;