@loaders.gl/geotiff 4.2.0-alpha.4 → 4.2.0-alpha.6

package/dist/lib/utils/proxies.ts.disabled

@@ -1,96 +0,0 @@
-// loaders.gl
-// SPDX-License-Identifier: MIT
-// Copyright (c) vis.gl contributors
-
-import type {GeoTIFF} from 'geotiff';
-import type Pool from './Pool';
-
-const VIV_PROXY_KEY = '__viv';
-const OFFSETS_PROXY_KEY = `${VIV_PROXY_KEY}-offsets` as const;
-const POOL_PROXY_KEY = `${VIV_PROXY_KEY}-decoder-pool` as const;
-
-/*
- * Inspect if the GeoTIFF source is wrapped in our proxies,
- * and warn if missing.
- */
-export function checkProxies(tiff: GeoTIFF) {
-  if (!isProxy(tiff, OFFSETS_PROXY_KEY)) {
-    console.warn('GeoTIFF source is missing offsets proxy.'); // eslint-disable-line no-console
-  }
-
-  if (!isProxy(tiff, POOL_PROXY_KEY)) {
-    console.warn('GeoTIFF source is missing decoder-pool proxy.'); // eslint-disable-line no-console
-  }
-}
-
-/*
- * > isProxy(tiff, POOL_PROXY_KEY) === true; // false
- * > tiff = createPoolProxy(tiff, new Pool());
- * > isProxy(tiff, POOL_PROXY_KEY) === true; // true
- */
-function isProxy(tiff: GeoTIFF, proxyFlag: string) {
-  return (tiff as any)[proxyFlag] as boolean;
-}
-
-/*
- * Creates an ES6 Proxy that wraps a GeoTIFF object. The proxy
- * handler intercepts calls to `tiff.getImage` and uses our custom
- * pre-computed offsets to pre-fetch the correct file directory.
- *
- * This is a bit of a hack. Internally GeoTIFF inspects `this.ifdRequests`
- * to see which fileDirectories need to be traversed. By adding the
- * ifdRequest for an 'index' manually, GeoTIFF will await that request
- * rather than traversing the file system remotely.
- */
-export function createOffsetsProxy(tiff: GeoTIFF, offsets: number[]) {
-  const get = (target: GeoTIFF, key: any) => {
-    // Intercept `tiff.getImage`
-    if (key === 'getImage') {
-      return (index: number) => {
-        // Manually add ifdRequest to tiff if missing and we have an offset.
-        if (!(index in target.ifdRequests) && index in offsets) {
-          const offset = offsets[index];
-          target.ifdRequests[index] = target.parseFileDirectoryAt(offset);
-        }
-        return target.getImage(index);
-      };
-    }
-
-    // tiff['__viv-offsets'] === true
-    if (key === OFFSETS_PROXY_KEY) {
-      return true;
-    }
-
-    return Reflect.get(target, key);
-  };
-  return new Proxy(tiff, {get});
-}
-
-/*
- * Creates an ES6 Proxy that wraps a GeoTIFF object. The proxy
- * handler intercepts calls to `tiff.readRasters` and injects
- * a pool argument to every call. This means our TiffPixelSource
- * doesn't need to be aware of whether a decoder pool is in use.
- *
- * > tiff.readRasters({ window }) -> tiff.readRasters({ window, pool });
- */
-export function createPoolProxy(tiff: GeoTIFF, pool: Pool) {
-  const get = (target: GeoTIFF, key: any) => {
-    // Intercept calls to `image.readRasters`
-    if (key === 'readRasters') {
-      return (options: Parameters<typeof target.readRasters>) => {
-        // Inject `pool` argument with other raster options.
-        // @ts-ignore
-        return target.readRasters({...options, pool});
-      };
-    }
-
-    // tiff['__viv-decoder-pool'] === true
-    if (key === POOL_PROXY_KEY) {
-      return true;
-    }
-
-    return Reflect.get(target, key);
-  };
-  return new Proxy(tiff, {get});
-}

