Class: NVImage

Defined in: nvimage/index.ts:29

a NVImage encapsulates some image data and provides methods to query and operate on images

Constructors

Constructor

new NVImage(
   dataBuffer: ArrayBufferLike | ArrayBuffer[],
   name: string,
   colormap: string,
   opacity: number,
   pairedImgData: ArrayBuffer,
   cal_min: number,
   cal_max: number,
   trustCalMinMax: boolean,
   percentileFrac: number,
   ignoreZeroVoxels: boolean,
   useQFormNotSForm: boolean,
   colormapNegative: string,
   frame4D: number,
   imageType: ImageType,
   cal_minNeg: number,
   cal_maxNeg: number,
   colorbarVisible: boolean,
   colormapLabel: LUT,
   colormapType: number): NVImage;

Defined in: nvimage/index.ts:110

Parameters

Parameter	Type	Default value
dataBuffer	ArrayBufferLike | ArrayBuffer[]	null
name	string	''
colormap	string	'gray'
opacity	number	1.0
pairedImgData	ArrayBuffer	null
cal_min	number	NaN
cal_max	number	NaN
trustCalMinMax	boolean	true
percentileFrac	number	0.02
ignoreZeroVoxels	boolean	false
useQFormNotSForm	boolean	false
colormapNegative	string	''
frame4D	number	0
imageType	ImageType	NVIMAGE_TYPE.UNKNOWN
cal_minNeg	number	NaN
cal_maxNeg	number	NaN
colorbarVisible	boolean	true
colormapLabel	LUT	null
colormapType	number	0

Returns

NVImage

Properties

Property	Type	Default value	Defined in
_colormap	string	undefined	nvimage/index.ts:34
_opacity	number	undefined	nvimage/index.ts:35
cal_max?	number	undefined	nvimage/index.ts:96
cal_maxNeg	number	undefined	nvimage/index.ts:47
cal_min?	number	undefined	nvimage/index.ts:95
cal_minNeg	number	undefined	nvimage/index.ts:46
colorbarVisible	boolean	true	nvimage/index.ts:48
colormapInvert?	boolean	undefined	nvimage/index.ts:42
colormapLabel	LUT	undefined	nvimage/index.ts:41
colormapNegative	string	undefined	nvimage/index.ts:39
colormapType?	number	undefined	nvimage/index.ts:59
dims?	number[]	undefined	nvimage/index.ts:85
dimsRAS?	number[]	undefined	nvimage/index.ts:65
extensions?	NIFTIEXTENSION[]	undefined	nvimage/index.ts:79
extentsMaxOrtho?	number[]	undefined	nvimage/index.ts:75
extentsMinOrtho?	number[]	undefined	nvimage/index.ts:74
fileObject?	File | File[]	undefined	nvimage/index.ts:84
frac2mm?	mat4	undefined	nvimage/index.ts:72
frac2mmOrtho?	mat4	undefined	nvimage/index.ts:73
frame4D	number	undefined	nvimage/index.ts:44
global_max?	number	undefined	nvimage/index.ts:100
global_min?	number	undefined	nvimage/index.ts:99
hdr	NIFTI1 | NIFTI2	null	nvimage/index.ts:78
headers?	Record<string, string>	undefined	nvimage/index.ts:33
id	string	undefined	nvimage/index.ts:31
ignoreZeroVoxels	boolean	undefined	nvimage/index.ts:37
imageType?	ImageType	undefined	nvimage/index.ts:80
imaginary?	Float32Array	undefined	nvimage/index.ts:82
img?	TypedVoxelArray	undefined	nvimage/index.ts:81
img2RASstart?	number[]	undefined	nvimage/index.ts:68
img2RASstep?	number[]	undefined	nvimage/index.ts:67
isManifest?	boolean	undefined	nvimage/index.ts:104
limitFrames4D?	number	undefined	nvimage/index.ts:105
matRAS?	mat4	undefined	nvimage/index.ts:62
maxShearDeg?	number	undefined	nvimage/index.ts:56
mm000?	vec3	undefined	nvimage/index.ts:90
mm001?	vec3	undefined	nvimage/index.ts:93
mm010?	vec3	undefined	nvimage/index.ts:92
mm100?	vec3	undefined	nvimage/index.ts:91
mm2ortho?	mat4	undefined	nvimage/index.ts:76
modulateAlpha	number	0	nvimage/index.ts:50
modulationImage	number	null	nvimage/index.ts:49
name	string	undefined	nvimage/index.ts:30
nFrame4D?	number	undefined	nvimage/index.ts:43
nTotalFrame4D?	number	undefined	nvimage/index.ts:45
nVox3D?	number	undefined	nvimage/index.ts:54
oblique_angle?	number	undefined	nvimage/index.ts:55
obliqueRAS?	mat4	undefined	nvimage/index.ts:64
onColormapChange	(img: NVImage) => void	undefined	nvimage/index.ts:87
onOpacityChange	(img: NVImage) => void	undefined	nvimage/index.ts:88
originalAffine?	number[][]	undefined	nvimage/index.ts:108
percentileFrac	number	undefined	nvimage/index.ts:36
permRAS?	number[]	undefined	nvimage/index.ts:66
pixDims?	number[]	undefined	nvimage/index.ts:61
pixDimsRAS?	number[]	undefined	nvimage/index.ts:63
robust_max?	number	undefined	nvimage/index.ts:98
robust_min?	number	undefined	nvimage/index.ts:97
series	any	[]	nvimage/index.ts:53
toRAS?	mat4	undefined	nvimage/index.ts:69
toRASvox?	mat4	undefined	nvimage/index.ts:70
trustCalMinMax	boolean	undefined	nvimage/index.ts:38
url?	string	undefined	nvimage/index.ts:32
urlImgData?	string	undefined	nvimage/index.ts:103
useQFormNotSForm	boolean	undefined	nvimage/index.ts:57
v1?	Float32Array	undefined	nvimage/index.ts:83

