Class: NVImage

Defined in: nvimage/index.ts:30

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:114

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:35
_hasExplicitZarrCenter	boolean	false	nvimage/index.ts:92
_opacity	number	undefined	nvimage/index.ts:36
cal_max?	number	undefined	nvimage/index.ts:100
cal_maxNeg	number	undefined	nvimage/index.ts:48
cal_min?	number	undefined	nvimage/index.ts:99
cal_minNeg	number	undefined	nvimage/index.ts:47
colorbarVisible	boolean	true	nvimage/index.ts:49
colormapInvert?	boolean	undefined	nvimage/index.ts:43
colormapLabel	LUT	undefined	nvimage/index.ts:42
colormapNegative	string	undefined	nvimage/index.ts:40
colormapType?	number	undefined	nvimage/index.ts:60
dims?	number[]	undefined	nvimage/index.ts:86
dimsRAS?	number[]	undefined	nvimage/index.ts:66
extensions?	NIFTIEXTENSION[]	undefined	nvimage/index.ts:80
extentsMaxOrtho?	number[]	undefined	nvimage/index.ts:76
extentsMinOrtho?	number[]	undefined	nvimage/index.ts:75
fileObject?	File | File[]	undefined	nvimage/index.ts:85
frac2mm?	mat4	undefined	nvimage/index.ts:73
frac2mmOrtho?	mat4	undefined	nvimage/index.ts:74
frame4D	number	undefined	nvimage/index.ts:45
global_max?	number	undefined	nvimage/index.ts:104
global_min?	number	undefined	nvimage/index.ts:103
hdr	NIFTI1 | NIFTI2	null	nvimage/index.ts:79
headers?	Record<string, string>	undefined	nvimage/index.ts:34
id	string	undefined	nvimage/index.ts:32
ignoreZeroVoxels	boolean	undefined	nvimage/index.ts:38
imageType?	ImageType	undefined	nvimage/index.ts:81
imaginary?	Float32Array	undefined	nvimage/index.ts:83
img?	TypedVoxelArray	undefined	nvimage/index.ts:82
img2RASstart?	number[]	undefined	nvimage/index.ts:69
img2RASstep?	number[]	undefined	nvimage/index.ts:68
isManifest?	boolean	undefined	nvimage/index.ts:108
limitFrames4D?	number	undefined	nvimage/index.ts:109
matRAS?	mat4	undefined	nvimage/index.ts:63
maxShearDeg?	number	undefined	nvimage/index.ts:57
mm000?	vec3	undefined	nvimage/index.ts:94
mm001?	vec3	undefined	nvimage/index.ts:97
mm010?	vec3	undefined	nvimage/index.ts:96
mm100?	vec3	undefined	nvimage/index.ts:95
mm2ortho?	mat4	undefined	nvimage/index.ts:77
modulateAlpha	number	0	nvimage/index.ts:51
modulationImage	number	null	nvimage/index.ts:50
name	string	undefined	nvimage/index.ts:31
nFrame4D?	number	undefined	nvimage/index.ts:44
nTotalFrame4D?	number	undefined	nvimage/index.ts:46
nVox3D?	number	undefined	nvimage/index.ts:55
oblique_angle?	number	undefined	nvimage/index.ts:56
obliqueRAS?	mat4	undefined	nvimage/index.ts:65
onColormapChange	(img: NVImage) => void	undefined	nvimage/index.ts:88
onOpacityChange	(img: NVImage) => void	undefined	nvimage/index.ts:89
originalAffine?	number[][]	undefined	nvimage/index.ts:112
percentileFrac	number	undefined	nvimage/index.ts:37
permRAS?	number[]	undefined	nvimage/index.ts:67
pixDims?	number[]	undefined	nvimage/index.ts:62
pixDimsRAS?	number[]	undefined	nvimage/index.ts:64
robust_max?	number	undefined	nvimage/index.ts:102
robust_min?	number	undefined	nvimage/index.ts:101
series	any	[]	nvimage/index.ts:54
toRAS?	mat4	undefined	nvimage/index.ts:70
toRASvox?	mat4	undefined	nvimage/index.ts:71
trustCalMinMax	boolean	undefined	nvimage/index.ts:39
url?	string	undefined	nvimage/index.ts:33
urlImgData?	string	undefined	nvimage/index.ts:107
useQFormNotSForm	boolean	undefined	nvimage/index.ts:58
v1?	Float32Array	undefined	nvimage/index.ts:84
zarrHelper	NVZarrHelper	null	nvimage/index.ts:91

