Struct LsqrQsmParams 

pub struct LsqrQsmParams {
    pub b0: f64,
    pub residual_weighting: Option<f64>,
    pub fit_global_offset: bool,
    pub tol: f64,
    pub max_iter: usize,
    pub mask_output: bool,
}

Parameters for lsqr_qsm.

Fields

b0: f64

Field strength in tesla. A scan parameter, not a user knob — the pipeline dispatcher overrides it from scan metadata.

residual_weighting: Option<f64>

Weight w on the residual-field unknowns. None uses RESIDUAL_WEIGHTING_PER_TESLA * b0; set to Some(0.0) to drop the residual term entirely and solve the plain masked system.

fit_global_offset: bool

Fit a single global field offset alongside χ.

tol: f64

LSQR convergence tolerance (MATLAB lsqr’s tol).

max_iter: usize

Maximum LSQR iterations.

mask_output: bool

Zero the returned χ outside the mask. HEIDI wants this off — it low-passes χ through the dipole cone, and a hard mask edge rings.

Implementations

impl LsqrQsmParams

pub fn effective_residual_weighting(&self) -> f64

Effective residual weight w.

Trait Implementations

impl Clone for LsqrQsmParams

fn clone(&self) -> LsqrQsmParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LsqrQsmParams

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

Formats the value using the given formatter.

impl Default for LsqrQsmParams

fn default() -> Self

inversion_lsqr.m’s settings.

impl Serialize for LsqrQsmParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.