Accessors

colormap

Get Signature

get colormap(): string;

Defined in: nvimage/index.ts:754

Returns

string

Set Signature

set colormap(cm: string): void;

Defined in: nvimage/index.ts:763

Parameters

Parameter	Type
cm	string

Returns

void

---

colorMap

Get Signature

get colorMap(): string;

Defined in: nvimage/index.ts:758

Returns

string

Set Signature

set colorMap(cm: string): void;

Defined in: nvimage/index.ts:767

Parameters

Parameter	Type
cm	string

Returns

void

---

opacity

Get Signature

get opacity(): number;

Defined in: nvimage/index.ts:771

Returns

number

Set Signature

set opacity(opacity: number): void;

Defined in: nvimage/index.ts:775

Parameters

Parameter	Type
opacity	number

Returns

void

Methods

applyOptionsUpdate()

applyOptionsUpdate(options: ImageFromUrlOptions): void;

Defined in: nvimage/index.ts:1277

Update options for image

Parameters

Parameter	Type
options	ImageFromUrlOptions

Returns

void

---

applyTransform()

applyTransform(transform: AffineTransform): void;

Defined in: nvimage/index.ts:678

Apply a transform (translation, rotation, scale) to the current affine matrix. The transform is applied in world coordinate space: newAffine = transform * currentAffine Call updateGLVolume() on the Niivue instance after this to update rendering.

Parameters

Parameter	Type	Description
transform	AffineTransform	Transform to apply with translation (mm), rotation (degrees), and scale

Returns

void

---

arrayEquals()

arrayEquals(a: unknown[], b: unknown[]): boolean;

Defined in: nvimage/index.ts:732

Parameters

Parameter	Type
a	unknown[]
b	unknown[]

Returns

boolean

---

calculateOblique()

calculateOblique(): void;

Defined in: nvimage/index.ts:436

Returns

void

---

calculateRAS()

calculateRAS(): void;

Defined in: nvimage/index.ts:644

Returns

void

---

calMinMax()

calMinMax(vol: number, isBorder: boolean): number[];

Defined in: nvimage/index.ts:786

set contrast/brightness to robust range (2%..98%)

Parameters

Parameter	Type	Default value	Description
vol	number	Number.POSITIVE_INFINITY	volume for estimate (use -1 to use estimate on all loaded volumes; use INFINITY for current volume)
isBorder	boolean	true	if true (default) only center of volume used for estimate

Returns

number[]

volume brightness and returns array [pct2, pct98, mnScale, mxScale]

See

live demo usage

---

clone()

clone(): NVImage;

Defined in: nvimage/index.ts:1204

make a clone of a NVImage instance and return a new NVImage

Returns

NVImage

Example

myImage = NVImage.loadFromFile(SomeFileObject); // files can be from dialogs or drag and drop
clonedImage = myImage.clone();

---

computeObliqueAngle()

computeObliqueAngle(mtx44: mat4): number;

Defined in: nvimage/index.ts:422

