Skip to content

ReadImageOptions

Defined in: image/image.ts:79

Options for readImage.

optional raw?: boolean;

Defined in: image/image.ts:87

Return the on-disk array without applying BZERO/BSCALE or the unsigned-integer convention. The native typed array for BITPIX is returned (Int16Array for 16, Float32Array for -32, …).


optional region?: ImageRegion;

Defined in: image/image.ts:81

A rectangular cutout; the whole image is read when omitted.


optional signal?: AbortSignal;

Defined in: image/image.ts:93

Cancels the read. A region over a large cube issues one sequential read per outer slab; the signal is checked before each, so an abort takes effect promptly and rejects with the signal’s reason.