Struct FansiParams 

pub struct FansiParams {

    pub alpha1: f64,
    pub mu1: Option<f64>,
    pub mu2: f64,
    pub alpha0: Option<f64>,
    pub mu0: Option<f64>,
    pub max_iter: usize,
    pub tol_update: f64,
    pub tol_delta: f64,
    pub b0: f64,
    pub echo_times: Vec<f64>,
    pub te: EchoTime,
    pub is_tgv: bool,
    pub kernel: FansiKernel,
}

FANSI nlTV/nlTGV parameters (nlTV.m / nlTGV.m defaults where they have them).

Fields

alpha1: f64

First-order (TV / TGV gradient) L1 penalty weight.

mu1: Option<f64>

Gradient-consistency ADMM weight; None is FANSI’s 100 * alpha1.

mu2: f64

Fidelity-consistency ADMM weight.

alpha0: Option<f64>

Second-order (symmetric-gradient) L1 penalty weight (nlTGV only); None is nlTGV.m’s 2 * alpha1.

mu0: Option<f64>

Second-order consistency ADMM weight (nlTGV only); None is nlTGV.m’s 2 * mu1.

max_iter: usize

Number of outer ADMM iterations.

tol_update: f64

Percent-update convergence stopping tolerance.

tol_delta: f64

Inner Newton convergence tolerance.

b0: f64

Field strength in Tesla (scan parameter, for the radian conversion)

echo_times: Vec<f64>

Echo times in seconds, in acquisition order (scan parameter, for the radian conversion).

te: EchoTime

Which echo time the radian conversion uses. Default EchoTime::Spacing: FANSI’s multi-echo example, script_DICOM_Philips.m, scales the field to radians by deltaTE = TE(echo2) - TE(echo1) (FANSI-toolbox 93044a3, line 364) before nlTV/nlTGV (lines 370, 421). That script’s echo1 = 2, echo2 = 4 (lines 224-225) make it twice the spacing of its evenly spaced echoes; its comment adds “You may use also any individual echo time”. On the qsm-forward phantom (echoes 4/12/20/28 ms; FANSI’s discrete kernel, measured for QSM.rs#418 with the integration tests’ settings; XSIM / NRMSE / r), the magnitude weight does better at the echo spacing than at the first echo on every metric: nlTV 0.801 / 40.7% / 0.914 vs 0.799 / 43.6% / 0.901, nlTGV (50 iterations) 0.768 / 41.0% / 0.912 vs 0.767 / 43.0% / 0.903. (With the continuous kernel, #276: nlTV 0.802 / 39.8% / 0.918 vs 0.797 / 43.0% / 0.903, nlTGV 0.767 / 40.1% / 0.916 vs 0.765 / 42.8% / 0.904.)

The magnitude weight is required, although nlTV.m and nlTGV.m weight by ones when given none (nlTV.m lines 213, 274; nlTGV.m lines 350, 365): with a flat weight both diverge on that phantom at either echo time, with either kernel.

is_tgv: bool

Select nlTGV (true) or nlTV (false).

kernel: FansiKernel

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

Implementations

impl FansiParams

fn mu1(&self) -> f64

Trait Implementations

impl Clone for FansiParams

fn clone(&self) -> FansiParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FansiParams

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

Formats the value using the given formatter.

impl Default for FansiParams

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for FansiParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.