Struct HdQsmParams 

pub struct HdQsmParams {
    pub alpha_l2: f64,
    pub mu1_l2: Option<f64>,
    pub mu2: f64,
    pub max_iter_l1: usize,
    pub max_iter_l2: usize,
    pub tol_update: f64,
    pub kernel: FansiKernel,
}

HD-QSM algorithm parameters.

Fields

alpha_l2: f64

L2-stage TV weight, for a field in ppm and the magnitude weight (default 3e-5).

HDQSM.m requires it and gives no default; its example uses 10^-4.785 (1.6e-5) and the paper’s 2019-challenge reconstructions 6.3e-6, both on simulated data. 3e-5 was chosen from a sweep (1e-6 to 1e-4) on the 2016 challenge (COSMOS reference: best correlation, 0.76, NRMSE 73%), the 2019-style simulation (NRMSE 39%) and ten travelling-head scans (stable on all of them, with less noise than the mask-weighted 1e-4 the port used).

mu1_l2: Option<f64>

L2-stage gradient-consistency ADMM weight; None is 100 * alpha_l2.

The paper ties it to alpha_l2 with 10 <= mu1_l2/alpha_l2 <= 100; HDQSM.m’s example and the paper’s challenge reconstructions use 10. On in vivo travelling-head scans the ADMM diverges (in HDQSM.m as well) once mu1_l2 falls to about 3e-4 or below, which a ratio of 10 reaches at the alpha_l2 that suits in vivo data, so the default uses the paper’s 100.

mu2: f64

Fidelity consistency weight (HDQSM.m mu2L1, default 1.0).

max_iter_l1: usize

Stage-1 (L1) iterations (HDQSM.m maxOuterIterL1, default 20).

max_iter_l2: usize

Stage-2 (L2) iterations (HDQSM.m maxOuterIterL2, default 80).

tol_update: f64

Stage-2 percent-update stopping tolerance (HDQSM.m tol_update, default 1e-2).

kernel: FansiKernel

The dipole kernel. Default FansiKernel::Discrete, FANSI’s dipole_kernel_angulated as the QSM-CI original is run with (HDQSM.m ships no kernel); FansiKernel::Continuous is the crate’s continuous kernel (see FansiKernel for the decision and the measurements).

Trait Implementations

impl Clone for HdQsmParams

fn clone(&self) -> HdQsmParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HdQsmParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HdQsmParams

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for HdQsmParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.