Parameters

Parameter	Type
mtx44	mat4

Returns

number

---

convertFrac2MM()

convertFrac2MM(frac: vec3, isForceSliceMM: boolean): vec4;

Defined in: nvimage/index.ts:1306

Parameters

Parameter	Type	Default value
frac	vec3	undefined
isForceSliceMM	boolean	false

Returns

vec4

---

convertFrac2Vox()

convertFrac2Vox(frac: vec3): vec3;

Defined in: nvimage/index.ts:1301

Parameters

Parameter	Type
frac	vec3

Returns

vec3

---

convertMM2Frac()

convertMM2Frac(mm:
  | Float32Array
  | [number, number, number]
  | [number, number, number, number], isForceSliceMM: boolean): vec3;

Defined in: nvimage/index.ts:1311

Parameters

Parameter	Type	Default value
mm	| Float32Array | [number, number, number] | [number, number, number, number]	undefined
isForceSliceMM	boolean	false

Returns

vec3

---

convertVox2Frac()

convertVox2Frac(vox: vec3): vec3;

Defined in: nvimage/index.ts:1296

Parameters

Parameter	Type
vox	vec3

Returns

vec3

---

float32V1asRGBA()

float32V1asRGBA(inImg: Float32Array): Uint8Array;

Defined in: nvimage/index.ts:426

Parameters

Parameter	Type
inImg	Float32Array

Returns

Uint8Array

---

getAffine()

getAffine(): number[][];

Defined in: nvimage/index.ts:652

Get a deep copy of the current affine matrix.

Returns

number[][]

A 4x4 affine matrix as a 2D array (row-major)

---

getImageMetadata()

getImageMetadata(): ImageMetadata;

Defined in: nvimage/index.ts:1230

get nifti specific metadata about the image

Returns

ImageMetadata

---

getImageOptions()

getImageOptions(): ImageFromUrlOptions;

Defined in: nvimage/index.ts:1281

Returns

ImageFromUrlOptions

---

getValue()

getValue(
   x: number,
   y: number,
   z: number,
   frame4D: number,
   isReadImaginary: boolean): number;

Defined in: nvimage/index.ts:1262

Returns voxel intensity at specific native coordinates. Delegates to VolumeUtils.getValue.

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
z	number	undefined
frame4D	number	0
isReadImaginary	boolean	false

Returns

number

---

getValues()

getValues(
   x: number,
   y: number,
   z: number,
   frame4D: number,
   isReadImaginary: boolean): number[];

Defined in: nvimage/index.ts:1270

Returns voxel intensities at specific native coordinates. Delegates to VolumeUtils.getValue.

Parameters

Parameter	Type	Default value
x	number	undefined
y	number	undefined
z	number	undefined
frame4D	number	0
isReadImaginary	boolean	false

Returns

number[]

---

getVolumeData()

getVolumeData(
   voxStart: number[],
   voxEnd: number[],
   dataType: string): [TypedVoxelArray, number[]];

Defined in: nvimage/index.ts:1119

read a 3D slab of voxels from a volume, specified in RAS coordinates. Delegates to VolumeUtils.getVolumeData.

Parameters

Parameter	Type	Default value
voxStart	number[]	...
voxEnd	number[]	...
dataType	string	'same'

Returns

[TypedVoxelArray, number[]]

---

hdr2RAS()

hdr2RAS(nVolumes: number): Promise<NIFTI1 | NIFTI2>;

Defined in: nvimage/index.ts:706

Parameters

Parameter	Type	Default value
nVolumes	number	1

Returns

Promise<NIFTI1 | NIFTI2>

---

imageDataFromArrayBuffer()

imageDataFromArrayBuffer(buffer: ArrayBuffer): Promise<ImageData>;

Defined in: nvimage/index.ts:589

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ImageData>

---

img2RAS()

img2RAS(nVolume: number): TypedVoxelArray;

Defined in: nvimage/index.ts:713

Parameters

Parameter	Type	Default value
nVolume	number	0

Returns

TypedVoxelArray

---

init()

init(
   dataBuffer: ArrayBufferLike | ArrayBuffer[],
   name: string,
   colormap: string,
   opacity: number,
   _pairedImgData: ArrayBuffer,
   cal_min: number,
   cal_max: number,
   trustCalMinMax: boolean,
   percentileFrac: number,
   ignoreZeroVoxels: boolean,
   useQFormNotSForm: boolean,
   colormapNegative: string,
   frame4D: number,
   imageType: ImageType,
   cal_minNeg: number,
   cal_maxNeg: number,
   colorbarVisible: boolean,
   colormapLabel: LUT,
   colormapType: number,
   imgRaw: ArrayBufferLike): void;

