Skip to main content

Module unwrap

Module unwrap 

Source
Expand description

Phase unwrapping methods

Removes 2π wraps from MRI phase data.

  • unwrap_romeo / unwrap_romeo_multi_echo — ROMEO, region growing with quality-guided ordering (RomeoParams)
  • unwrap_bestpath — best path (3D-SRNCP), globally sorted edge merging (BestPathParams)
  • unwrap_prelude — PRELUDE, best-pair-first region merging (PreludeParams); the literature’s reference unwrapper, kept as a baseline rather than a default
  • unwrap_medi_region_growing — MEDI’s unwrapPhase (mexUnwrap.c, Tian Liu): magnitude-ordered region growing from the middle of the field of view, no mask, single precision, bit-identical to the MEDI toolbox
  • laplacian_unwrap — Laplacian unwrapping, with a LaplacianSolver: Dct (default; unweighted least squares, Neumann BC on the array) or Fft { pad } (Schofield & Zhu sin/cos method on the zero-padded volume, which reproduces STI Suite 3.0’s MRPhaseUnwrap)

All of the above read across slice boundaries. For a 2D multi-slice acquisition, where each slice carries its own receive phase offset, run one of them per slice with unwrap_slicewise / unwrap_slicewise_multi_echo (SliceWiseParams).

Re-exports§

pub use romeo::unwrap_romeo;
pub use romeo::unwrap_romeo_multi_echo;
pub use romeo::correct_multi_echo_wraps;
pub use romeo::calculate_weights_romeo;
pub use romeo::voxel_quality_romeo;
pub use romeo::RomeoParams;
pub use romeo::RomeoWeightType;
pub use bestpath::unwrap_bestpath;
pub use bestpath::BestPathParams;
pub use prelude::unwrap_prelude;
pub use prelude::PreludeLabelling;
pub use prelude::PreludeParams;
pub use medi_region_growing::unwrap_medi_region_growing;
pub use medi_region_growing::MEDI_NOISE_RATIO;
pub use slicewise::unwrap_slicewise;
pub use slicewise::unwrap_slicewise_multi_echo;
pub use slicewise::enforce_inter_echo_consistency;
pub use slicewise::SliceWiseParams;
pub use laplacian::laplacian_unwrap;
pub use laplacian::LaplacianSolver;

Modules§

bestpath
Best-path phase unwrapping (3D-SRNCP).
laplacian
Laplacian-based phase unwrapping
medi_region_growing
MEDI’s region-growing phase unwrapping: unwrapPhase / mexUnwrap.c (Tian Liu), a magnitude-guided, quality-ordered flood fill.
prelude
PRELUDE phase unwrapping — best-pair-first region merging.
romeo
ROMEO weight calculation for phase unwrapping
slicewise
Slice-wise (2D) phase unwrapping for 2D multi-slice acquisitions.

Enums§

UnwrapMethod
Phase unwrapping method selection.