Skip to main content

Module unring

Module unring 

Source
Expand description

Gibbs-ringing removal by subvoxel shifts for k-space-truncated images: Bautista et al.’s 3-D method for 3-D acquisitions (the default), Kellner et al.’s 2-D method for 2-D multi-slice acquisitions (MRtrix3’s implementation), and DIPY’s 2-D implementation as a parity option. See GibbsMode. Complementary to denoise: unringing removes truncation ringing, MP-PCA removes random noise. Recommended before R2*/R2 fitting.

Structs§

MrtrixUnringParams
Parameters of gibbs_unring_2d and gibbs_unring_3d, with mrdegibbs’s defaults.

Enums§

GibbsMode
Which unringing gibbs_unring_volume and the functions built on it run. See the module docs for which suits which acquisition.

Functions§

gibbs_unring
Gibbs-unring multi-volume data (e.g. multi-echo magnitude), each volume in turn, as DIPY and MRtrix do for a 4-D array.
gibbs_unring_2d
MRtrix3’s 2-D mrdegibbs (Kellner et al. 2016) of one real volume, e.g. a magnitude image from a 2-D multi-slice acquisition: the real part of gibbs_unring_2d_complex, negative values set to 0.
gibbs_unring_2d_complex
mrdegibbs (2-D, Kellner et al. 2016, MRtrix3’s default mode) on one complex volume (Fortran order, x fastest): each slice normal to slice_axis is unrung in 2-D, its in-plane axes in increasing order (slice_axis 2 is MRtrix’s default -axes 0,1). The reference’s output as is. See the module docs.
gibbs_unring_3d
3-D Gibbs unringing (Bautista et al. 2021, MRtrix3’s mrdegibbs -dimensionality 3) of one real volume, e.g. a magnitude image from a 3-D acquisition: the real part of gibbs_unring_3d_complex, negative values set to 0.
gibbs_unring_3d_complex
mrdegibbs -dimensionality 3 on one complex volume (Fortran order, x fastest): the reference’s output as is. See the module docs.
gibbs_unring_masked
Gibbs-unring multi-volume data within a mask bounding box (fast path).
gibbs_unring_volume
Gibbs-unring a single 3-D volume with mode (GibbsMode::default is Bautista et al.’s 3-D unringing).