Struct FastmriFile 

pub struct FastmriFile {
    pub meta: FastmriMeta,
    /* private fields */
}

A handle to an opened FastMRI file.

Fields

meta: FastmriMeta

Implementations

impl FastmriFile

pub fn open<P: AsRef<Path>>(path: P) -> IoResult<Self>

Open the HDF5 file, parse the header, and validate the tensor shapes.

pub fn read_kspace(&self) -> IoResult<Array4<Complex32>>

Read the full k-space tensor and return it as [coils, slices, ky, kx].

This matches the axis order produced by [IsmrmrdFile::read_kspace] so both can be fed into the same reconstruction pipeline unchanged.

The raw HDF5 layout is [slices, coils, ky, kx]; we permute axes on load.

pub fn read_kspace_slice(&self, slice_idx: usize) -> IoResult<Array3<Complex32>>

Read a single slice’s k-space as [coils, ky, kx].

More memory-efficient than read_kspace when only one slice is needed - still loads the full file but avoids allocating the full permuted tensor.

pub fn read_reconstruction_rss(&self) -> IoResult<Array3<f32>>

Read the ground-truth RSS reconstruction as [slices, recon_y, recon_x].

pub fn read_reconstruction_rss_slice( &self, slice_idx: usize, ) -> IoResult<Array2<f32>>

Read the ground-truth RSS for a single slice as [recon_y, recon_x].

pub fn is_brain(&self) -> bool

Returns true if the acquisition label heuristically indicates a brain scan.

The heuristic checks whether the label (e.g. "AXT2", "AXFLAIR") contains the substring "AX" (axial) after upper-casing. Brain FastMRI acquisitions are typically labelled with axial plane prefixes; knee acquisitions use coronal ("COR") or sagittal ("SAG") prefixes. This is a best-effort heuristic – files with non-standard labels may be misclassified.