Struct ChiSepIlsqrParams 

pub struct ChiSepIlsqrParams {
    pub cf: f64,
    pub dr_pos: Option<f64>,
    pub dr_neg: Option<f64>,
    pub pad: [usize; 3],
    pub cg_max_iter_lsqr: usize,
    pub cg_tol_lsqr: f64,
    pub cg_max_iter_sa: usize,
    pub cg_tol_sa: f64,
    pub d2_thr: f64,
    pub prc_w_i: (f64, f64),
    pub prc_w_g: (f64, f64),
    pub qsm_ilsqr: IlsqrParams,
}

Parameters for chi_sep_ilsqr. The defaults are the toolbox’s (see the module docs); the field names after the toolbox’s params fields are given with each.

Fields

cf: f64

Central frequency in Hz (params.CF; default 123.2 MHz). The field strength the defaults of Self::dr_pos and Self::dr_neg scale with is cf / 42.58e6.

dr_pos: Option<f64>

Paramagnetic relaxometric constant in Hz/ppm (params.Dr_pos). None (the default): the toolbox’s 137·(B0/2.9) (toolbox_default_dr).

dr_neg: Option<f64>

Diamagnetic relaxometric constant in Hz/ppm (params.Dr_neg). None (the default): the same as Self::dr_pos’s default.

pad: [usize; 3]

Zero padding, in voxels, added at both ends of each axis (params.pad_size; default [16, 16, 16]).

cg_max_iter_lsqr: usize

Step 1’s pcg iterations at most (params.cg_max_iter_LSQR; default 50). The NNLS iterations run one.

cg_tol_lsqr: f64

Step 1’s pcg relative tolerance (params.cg_tol_LSQR; default 0.02).

cg_max_iter_sa: usize

Step 2’s pcg iterations at most, per source (params.cg_max_iter_SA; default 50).

cg_tol_sa: f64

Step 2’s pcg relative tolerance (params.cg_tol_SA; default 0.02).

d2_thr: f64

The streaking cone is |D| < d2_thr (params.D2_thr; default 0.11).

prc_w_i: (f64, f64)

Percentiles (0-100) of the field’s |del2| inside the mask at which step 1’s weight is 1 and 0 (params.prc_W_I_min, prc_W_I_max; default 60, 99.8).

prc_w_g: (f64, f64)

Percentiles (0-100) of each gradient component’s magnitude inside the mask at which step 2’s weights are 1 and 0 (params.WG_prc_min, WG_prc_max; default 50, 70).

qsm_ilsqr: IlsqrParams

iLSQR settings for the conventional QSM (option_data.qsm) that χ-separation is initialised with, for hosts that reconstruct it (the pipeline takes the QSM as an input). Default chisep_toolbox_ilsqr: 100 iterations, 12 mm padding, as Chisep_script.m (l. 142-145) calls STI Suite’s QSM_iLSQR: 'padsize', [12 12 12] and no 'niter', so the function’s default of 100. This differs from IlsqrParams::default (the STI Suite GUI’s 40 iterations).

Implementations

impl ChiSepIlsqrParams

pub fn dr(&self) -> (f64, f64)

The relaxometric constants used, (D_r,pos, D_r,neg) in Hz/ppm: the explicit values, or the toolbox’s toolbox_default_dr.

pub fn validate(&self) -> Result<(), InputError>

Checks the parameters chi_sep_ilsqr checks.

Trait Implementations

impl Clone for ChiSepIlsqrParams

fn clone(&self) -> ChiSepIlsqrParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChiSepIlsqrParams

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

Formats the value using the given formatter.

impl Default for ChiSepIlsqrParams

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for ChiSepIlsqrParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.