qsm_core/separation/mod.rs
1//! Susceptibility source separation
2//!
3//! This module provides algorithms for separating total magnetic susceptibility
4//! into paramagnetic (χ+, primarily iron) and diamagnetic (χ-, primarily myelin)
5//! components using local field maps and R2' relaxation data.
6//!
7//! # Methods
8//! - `chi_sep_ilsqr`: the original Shin 2021 projected-CG algorithm (SNU-LIST
9//! toolbox `chi_sep_iLSQR`), initialized from a conventional QSM
10//! - `chi_sep_medi`: MEDI-based Gauss-Newton optimization with coupled field + R2' constraints
11//! - `r2star_qsm`: closed-form separation from a QSM + R2* (Dimov 2022, no R2' needed)
12//! - `wavesep`: wavelet-L1 proximal-gradient separation from a QSM + R2' (Fang 2023)
13//! - `decompose`: signal-domain 3-compartment per-voxel fit from a QSM + multi-echo
14//! magnitude (Chen 2021)
15//! - `hc_chisep`: hollow-cylinder χ-separation with signal-derived fiber orientation
16//! from a QSM + R2' + multi-echo magnitude (Wharton & Bowtell model)
17//!
18//! # Reference
19//! Shin, H., et al. (2021). "χ-separation: Magnetic susceptibility source separation
20//! toward iron and myelin mapping in the brain." NeuroImage, 240:118371.
21
22pub mod chi_sep_ilsqr;
23pub mod chi_sep_medi;
24pub mod decompose;
25pub mod hc_chisep;
26pub mod r2star_qsm;
27pub mod wavesep;
28#[cfg(feature = "onnx")]
29pub mod susep_net;
30#[cfg(feature = "onnx")]
31pub mod chisepnet;
32
33pub use chi_sep_ilsqr::{chi_sep_ilsqr, ChiSepIlsqrParams};
34pub use chi_sep_medi::{chi_sep_medi, ChiSepParams};
35pub use decompose::{decompose, DecomposeParams};
36pub use hc_chisep::{hc_chisep, HcChisepParams};
37pub use r2star_qsm::{r2star_qsm, r2star_qsm_from_magnitude, R2starQsmParams};
38pub use wavesep::{wavesep, WaveSepParams};
39#[cfg(feature = "onnx")]
40pub use susep_net::{susep_net, SusepNetNorm};
41#[cfg(feature = "onnx")]
42pub use chisepnet::{chisepnet, ChiSepNetNorm};