Skip to content

Function: read_vol() ​

ts
function read_vol(input): Promise<NeuroVol>;

Defined in: src/io/nifti.ts:19

Read a NIfTI file and return a NeuroVol.

Thin wrapper over readVol kept for backward compatibility. There are two NIfTI decoders: io.ts (readVol, Node entry) and browserNifti.ts (readNiftiArrayBuffer, browser entry). Both take intensity scaling and affine voxel sizes from the shared helpers in niftiGeometry.ts.

Parameters ​

input ​

string | ArrayBuffer

Path to the NIfTI file or an ArrayBuffer of its bytes.

Returns ​

Promise<NeuroVol>

Released under the MIT License.