Initial project import
This commit is contained in:
25
node_modules/@monogrid/gainmap-js/dist/decode/shared/extract.d.ts
generated
vendored
Normal file
25
node_modules/@monogrid/gainmap-js/dist/decode/shared/extract.d.ts
generated
vendored
Normal file
@@ -0,0 +1,25 @@
|
||||
/**
|
||||
* Extracts XMP Metadata and the gain map recovery image
|
||||
* from a single JPEG file.
|
||||
*
|
||||
* @category Decoding Functions
|
||||
* @group Decoding Functions
|
||||
* @param jpegFile an `Uint8Array` containing and encoded JPEG file
|
||||
* @returns an sdr `Uint8Array` compressed in JPEG, a gainMap `Uint8Array` compressed in JPEG and the XMP parsed XMP metadata
|
||||
* @throws Error if XMP Metadata is not found
|
||||
* @throws Error if Gain map image is not found
|
||||
* @example
|
||||
* import { FileLoader } from 'three'
|
||||
* import { extractGainmapFromJPEG } from '@monogrid/gainmap-js'
|
||||
*
|
||||
* const jpegFile = await new FileLoader()
|
||||
* .setResponseType('arraybuffer')
|
||||
* .loadAsync('image.jpg')
|
||||
*
|
||||
* const { sdr, gainMap, metadata } = extractGainmapFromJPEG(jpegFile)
|
||||
*/
|
||||
export declare const extractGainmapFromJPEG: (jpegFile: Uint8Array<ArrayBuffer>) => Promise<{
|
||||
sdr: Uint8Array<ArrayBuffer>;
|
||||
gainMap: Uint8Array<ArrayBuffer>;
|
||||
metadata: import("..").GainMapMetadata;
|
||||
}>;
|
||||
Reference in New Issue
Block a user