Skip to main content

Module inversion

Module inversion 

Source
Expand description

Dipole inversion methods for QSM

This module provides various methods to solve the inverse problem of estimating magnetic susceptibility from local field measurements.

Methods include:

  • TKD: Truncated k-space division (fast, simple)
  • TSVD: Truncated SVD (zeros small values)
  • Tikhonov: L2 regularization (closed-form)
  • TV: Total variation regularization via ADMM (iterative)
  • NLTV: Nonlinear TV with iterative reweighting
  • RTS: Rapid two-step method
  • MEDI: Morphology-enabled dipole inversion
  • TGV: Total Generalized Variation (single-step from wrapped phase)

Re-exports§

pub use tkd::tkd;
pub use tkd::tsvd;
pub use tkd::TkdParams;
pub use tikhonov::tikhonov;
pub use tikhonov::TikhonovParams;
pub use tikhonov::Regularization;
pub use tv::tv_admm;
pub use tv::TvParams;
pub use nltv::nltv;
pub use nltv::NltvParams;
pub use rts::rts;
pub use rts::RtsParams;
pub use medi::medi;
pub use medi::MediParams;
pub use medi::MediWorkspace;
pub use tfi::tfi;
pub use tfi::TfiParams;
pub use tgv::tgv_qsm;
pub use tgv::TgvParams;
pub use tgv::get_default_alpha;
pub use tgv::get_default_iterations;
pub use ilsqr::ilsqr;
pub use ilsqr::IlsqrParams;
pub use ndi::ndi;
pub use ndi::NdiParams;
pub use fansi::fansi;
pub use fansi::FansiParams;
pub use l1qsm::l1qsm;
pub use l1qsm::L1QsmParams;
pub use whqsm::whqsm;
pub use whqsm::WhQsmParams;
pub use hdqsm::hdqsm;
pub use hdqsm::HdQsmParams;
pub use amp_pe::amp_pe;
pub use amp_pe::AmpPeParams;
pub use tiled::tile_patch_size;
pub use tiled::tiled_field_inversion;
pub use tiled::tiled_scatter;
pub use tiled::tiled_volume_algorithm;
pub use tiled::Tile;
pub use tiled::TileConfig;
pub use xqsm::xqsm;
pub use xqsm::xqsm_tiled;
pub use qsmnet::qsmnet;
pub use qsmnet::qsmnet_tiled;
pub use qsmnet::QsmnetNorm;
pub use autoqsm::autoqsm;
pub use iqsm::iqsm;
pub use iqsm::iqsm_multi_echo;
pub use iqsm_plus::iqsm_plus;
pub use iqsm_plus::iqsm_plus_multi_echo;
pub use iqfm::iqfm;
pub use iqfm::iqfm_multi_echo;
pub use qsmgan::qsmgan;
pub use lpcnn::lpcnn;
pub use lpcnn::lpcnn_tiled;
pub use lpcnn::LPCNN_ALPHA;
pub use lpcnn::LPCNN_GT_MEAN;
pub use lpcnn::LPCNN_GT_STD;
pub use ir2qsm::ir2qsm;
pub use ir2qsm::ir2qsm_tiled;
pub use modl_qsm::modl_qsm;
pub use modl_qsm::modl_qsm_tiled;
pub use modl_qsm::MODL_ALPHA;
pub use modl_qsm::MODL_MEAN;
pub use modl_qsm::MODL_STD;
pub use nextqsm::nextqsm;
pub use nextqsm::nextqsm_padded;
pub use nextqsm::nextqsm_tiled;
pub use nextqsm::NEXTQSM_LAMBDAS;

Modules§

admm
Shared ADMM iteration infrastructure for TV-based inversion methods.
amp_pe
AMP-PE: Approximate Message Passing with built-in Parameter Estimation for QSM.
autoqsm
AutoQSM single-step deep-learning reconstruction (onnx feature).
fansi
FANSI nonlinear TV / TGV dipole inversion.
hdqsm
HD-QSM: Hybrid data-fidelity two-stage linear dipole inversion.
ilsqr
iLSQR: Iterative LSQR for QSM with streaking artifact removal
iqfm
iQFM single-step deep-learning tissue-field mapping (onnx feature).
iqsm
iQSM single-step deep-learning reconstruction (onnx feature).
iqsm_plus
iQSM+ single-step deep-learning reconstruction (onnx feature).
ir2qsm
IR2QSM dipole inversion (onnx feature).
l1qsm
L1-QSM: nonlinear L1 data-fidelity dipole inversion with TV regularization
lpcnn
LPCNN dipole inversion (onnx feature).
medi
MEDI (Morphology Enabled Dipole Inversion) L1 regularization
modl_qsm
MoDL-QSM dipole inversion (onnx feature).
ndi
Nonlinear Dipole Inversion (NDI) for QSM
nextqsm
NeXtQSM single-step deep-learning reconstruction (onnx feature).
nltv
Nonlinear Total Variation (NLTV) regularized dipole inversion
qsmgan
QSMGAN dipole inversion (onnx feature).
qsmnet
QSMnet deep-learning dipole inversion (onnx feature).
rts
Rapid Two-Step (RTS) dipole inversion
tfi
TFI (Preconditioned Total Field Inversion)
tgv
TGV-QSM: Total Generalized Variation for Quantitative Susceptibility Mapping
tikhonov
Tikhonov regularization for QSM
tiled
Overlap-tiled inference for fully-convolutional deep-learning inversions (onnx).
tkd
Truncated k-space division (TKD) / TSVD for QSM
tv
Total Variation (TV) regularized dipole inversion using ADMM
whqsm
Weak-Harmonic QSM (WH-QSM) dipole inversion
xqsm
xQSM deep-learning dipole inversion (onnx feature).