Accessors

colormap

Get Signature

get colormap(): string;

Defined in: nvimage/index.ts:780

Returns

string

Set Signature

set colormap(cm: string): void;

Defined in: nvimage/index.ts:789

Parameters

Parameter	Type
cm	string

Returns

void

---

colorMap

Get Signature

get colorMap(): string;

Defined in: nvimage/index.ts:784

Returns

string

Set Signature

set colorMap(cm: string): void;

Defined in: nvimage/index.ts:793

Parameters

Parameter	Type
cm	string

Returns

void

---

opacity

Get Signature

get opacity(): number;

Defined in: nvimage/index.ts:797

Returns

number

Set Signature

set opacity(opacity: number): void;

Defined in: nvimage/index.ts:801

Parameters

Parameter	Type
opacity	number

Returns

void

Methods

applyOptionsUpdate()

applyOptionsUpdate(options: ImageFromUrlOptions): void;

Defined in: nvimage/index.ts:1362

Update options for image

Parameters

Parameter	Type
options	ImageFromUrlOptions

Returns

void

---

applyTransform()

applyTransform(transform: AffineTransform): void;

Defined in: nvimage/index.ts:704

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:758

Parameters

Parameter	Type
a	unknown[]
b	unknown[]

Returns

boolean

---

calculateOblique()

calculateOblique(): void;

Defined in: nvimage/index.ts:462

Returns

void

---

calculateRAS()

calculateRAS(): void;

Defined in: nvimage/index.ts:670

Returns

void

---

calMinMax()

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

Defined in: nvimage/index.ts:812

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:1289

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:426

Parameters

Parameter	Type
mtx44	mat4

Returns

number

---

convertFrac2MM()

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

Defined in: nvimage/index.ts:1391

Parameters

Parameter	Type	Default value
frac	vec3	undefined
isForceSliceMM	boolean	false

Returns

vec4

---

convertFrac2Vox()

convertFrac2Vox(frac: vec3): vec3;

Defined in: nvimage/index.ts:1386

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:1396

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:1381

Parameters

Parameter	Type
vox	vec3

Returns

vec3

---

float32V1asRGBA()

float32V1asRGBA(inImg: Float32Array): Uint8Array;

Defined in: nvimage/index.ts:439

Convert vector field from Float32 to RGBA representation. Note: We use RGBA rather than RGB and use least significant bits to store vector polarity. This allows a single bitmap to store BOTH (unsigned) color magnitude and signed vector direction.

Parameters

Parameter	Type	Description
inImg	Float32Array	Input Float32Array containing vector field data

Returns

Uint8Array

Uint8Array with RGBA encoded vector data

---

getAffine()

getAffine(): number[][];

Defined in: nvimage/index.ts:678

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:1315

get nifti specific metadata about the image

Returns

ImageMetadata

---

getImageOptions()

getImageOptions(): ImageFromUrlOptions;

Defined in: nvimage/index.ts:1366

Returns

ImageFromUrlOptions

---

getValue()

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

Defined in: nvimage/index.ts:1347

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:1355

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:1204

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:732

Parameters

Parameter	Type	Default value
nVolumes	number	1

Returns

Promise<NIFTI1 | NIFTI2>

---

imageDataFromArrayBuffer()

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

Defined in: nvimage/index.ts:615

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ImageData>

---

img2RAS()

img2RAS(nVolume: number): TypedVoxelArray;

Defined in: nvimage/index.ts:739

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:161

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:818

Parameters

Parameter	Type
raw	number

Returns

number

---

intensityScaled2Raw()

intensityScaled2Raw(scaled: number): number;

Defined in: nvimage/index.ts:823

Parameters

Parameter	Type
scaled	number

Returns

number

---

loadImgV1()

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

Defined in: nvimage/index.ts:456

Load and process diffusion tensor vector (V1) data with optional flips. The vectors must be of unit length. Modifies the nvImage.img property with the processed RGBA data.

Parameters

Parameter	Type	Default value	Description
isFlipX	boolean	false	Flip X component (default: false)
isFlipY	boolean	false	Flip Y component (default: false)
isFlipZ	boolean	false	Flip Z component (default: false)

