Interface: WriteVolOptions
Defined in: src/io/io.ts:69
Options for writing volumes.
Properties
format?
ts
optional format?: string;Defined in: src/io/io.ts:75
Output format: 'NIFTI' (default) or 'NIFTI_GZ'. 'NIFTI' names the single-file NIfTI-1 container and leaves compression to the extension (or compress); 'NIFTI_GZ' requests gzip.
dataType?
ts
optional dataType?: string;Defined in: src/io/io.ts:77
Output data type (e.g., "FLOAT32", "INT16")
compress?
ts
optional compress?: boolean;Defined in: src/io/io.ts:84
Whether to gzip the output. By default this follows the path: .nii.gz is gzipped and .nii is not. A value that contradicts a .nii or .nii.gz extension throws a NeuroimError with code INVALID_ARGUMENT. For any other extension it defaults to false.
onProgress?
ts
optional onProgress?: (progress) => void;Defined in: src/io/io.ts:86
Progress callback
Parameters
progress
number
Returns
void