package/dist/lib/utils/tiff-utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tiff-utils.js","names":["ensureArray","x","Array","isArray","intToRgba","int","Number","isInteger","Error","buffer","ArrayBuffer","view","DataView","setInt32","bytes","Uint8Array","from","isInterleaved","shape","lastDimSize","length","getImageSize","source","interleaved","height","width","slice","SIGNAL_ABORTED"],"sources":["../../../src/lib/utils/tiff-utils.ts"],"sourcesContent":["// loaders.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\n\nimport type {PixelSource} from '../../types';\n\nexport function ensureArray<T>(x: T | T[]) {\n  return Array.isArray(x) ? x : [x];\n}\n\n/*\n * Converts 32-bit integer color representation to RGBA tuple.\n * Used to serialize colors from OME-XML metadata.\n *\n * > console.log(intToRgba(100100));\n * > // [0, 1, 135, 4]\n */\nexport function intToRgba(int: number) {\n  if (!Number.isInteger(int)) {\n    throw Error('Not an integer.');\n  }\n\n  // Write number to int32 representation (4 bytes).\n  const buffer = new ArrayBuffer(4);\n  const view = new DataView(buffer);\n  view.setInt32(0, int, false); // offset === 0, littleEndian === false\n\n  // Take u8 view and extract number for each byte (1 byte for R/G/B/A).\n  const bytes = new Uint8Array(buffer);\n  return Array.from(bytes) as [number, number, number, number];\n}\n\n/*\n * Helper method to determine whether pixel data is interleaved or not.\n * > isInterleaved([1, 24, 24]) === false;\n * > isInterleaved([1, 24, 24, 3]) === true;\n */\nexport function isInterleaved(shape: number[]) {\n  const lastDimSize = shape[shape.length - 1];\n  return lastDimSize === 3 || lastDimSize === 4;\n}\n\nexport function getImageSize<T extends string[]>(source: PixelSource<T>) {\n  const interleaved = isInterleaved(source.shape);\n  const [height, width] = source.shape.slice(interleaved ? -3 : -2);\n  return {height, width};\n}\n\nexport const SIGNAL_ABORTED = '__vivSignalAborted';\n"],"mappings":"AAMA,OAAO,SAASA,WAAWA,CAAIC,CAAU,EAAE;EACzC,OAAOC,KAAK,CAACC,OAAO,CAACF,CAAC,CAAC,GAAGA,CAAC,GAAG,CAACA,CAAC,CAAC;AACnC;AASA,OAAO,SAASG,SAASA,CAACC,GAAW,EAAE;EACrC,IAAI,CAACC,MAAM,CAACC,SAAS,CAACF,GAAG,CAAC,EAAE;IAC1B,MAAMG,KAAK,CAAC,iBAAiB,CAAC;EAChC;EAGA,MAAMC,MAAM,GAAG,IAAIC,WAAW,CAAC,CAAC,CAAC;EACjC,MAAMC,IAAI,GAAG,IAAIC,QAAQ,CAACH,MAAM,CAAC;EACjCE,IAAI,CAACE,QAAQ,CAAC,CAAC,EAAER,GAAG,EAAE,KAAK,CAAC;EAG5B,MAAMS,KAAK,GAAG,IAAIC,UAAU,CAACN,MAAM,CAAC;EACpC,OAAOP,KAAK,CAACc,IAAI,CAACF,KAAK,CAAC;AAC1B;AAOA,OAAO,SAASG,aAAaA,CAACC,KAAe,EAAE;EAC7C,MAAMC,WAAW,GAAGD,KAAK,CAACA,KAAK,CAACE,MAAM,GAAG,CAAC,CAAC;EAC3C,OAAOD,WAAW,KAAK,CAAC,IAAIA,WAAW,KAAK,CAAC;AAC/C;AAEA,OAAO,SAASE,YAAYA,CAAqBC,MAAsB,EAAE;EACvE,MAAMC,WAAW,GAAGN,aAAa,CAACK,MAAM,CAACJ,KAAK,CAAC;EAC/C,MAAM,CAACM,MAAM,EAAEC,KAAK,CAAC,GAAGH,MAAM,CAACJ,KAAK,CAACQ,KAAK,CAACH,WAAW,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;EACjE,OAAO;IAACC,MAAM;IAAEC;EAAK,CAAC;AACxB;AAEA,OAAO,MAAME,cAAc,GAAG,oBAAoB"}