Defined in: nvimage/index.ts:157

Parameters

Parameter	Type	Default value
dataBuffer	ArrayBufferLike | ArrayBuffer[]	null
name	string	''
colormap	string	''
opacity	number	1.0
_pairedImgData	ArrayBuffer	null
cal_min	number	NaN
cal_max	number	NaN
trustCalMinMax	boolean	true
percentileFrac	number	0.02
ignoreZeroVoxels	boolean	false
useQFormNotSForm	boolean	false
colormapNegative	string	''
frame4D	number	0
imageType	ImageType	NVIMAGE_TYPE.UNKNOWN
cal_minNeg	number	NaN
cal_maxNeg	number	NaN
colorbarVisible	boolean	true
colormapLabel	LUT	null
colormapType	number	0
imgRaw	ArrayBufferLike	null

Returns

void

---

intensityRaw2Scaled()

intensityRaw2Scaled(raw: number): number;

Defined in: nvimage/index.ts:792

Parameters

Parameter	Type
raw	number

Returns

number

---

intensityScaled2Raw()

intensityScaled2Raw(scaled: number): number;

Defined in: nvimage/index.ts:797

Parameters

Parameter	Type
scaled	number

Returns

number

---

loadImgV1()

loadImgV1(
   isFlipX: boolean,
   isFlipY: boolean,
   isFlipZ: boolean): boolean;

Defined in: nvimage/index.ts:430

Parameters

Parameter	Type	Default value
isFlipX	boolean	false
isFlipY	boolean	false
isFlipZ	boolean	false

Returns

boolean

---

mm2vox()

mm2vox(mm: number[], frac: boolean): vec3;

Defined in: nvimage/index.ts:725

Parameters

Parameter	Type	Default value
mm	number[]	undefined
frac	boolean	false

Returns

vec3

---

readBMP()

readBMP(buffer: ArrayBuffer): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:593

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readECAT()

readECAT(buffer: ArrayBuffer): ArrayBuffer;

Defined in: nvimage/index.ts:573

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

ArrayBuffer

---

readFIB()

readFIB(buffer: ArrayBuffer): Promise<[ArrayBuffer, Float32Array]>;

Defined in: nvimage/index.ts:611

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<[ArrayBuffer, Float32Array]>

---

readHEAD()

readHEAD(dataBuffer: ArrayBuffer, pairedImgData: ArrayBuffer): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:624

Parameters

Parameter	Type
dataBuffer	ArrayBuffer
pairedImgData	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readMHA()

readMHA(buffer: ArrayBuffer, pairedImgData: ArrayBuffer): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:631

Parameters

Parameter	Type
buffer	ArrayBuffer
pairedImgData	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readMIF()

readMIF(buffer: ArrayBuffer, pairedImgData: ArrayBuffer): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:638

Parameters

Parameter	Type
buffer	ArrayBuffer
pairedImgData	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readNPY()

readNPY(buffer: ArrayBuffer): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:581

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readNPZ()

readNPZ(buffer: ArrayBuffer): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:585

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readSRC()

readSRC(buffer: ArrayBuffer): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:618

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readV16()

readV16(buffer: ArrayBuffer): ArrayBuffer;

Defined in: nvimage/index.ts:577

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

ArrayBuffer

---

readVMR()

readVMR(buffer: ArrayBuffer): ArrayBuffer;

Defined in: nvimage/index.ts:604

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

ArrayBuffer

---

readZARR()

readZARR(buffer: ArrayBuffer, zarrData: unknown): Promise<ArrayBufferLike>;

Defined in: nvimage/index.ts:597

Parameters

Parameter	Type
buffer	ArrayBuffer
zarrData	unknown

Returns

Promise<ArrayBufferLike>

---

resetAffine()

resetAffine(): void;

Defined in: nvimage/index.ts:692

Reset the affine matrix to its original state when the image was first loaded. Call updateGLVolume() on the Niivue instance after this to update rendering.

Returns

void

---

saveToDisk()

saveToDisk(fnm: string, drawing8: Uint8Array): Promise<Uint8Array>;

Defined in: nvimage/index.ts:814

save image as NIfTI volume and trigger download. Delegates to ImageWriter.saveToDisk.

Parameters