Returns

boolean

true if successful, false if V1 data is not available

Example

nv1.loadVolumes(volumeList);
nv1.volumes[1].loadImgV1();

See

live demo usage

---

mm2vox()

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

Defined in: nvimage/index.ts:751

Parameters

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

Returns

vec3

---

readBMP()

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

Defined in: nvimage/index.ts:619

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readECAT()

readECAT(buffer: ArrayBuffer): ArrayBuffer;

Defined in: nvimage/index.ts:599

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

ArrayBuffer

---

readFIB()

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

Defined in: nvimage/index.ts:637

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<[ArrayBuffer, Float32Array]>

---

readHEAD()

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

Defined in: nvimage/index.ts:650

Parameters

Parameter	Type
dataBuffer	ArrayBuffer
pairedImgData	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readMHA()

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

Defined in: nvimage/index.ts:657

Parameters

Parameter	Type
buffer	ArrayBuffer
pairedImgData	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readMIF()

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

Defined in: nvimage/index.ts:664

Parameters

Parameter	Type
buffer	ArrayBuffer
pairedImgData	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readNPY()

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

Defined in: nvimage/index.ts:607

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readNPZ()

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

Defined in: nvimage/index.ts:611

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readSRC()

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

Defined in: nvimage/index.ts:644

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

Promise<ArrayBuffer>

---

readV16()

readV16(buffer: ArrayBuffer): ArrayBuffer;

Defined in: nvimage/index.ts:603

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

ArrayBuffer

---

readVMR()

readVMR(buffer: ArrayBuffer): ArrayBuffer;

Defined in: nvimage/index.ts:630

Parameters

Parameter	Type
buffer	ArrayBuffer

Returns

ArrayBuffer

---

readZARR()

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

Defined in: nvimage/index.ts:623

Parameters

Parameter	Type
buffer	ArrayBuffer
zarrData	unknown

Returns

Promise<ArrayBufferLike>

---

resetAffine()

resetAffine(): void;

Defined in: nvimage/index.ts:718

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:840

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:831

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:690

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:765

Parameters

Parameter	Type
cm	string

Returns

void

---

setColormapLabel()

setColormapLabel(cm: ColorMap): void;

Defined in: nvimage/index.ts:772

Parameters

Parameter	Type
cm	ColorMap

Returns

void

---

setColormapLabelFromUrl()

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

Defined in: nvimage/index.ts:776

Parameters

Parameter	Type
url	string

Returns

Promise<void>

---

setVolumeData()

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

Defined in: nvimage/index.ts:1218

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:1375

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:745

Parameters

Parameter	Type
XYZ	number[]
mtx	mat4

Returns

vec3

---

zeroImage()

zeroImage(): void;

Defined in: nvimage/index.ts:1308

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();

---

createChunkedZarr()

static createChunkedZarr(url: string, options: object): Promise<NVImage>;

Defined in: nvimage/index.ts:1031

Factory method: create a chunked zarr NVImage with an attached NVZarrHelper.

Parameters

Parameter	Type
url	string
options	{ cacheSize?: number; channel?: number; colormap?: string; convertUnitsToMm?: boolean; level: number; maxTextureSize?: number; maxVolumeSize?: number; opacity?: number; zarrCenterMM?: [number, number, number]; }
options.cacheSize?	number
options.channel?	number
options.colormap?	string
options.convertUnitsToMm?	boolean
options.level	number
options.maxTextureSize?	number
options.maxVolumeSize?	number
options.opacity?	number
options.zarrCenterMM?	[number, number, number]

Returns

Promise<NVImage>

---

createNiftiArray()

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

Defined in: nvimage/index.ts:1172

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:1186

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:853

Parameters

Parameter	Type
url	string

Returns

string

---

fetchDicomData()

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

Defined in: nvimage/index.ts:845

Parameters

Parameter	Type
url	string
headers	Record<string, string>

Returns

Promise<object[]>

---

loadFromBase64()

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

Defined in: nvimage/index.ts:1227

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:1078

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:868

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:861

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:857

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:287

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:1071

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:849

Parameters

Parameter	Type
stream	ReadableStream<Uint8Array>
minBytes	number

Returns

Promise<Uint8Array>

---

zerosLike()

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

Defined in: nvimage/index.ts:1325

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);