package/dist/loaders.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"loaders.js","names":["fromArrayBuffer","VERSION","loadGeoTiff","data","options","tiff","image","getImage","rgbData","readRGB","enableAlpha","width","getWidth","height","getHeight","imageData","ImageData","set","Uint8ClampedArray","bounds","GeoTiffLoader","id","name","module","version","mimeTypes","extensions","parse"],"sources":["../src/loaders.ts"],"sourcesContent":["import {fromArrayBuffer} from 'geotiff';\nimport type {LoaderWithParser, LoaderOptions} from '@loaders.gl/loader-utils';\n\n// __VERSION__ is injected by babel-plugin-version-inline\n// @ts-ignore TS2304: Cannot find name '__VERSION__'.\nconst VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'latest';\n\n// Type definitions\ntype GeoTiffData = {\n  bounds: number[];\n  width: number;\n  height: number;\n  imageData: ImageData;\n};\n\ninterface GeoTiffLoaderOptions extends LoaderOptions {\n  enableAlpha: boolean;\n}\n\n/**\n * Loads a GeoTIFF file containing a RGB image.\n */\nconst loadGeoTiff = async (\n  data: ArrayBuffer,\n  options?: GeoTiffLoaderOptions\n): Promise<GeoTiffData> => {\n  // Load using Geotiff.js\n  const tiff = await fromArrayBuffer(data);\n\n  // Assumes we only have one image inside TIFF\n  const image = await tiff.getImage();\n\n  // Read image and size\n  // TODO: Add support for worker pools here.\n  // TODO: Add support for more image formats.\n  const rgbData = await image.readRGB({\n    enableAlpha: options?.enableAlpha\n  });\n  const width = image.getWidth();\n  const height = image.getHeight();\n\n  // Create a new ImageData object\n  const imageData = new ImageData(width, height);\n  imageData.data.set(new Uint8ClampedArray(rgbData as unknown as Uint8Array));\n\n  // Return GeoJSON data\n  return {\n    // TODO: Add bounds here\n    bounds: [],\n    imageData,\n    width,\n    height\n  };\n};\n\n// Export loader\nexport const GeoTiffLoader: LoaderWithParser<GeoTiffData, never, GeoTiffLoaderOptions> = {\n  id: 'geotiff',\n  name: 'GeoTIFF',\n  module: 'geotiff',\n  version: VERSION,\n  options: {\n    enableAlpha: true\n  },\n  mimeTypes: ['image/tiff', 'image/geotiff'],\n  extensions: ['geotiff', 'tiff', 'geotif', 'tif'],\n  parse: loadGeoTiff\n};\n"],"mappings":"AAAA,SAAQA,eAAe,QAAO,SAAS;AAKvC,MAAMC,OAAO,GAAG,sBAAkB,KAAK,WAAW,qBAAiB,QAAQ;AAiB3E,MAAMC,WAAW,GAAG,MAAAA,CAClBC,IAAiB,EACjBC,OAA8B,KACL;EAEzB,MAAMC,IAAI,GAAG,MAAML,eAAe,CAACG,IAAI,CAAC;EAGxC,MAAMG,KAAK,GAAG,MAAMD,IAAI,CAACE,QAAQ,CAAC,CAAC;EAKnC,MAAMC,OAAO,GAAG,MAAMF,KAAK,CAACG,OAAO,CAAC;IAClCC,WAAW,EAAEN,OAAO,aAAPA,OAAO,uBAAPA,OAAO,CAAEM;EACxB,CAAC,CAAC;EACF,MAAMC,KAAK,GAAGL,KAAK,CAACM,QAAQ,CAAC,CAAC;EAC9B,MAAMC,MAAM,GAAGP,KAAK,CAACQ,SAAS,CAAC,CAAC;EAGhC,MAAMC,SAAS,GAAG,IAAIC,SAAS,CAACL,KAAK,EAAEE,MAAM,CAAC;EAC9CE,SAAS,CAACZ,IAAI,CAACc,GAAG,CAAC,IAAIC,iBAAiB,CAACV,OAAgC,CAAC,CAAC;EAG3E,OAAO;IAELW,MAAM,EAAE,EAAE;IACVJ,SAAS;IACTJ,KAAK;IACLE;EACF,CAAC;AACH,CAAC;AAGD,OAAO,MAAMO,aAAyE,GAAG;EACvFC,EAAE,EAAE,SAAS;EACbC,IAAI,EAAE,SAAS;EACfC,MAAM,EAAE,SAAS;EACjBC,OAAO,EAAEvB,OAAO;EAChBG,OAAO,EAAE;IACPM,WAAW,EAAE;EACf,CAAC;EACDe,SAAS,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC;EAC1CC,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,CAAC;EAChDC,KAAK,EAAEzB;AACT,CAAC"}

package/dist/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["// loaders.gl\n// SPDX-License-Identifier: MIT\n// Copyright (c) vis.gl contributors\n\nimport {DTYPE_LOOKUP} from './lib/ome/ome-utils';\n\nexport type Dtype = (typeof DTYPE_LOOKUP)[keyof typeof DTYPE_LOOKUP];\nexport type TypedArray = InstanceType<(typeof globalThis)[`${Dtype}Array`]>;\n\nexport interface PixelData {\n  data: TypedArray;\n  width: number;\n  height: number;\n}\n\nexport type PixelSourceSelection<S extends string[]> = {\n  [K in S[number]]: number;\n};\n\nexport interface RasterSelection<S extends string[]> {\n  selection: PixelSourceSelection<S>;\n  signal?: AbortSignal;\n}\n\nexport interface TileSelection<S extends string[]> {\n  x: number;\n  y: number;\n  selection: PixelSourceSelection<S>;\n  signal?: AbortSignal;\n}\n\ninterface PhysicalSize {\n  size: number;\n  unit: string;\n}\n\nexport interface PixelSourceMeta {\n  physicalSizes?: Record<string, PhysicalSize>;\n  photometricInterpretation?: number;\n}\n\nexport type Labels<S extends string[]> = [...S, 'y', 'x'] | [...S, 'y', 'x', '_c'];\n\n/**\n * Interface to load tiles from a data source\n */\nexport interface PixelSource<S extends string[]> {\n  /** Loads a 2D plane */\n  getRaster(sel: RasterSelection<S>): Promise<PixelData>;\n  /** Loads a tile */\n  getTile(sel: TileSelection<S>): Promise<PixelData>;\n  onTileError(err: Error): void;\n  shape: number[];\n  dtype: Dtype;\n  labels: Labels<S>;\n  tileSize: number;\n  meta?: PixelSourceMeta;\n}\n"],"mappings":""}