Parameter	Type	Default value
fnm	string	''
drawing8	Uint8Array	null

Returns

Promise<Uint8Array>

---

saveToUint8Array()

saveToUint8Array(fnm: string, drawing8: Uint8Array): Promise<Uint8Array>;

Defined in: nvimage/index.ts:805

Converts NVImage to NIfTI compliant byte array, potentially compressed. Delegates to ImageWriter.saveToUint8Array.

Parameters

Parameter	Type	Default value
fnm	string	undefined
drawing8	Uint8Array	null

Returns

Promise<Uint8Array>

---

setAffine()

setAffine(affine: number[][]): void;

Defined in: nvimage/index.ts:664

Set a new affine matrix and recalculate all derived RAS matrices. Call updateGLVolume() on the Niivue instance after this to update rendering.

Parameters

Parameter	Type	Description
affine	number[][]	A 4x4 affine matrix as a 2D array (row-major)

Returns

void

---

setColormap()

setColormap(cm: string): void;

Defined in: nvimage/index.ts:739

Parameters

Parameter	Type
cm	string

Returns

void

---

setColormapLabel()

setColormapLabel(cm: ColorMap): void;

Defined in: nvimage/index.ts:746

Parameters

Parameter	Type
cm	ColorMap

Returns

void

---

setColormapLabelFromUrl()

setColormapLabelFromUrl(url: string): Promise<void>;

Defined in: nvimage/index.ts:750

Parameters

Parameter	Type
url	string

Returns

Promise<void>

---

setVolumeData()

setVolumeData(
   voxStart: number[],
   voxEnd: number[],
   img: TypedVoxelArray): void;

Defined in: nvimage/index.ts:1133

write a 3D slab of voxels from a volume, specified in RAS coordinates. Delegates to VolumeUtils.setVolumeData. Input slabData is assumed to be in the correct raw data type for the target image.

Parameters

Parameter	Type
voxStart	number[]
voxEnd	number[]
img	TypedVoxelArray

Returns

void

---

toUint8Array()

toUint8Array(drawingBytes: Uint8Array): Uint8Array;

Defined in: nvimage/index.ts:1290

Converts NVImage to NIfTI compliant byte array. Handles potential re-orientation of drawing data. Delegates to ImageWriter.toUint8Array.

Parameters

Parameter	Type	Default value
drawingBytes	Uint8Array	null

Returns

Uint8Array

---

vox2mm()

vox2mm(XYZ: number[], mtx: mat4): vec3;

Defined in: nvimage/index.ts:719

Parameters

Parameter	Type
XYZ	number[]
mtx	mat4

Returns

vec3

---

zeroImage()

zeroImage(): void;

Defined in: nvimage/index.ts:1223

fill a NVImage instance with zeros for the image data

Returns

void

Example

myImage = NVImage.loadFromFile(SomeFileObject); // files can be from dialogs or drag and drop
clonedImageWithZeros = myImage.clone().zeroImage();

---

createNiftiArray()

static createNiftiArray(
   dims: number[],
   pixDims: number[],
   affine: number[],
   datatypeCode: NiiDataType,
   img: TypedVoxelArray): Uint8Array;

Defined in: nvimage/index.ts:1087

Creates a Uint8Array representing a NIFTI file (header + optional image data). Delegates to ImageWriter.createNiftiArray.

Parameters

Parameter	Type	Default value
dims	number[]	...
pixDims	number[]	...
affine	number[]	...
datatypeCode	NiiDataType	NiiDataType.DT_UINT8
img	TypedVoxelArray	...

Returns

Uint8Array

---

createNiftiHeader()

static createNiftiHeader(
   dims: number[],
   pixDims: number[],
   affine: number[],
   datatypeCode: NiiDataType): NIFTI1;

Defined in: nvimage/index.ts:1101

Creates a NIFTI1 header object with basic properties. Delegates to ImageWriter.createNiftiHeader.

Parameters

Parameter	Type	Default value
dims	number[]	...
pixDims	number[]	...
affine	number[]	...
datatypeCode	NiiDataType	NiiDataType.DT_UINT8

Returns

NIFTI1

---

extractFilenameFromUrl()

static extractFilenameFromUrl(url: string): string;

Defined in: nvimage/index.ts:827

Parameters

Parameter	Type
url	string

Returns

string

---

fetchDicomData()

static fetchDicomData(url: string, headers: Record<string, string>): Promise<object[]>;

Defined in: nvimage/index.ts:819

Parameters

Parameter	Type
url	string
headers	Record<string, string>

