Struct NiftiHeader 

pub struct NiftiHeader {
    pub ndim: usize,
    pub dim: [i64; 8],
    pub pixdim: [f64; 8],
    pub datatype: i16,
    pub bitpix: i16,
    pub version: u8,
    pub vox_offset: u64,
    pub scl_slope: f64,
    pub scl_inter: f64,
    pub affine: [[f64; 4]; 4],
    pub sform_code: i16,
    pub qform_code: i16,
}

Fields

ndim: usize

Number of dimensions (1-7).

dim: [i64; 8]

Size of each dimension: dim[0]=ndim, dim[1..8].

pixdim: [f64; 8]

Voxel sizes / TR: pixdim[1..3] = voxel mm, pixdim[4] = TR for 4D.

datatype: i16

Data type code.

bitpix: i16

Bits per voxel.

version: u8

NIfTI version (1 or 2).

vox_offset: u64

Byte offset to the start of voxel data.

scl_slope: f64

Slope for intensity scaling: scaled = raw * scl_slope + scl_inter. If 0.0, no scaling is applied.

scl_inter: f64

Intercept for intensity scaling.

affine: [[f64; 4]; 4]

sform affine matrix (4×4, row-major). Maps voxel (i,j,k) → (x,y,z) in mm. Set from sform if sform_code > 0, else from qform.

sform_code: i16

sform code (0=unknown, 1=scanner, 2=aligned, 3=Talairach, 4=MNI).

qform_code: i16

qform code.

Implementations

impl NiftiHeader

pub fn from_file(path: &Path) -> Result<Self, NiftiError>

Read header from a NIfTI file (.nii, .nii.gz, .hdr).

pub fn n_vols(&self) -> usize

Number of volumes (4th dimension). Returns 1 for 3D images.

pub fn voxel_size(&self) -> (f64, f64, f64)

Voxel dimensions in mm: (x, y, z).

pub fn matrix_size(&self) -> (usize, usize, usize)

Matrix size: (nx, ny, nz).

pub fn tr(&self) -> Option<f64>

Repetition time in seconds (pixdim[4] for 4D time series).

pub fn n_voxels(&self) -> usize

Total number of voxels across all dimensions.

pub fn shape(&self) -> Vec<usize>

Shape as a Vec (dims 1..ndim).

pub fn has_scaling(&self) -> bool

Whether slope/intercept scaling should be applied.

pub fn data_type(&self) -> DataType

Parsed datatype enum.

pub fn affine(&self) -> &[[f64; 4]; 4]

Get the 4×4 affine matrix mapping voxel indices to mm coordinates. Equivalent to nibabel’s img.affine.

pub fn voxel_to_world(&self, ijk: [f64; 3]) -> [f64; 3]

Transform voxel indices [i, j, k] to world coordinates [x, y, z] in mm.

Trait Implementations

impl Clone for NiftiHeader

fn clone(&self) -> NiftiHeader

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NiftiHeader

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.