Class: NVImage
Defined in: nvimage/index.ts:34
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:112
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:39 |
_opacity | number | undefined | nvimage/index.ts:40 |
cal_max? | number | undefined | nvimage/index.ts:101 |
cal_maxNeg | number | undefined | nvimage/index.ts:52 |
cal_min? | number | undefined | nvimage/index.ts:100 |
cal_minNeg | number | undefined | nvimage/index.ts:51 |
colorbarVisible | boolean | true | nvimage/index.ts:53 |
colormapInvert? | boolean | undefined | nvimage/index.ts:47 |
colormapLabel | LUT | undefined | nvimage/index.ts:46 |
colormapNegative | string | undefined | nvimage/index.ts:44 |
colormapType? | number | undefined | nvimage/index.ts:64 |
dims? | number[] | undefined | nvimage/index.ts:90 |
dimsRAS? | number[] | undefined | nvimage/index.ts:70 |
extensions? | NIFTIEXTENSION[] | undefined | nvimage/index.ts:84 |
extentsMaxOrtho? | number[] | undefined | nvimage/index.ts:80 |
extentsMinOrtho? | number[] | undefined | nvimage/index.ts:79 |
fileObject? | File | File[] | undefined | nvimage/index.ts:89 |
frac2mm? | mat4 | undefined | nvimage/index.ts:77 |
frac2mmOrtho? | mat4 | undefined | nvimage/index.ts:78 |
frame4D | number | undefined | nvimage/index.ts:49 |
global_max? | number | undefined | nvimage/index.ts:105 |
global_min? | number | undefined | nvimage/index.ts:104 |
hdr | NIFTI1 | NIFTI2 | null | nvimage/index.ts:83 |
headers? | Record<string, string> | undefined | nvimage/index.ts:38 |
id | string | undefined | nvimage/index.ts:36 |
ignoreZeroVoxels | boolean | undefined | nvimage/index.ts:42 |
imageType? | ImageType | undefined | nvimage/index.ts:85 |
imaginary? | Float32Array | undefined | nvimage/index.ts:87 |
img? | TypedVoxelArray | undefined | nvimage/index.ts:86 |
img2RASstart? | number[] | undefined | nvimage/index.ts:73 |
img2RASstep? | number[] | undefined | nvimage/index.ts:72 |
isManifest? | boolean | undefined | nvimage/index.ts:109 |
limitFrames4D? | number | undefined | nvimage/index.ts:110 |
matRAS? | mat4 | undefined | nvimage/index.ts:67 |
maxShearDeg? | number | undefined | nvimage/index.ts:61 |
mm000? | vec3 | undefined | nvimage/index.ts:95 |
mm001? | vec3 | undefined | nvimage/index.ts:98 |
mm010? | vec3 | undefined | nvimage/index.ts:97 |
mm100? | vec3 | undefined | nvimage/index.ts:96 |
mm2ortho? | mat4 | undefined | nvimage/index.ts:81 |
modulateAlpha | number | 0 | nvimage/index.ts:55 |
modulationImage | number | null | nvimage/index.ts:54 |
name | string | undefined | nvimage/index.ts:35 |
nFrame4D? | number | undefined | nvimage/index.ts:48 |
nTotalFrame4D? | number | undefined | nvimage/index.ts:50 |
nVox3D? | number | undefined | nvimage/index.ts:59 |
oblique_angle? | number | undefined | nvimage/index.ts:60 |
obliqueRAS? | mat4 | undefined | nvimage/index.ts:69 |
onColormapChange | (img: NVImage) => void | undefined | nvimage/index.ts:92 |
onOpacityChange | (img: NVImage) => void | undefined | nvimage/index.ts:93 |
percentileFrac | number | undefined | nvimage/index.ts:41 |
permRAS? | number[] | undefined | nvimage/index.ts:71 |
pixDims? | number[] | undefined | nvimage/index.ts:66 |
pixDimsRAS? | number[] | undefined | nvimage/index.ts:68 |
robust_max? | number | undefined | nvimage/index.ts:103 |
robust_min? | number | undefined | nvimage/index.ts:102 |
series | any | [] | nvimage/index.ts:58 |
toRAS? | mat4 | undefined | nvimage/index.ts:74 |
toRASvox? | mat4 | undefined | nvimage/index.ts:75 |
trustCalMinMax | boolean | undefined | nvimage/index.ts:43 |
url? | string | undefined | nvimage/index.ts:37 |
urlImgData? | string | undefined | nvimage/index.ts:108 |
useQFormNotSForm | boolean | undefined | nvimage/index.ts:62 |
v1? | Float32Array | undefined | nvimage/index.ts:88 |
Accessors
colormap
Get Signature
get colormap(): string;
Defined in: nvimage/index.ts:2620
Returns
string
Set Signature
set colormap(cm: string): void;
Defined in: nvimage/index.ts:2629
Parameters
| Parameter | Type |
|---|---|
cm | string |
Returns
void
colorMap
Get Signature
get colorMap(): string;
Defined in: nvimage/index.ts:2624
Returns
string
Set Signature
set colorMap(cm: string): void;
Defined in: nvimage/index.ts:2633
Parameters
| Parameter | Type |
|---|---|
cm | string |
Returns
void
opacity
Get Signature
get opacity(): number;
Defined in: nvimage/index.ts:2637
Returns
number
Set Signature
set opacity(opacity: number): void;
Defined in: nvimage/index.ts:2641
Parameters
| Parameter | Type |
|---|---|
opacity | number |
Returns
void
Methods
applyOptionsUpdate()
applyOptionsUpdate(options: ImageFromUrlOptions): void;
Defined in: nvimage/index.ts:3797
Update options for image
Parameters
| Parameter | Type |
|---|---|
options | ImageFromUrlOptions |
Returns
void
arrayEquals()
arrayEquals(a: unknown[], b: unknown[]): boolean;
Defined in: nvimage/index.ts:2594
Parameters
| Parameter | Type |
|---|---|
a | unknown[] |
b | unknown[] |
Returns
boolean
calculateOblique()
calculateOblique(): void;
Defined in: nvimage/index.ts:703
Returns
void
calculateRAS()
calculateRAS(): void;
Defined in: nvimage/index.ts:2288
Returns
void
calMinMax()
calMinMax(vol: number, isBorder: boolean): number[];
Defined in: nvimage/index.ts:2655
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
clone()
clone(): NVImage;
Defined in: nvimage/index.ts:3707
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:608
Parameters
| Parameter | Type |
|---|---|
mtx44 | mat4 |
Returns
number
convertFrac2MM()
convertFrac2MM(frac: vec3, isForceSliceMM: boolean): vec4;
Defined in: nvimage/index.ts:3857
Parameters
| Parameter | Type | Default value |
|---|---|---|
frac | vec3 | undefined |
isForceSliceMM | boolean | false |
Returns
vec4
convertFrac2Vox()
convertFrac2Vox(frac: vec3): vec3;
Defined in: nvimage/index.ts:3847
Parameters
| Parameter | Type |
|---|---|
frac | vec3 |
Returns
vec3
convertMM2Frac()
convertMM2Frac(mm:
| [number, number, number, number]
| Float32Array
| [number, number, number], isForceSliceMM: boolean): vec3;
Defined in: nvimage/index.ts:3868
Parameters
| Parameter | Type | Default value |
|---|---|---|
mm | | [number, number, number, number] | Float32Array | [number, number, number] | undefined |
isForceSliceMM | boolean | false |
Returns
vec3
convertVox2Frac()
convertVox2Frac(vox: vec3): vec3;
Defined in: nvimage/index.ts:3835
Parameters
| Parameter | Type |
|---|---|
vox | vec3 |
Returns
vec3
float32V1asRGBA()
float32V1asRGBA(inImg: Float32Array): Uint8Array;
Defined in: nvimage/index.ts:627
Parameters
| Parameter | Type |
|---|---|
inImg | Float32Array |
Returns
Uint8Array
getImageMetadata()
getImageMetadata(): ImageMetadata;
Defined in: nvimage/index.ts:3733
get nifti specific metadata about the image
Returns
getImageOptions()
getImageOptions(): ImageFromUrlOptions;
Defined in: nvimage/index.ts:3803
Returns
getValue()
getValue(
x: number,
y: number,
z: number,
frame4D: number,
isReadImaginary: boolean): number;
Defined in: nvimage/index.ts:3782
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:3790
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:3604
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:2464
Parameters
| Parameter | Type | Default value |
|---|---|---|
nVolumes | number | 1 |
Returns
Promise<NIFTI1 | NIFTI2>
imageDataFromArrayBuffer()
imageDataFromArrayBuffer(buffer: ArrayBuffer): Promise<ImageData>;
Defined in: nvimage/index.ts:1253
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
Promise<ImageData>
img2RAS()
img2RAS(nVolume: number): TypedVoxelArray;
Defined in: nvimage/index.ts:2509
Parameters
| Parameter | Type | Default value |
|---|---|---|
nVolume | number | 0 |
Returns
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:159
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:2893
Parameters
| Parameter | Type |
|---|---|
raw | number |
Returns
number
intensityScaled2Raw()
intensityScaled2Raw(scaled: number): number;
Defined in: nvimage/index.ts:2905
Parameters
| Parameter | Type |
|---|---|
scaled | number |
Returns
number
loadImgV1()
loadImgV1(
isFlipX: boolean,
isFlipY: boolean,
isFlipZ: boolean): boolean;
Defined in: nvimage/index.ts:673
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:2573
Parameters
| Parameter | Type | Default value |
|---|---|---|
mm | number[] | undefined |
frac | boolean | false |
Returns
vec3
readBMP()
readBMP(buffer: ArrayBuffer): Promise<ArrayBuffer>;
Defined in: nvimage/index.ts:1280
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
Promise<ArrayBuffer>
readECAT()
readECAT(buffer: ArrayBuffer): ArrayBuffer;
Defined in: nvimage/index.ts:1014
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
ArrayBuffer
readFIB()
readFIB(buffer: ArrayBuffer): Promise<[ArrayBuffer, Float32Array]>;
Defined in: nvimage/index.ts:1478
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
Promise<[ArrayBuffer, Float32Array]>
readHEAD()
readHEAD(dataBuffer: ArrayBuffer, pairedImgData: ArrayBuffer): Promise<ArrayBuffer>;
Defined in: nvimage/index.ts:1639
Parameters
| Parameter | Type |
|---|---|
dataBuffer | ArrayBuffer |
pairedImgData | ArrayBuffer |
Returns
Promise<ArrayBuffer>
readMHA()
readMHA(buffer: ArrayBuffer, pairedImgData: ArrayBuffer): Promise<ArrayBuffer>;
Defined in: nvimage/index.ts:1783
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
pairedImgData | ArrayBuffer |
Returns
Promise<ArrayBuffer>
readMIF()
readMIF(buffer: ArrayBuffer, pairedImgData: ArrayBuffer): Promise<ArrayBuffer>;
Defined in: nvimage/index.ts:1928
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
pairedImgData | ArrayBuffer |
Returns
Promise<ArrayBuffer>
readNPY()
readNPY(buffer: ArrayBuffer): Promise<ArrayBuffer>;
Defined in: nvimage/index.ts:1147
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
Promise<ArrayBuffer>
readNPZ()
readNPZ(buffer: ArrayBuffer): Promise<ArrayBuffer>;
Defined in: nvimage/index.ts:1241
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
Promise<ArrayBuffer>
readSRC()
readSRC(buffer: ArrayBuffer): Promise<ArrayBuffer>;
Defined in: nvimage/index.ts:1569
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
Promise<ArrayBuffer>
readV16()
readV16(buffer: ArrayBuffer): ArrayBuffer;
Defined in: nvimage/index.ts:1121
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
ArrayBuffer
readVMR()
readVMR(buffer: ArrayBuffer): ArrayBuffer;
Defined in: nvimage/index.ts:1383
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
Returns
ArrayBuffer
readZARR()
readZARR(buffer: ArrayBuffer, zarrData: unknown): Promise<ArrayBufferLike>;
Defined in: nvimage/index.ts:1313
Parameters
| Parameter | Type |
|---|---|
buffer | ArrayBuffer |
zarrData | unknown |
Returns
Promise<ArrayBufferLike>
saveToDisk()
saveToDisk(fnm: string, drawing8: Uint8Array): Promise<Uint8Array>;
Defined in: nvimage/index.ts:2929
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:2920
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>
setColormap()
setColormap(cm: string): void;
Defined in: nvimage/index.ts:2601
Parameters
| Parameter | Type |
|---|---|
cm | string |
Returns
void
setColormapLabel()
setColormapLabel(cm: ColorMap): void;
Defined in: nvimage/index.ts:2612
Parameters
| Parameter | Type |
|---|---|
cm | ColorMap |
Returns
void
setColormapLabelFromUrl()
setColormapLabelFromUrl(url: string): Promise<void>;
Defined in: nvimage/index.ts:2616
Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
Promise<void>
SetPixDimFromSForm()
SetPixDimFromSForm(): void;
Defined in: nvimage/index.ts:846
Returns
void
setVolumeData()
setVolumeData(
voxStart: number[],
voxEnd: number[],
img: TypedVoxelArray): void;
Defined in: nvimage/index.ts:3622
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
THD_daxes_to_NIFTI()
THD_daxes_to_NIFTI(
xyzDelta: number[],
xyzOrigin: number[],
orientSpecific: number[]): void;
Defined in: nvimage/index.ts:794
Parameters
| Parameter | Type |
|---|---|
xyzDelta | number[] |
xyzOrigin | number[] |
orientSpecific | number[] |
Returns
void
toUint8Array()
toUint8Array(drawingBytes: Uint8Array): Uint8Array;
Defined in: nvimage/index.ts:3829
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:2562
Parameters
| Parameter | Type |
|---|---|
XYZ | number[] |
mtx | mat4 |
Returns
vec3
zeroImage()
zeroImage(): void;
Defined in: nvimage/index.ts:3726
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:3572
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:3586
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:3030
Parameters
| Parameter | Type |
|---|---|
url | string |
Returns
string
fetchDicomData()
static fetchDicomData(url: string, headers: Record<string, string>): Promise<object[]>;
Defined in: nvimage/index.ts:2934
Parameters
| Parameter | Type |
|---|---|
url | string |
headers | Record<string, string> |
Returns
Promise<object[]>
loadFromBase64()
static loadFromBase64(__namedParameters: ImageFromBase64): Promise<NVImage>;
Defined in: nvimage/index.ts:3635
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:3477
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:3164
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:3088
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:3043
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:469
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:3424
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:2974
Parameters
| Parameter | Type |
|---|---|
stream | ReadableStream<Uint8Array> |
minBytes | number |
Returns
Promise<Uint8Array>
zerosLike()
static zerosLike(nvImage: NVImage, dataType: string): NVImage;
Defined in: nvimage/index.ts:3760
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);