Returns

Promise<object[]>

---

loadFromBase64()

static loadFromBase64(__namedParameters: ImageFromBase64): Promise<NVImage>;

Defined in: nvimage/index.ts:1142

factory function to load and return a new NVImage instance from a base64 encoded string

Parameters

Parameter	Type
__namedParameters	ImageFromBase64

Returns

Promise<NVImage>

Example

myImage = NVImage.loadFromBase64("SomeBase64String");

---

loadFromFile()

static loadFromFile(__namedParameters: ImageFromFileOptions): Promise<NVImage>;

Defined in: nvimage/index.ts:993

factory function to load and return a new NVImage instance from a file in the browser

Parameters

Parameter	Type
__namedParameters	ImageFromFileOptions

Returns

Promise<NVImage>

---

loadFromUrl()

static loadFromUrl(__namedParameters: Partial<Omit<ImageFromUrlOptions, "url">> & object): Promise<NVImage>;

Defined in: nvimage/index.ts:842

factory function to load and return a new NVImage instance from a given URL

Parameters

Parameter	Type
__namedParameters	Partial<Omit<ImageFromUrlOptions, "url">> & object

Returns

Promise<NVImage>

---

loadInitialVolumes()

static loadInitialVolumes(
   url: string,
   headers: object,
limitFrames4D: number): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:835

Parameters

Parameter	Type	Default value
url	string	''
headers	{ }	{}
limitFrames4D	number	NaN

Returns

Promise<ArrayBuffer>

---

loadInitialVolumesGz()

static loadInitialVolumesGz(
   url: string,
   headers: object,
limitFrames4D: number): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:831

Parameters

Parameter	Type	Default value
url	string	''
headers	{ }	{}
limitFrames4D	number	NaN

Returns

Promise<ArrayBuffer>

---

new()

static new(
   dataBuffer: ArrayBufferLike | ArrayBuffer[],
   name: string,
   colormap: string,
   opacity: number,
   pairedImgData: ArrayBuffer,
   cal_min: number,
   cal_max: number,
   trustCalMinMax: boolean,
   percentileFrac: number,
   ignoreZeroVoxels: boolean,
   useQFormNotSForm: boolean,
   colormapNegative: string,
   frame4D: number,
   imageType: ImageType,
   cal_minNeg: number,
   cal_maxNeg: number,
   colorbarVisible: boolean,
   colormapLabel: LUT,
   colormapType: number,
zarrData: unknown): Promise<NVImage>;

Defined in: nvimage/index.ts:283

Parameters

Parameter	Type	Default value
dataBuffer	ArrayBufferLike | ArrayBuffer[]	null
name	string	''
colormap	string	''
opacity	number	1.0
pairedImgData	ArrayBuffer	null
cal_min	number	NaN
cal_max	number	NaN
trustCalMinMax	boolean	true
percentileFrac	number	0.02
ignoreZeroVoxels	boolean	false
useQFormNotSForm	boolean	false
colormapNegative	string	''
frame4D	number	0
imageType	ImageType	NVIMAGE_TYPE.UNKNOWN
cal_minNeg	number	NaN
cal_maxNeg	number	NaN
colorbarVisible	boolean	true
colormapLabel	LUT	null
colormapType	number	0
zarrData	unknown	undefined

Returns

Promise<NVImage>

---

readFileAsync()

static readFileAsync(file: File, bytesToLoad: number): Promise<ArrayBuffer>;

Defined in: nvimage/index.ts:986

Parameters

Parameter	Type	Default value
file	File	undefined
bytesToLoad	number	NaN

Returns

Promise<ArrayBuffer>

---

readFirstDecompressedBytes()

static readFirstDecompressedBytes(stream: ReadableStream<Uint8Array>, minBytes: number): Promise<Uint8Array>;

Defined in: nvimage/index.ts:823

Parameters

Parameter	Type
stream	ReadableStream<Uint8Array>
minBytes	number

Returns

Promise<Uint8Array>

---

zerosLike()

static zerosLike(nvImage: NVImage, dataType: string): NVImage;

Defined in: nvimage/index.ts:1240

a factory function to make a zero filled image given a NVImage as a reference

Parameters

Parameter	Type	Default value
nvImage	NVImage	undefined
dataType	string	'same'

Returns

NVImage

Example

myImage = NVImage.loadFromFile(SomeFileObject); // files can be from dialogs or drag and drop
newZeroImage = NVImage.zerosLike(myImage);