Struct AmpPeParams 

pub struct AmpPeParams {

    pub wave_order: usize,
    pub nlevel: usize,
    pub wave_pec: f64,
    pub simulated_te: f64,
    pub max_linearization_ite: usize,
    pub b0: f64,
    pub gyro_ratio: f64,
    pub damp_rate_sig: f64,
    pub damp_rate_par: f64,
    pub max_pe_spar_ite: usize,
    pub max_pe_est_ite: usize,
    pub cvg_thd: f64,
    pub tikhonov_beta: f64,
    pub normalize_weight: bool,
}

Parameters for the AMP-PE inversion.

Fields

wave_order: usize

Daubechies wavelet order: 1 (db1, best for straight B0) or 2 (db2).

nlevel: usize

Wavelet decomposition levels.

wave_pec: f64

Morphology-mask retention fraction (cumulative-energy threshold).

simulated_te: f64

Simulated echo time (s) used to turn the field into phase.

max_linearization_ite: usize

Linearization iterations for each of the two stages.

b0: f64

Field strength (Tesla).

gyro_ratio: f64

Gyromagnetic ratio (MHz/T); default 42.58, the reference implementation’s value, not crate::constants. Keep it.

damp_rate_sig: f64

Damping rate for the GAMP signal updates (damp_rate).

damp_rate_par: f64

Learning rate for parameter estimation (kappa).

max_pe_spar_ite: usize

Inner sparse-reconstruction iterations per GAMP call.

max_pe_est_ite: usize

Inner parameter-estimation iterations per GAMP call.

cvg_thd: f64

Convergence threshold for the GAMP inner loop.

tikhonov_beta: f64

Tikhonov regularization weight for the L2 seed (chiL2).

normalize_weight: bool

Rescale the magnitude weight to unit mean inside the mask. Off by default: upstream (qsm_multi_echo_combined.m) weights by the magnitude as it is; the QSM-CI wrapper normalises it.

Implementations

impl AmpPeParams

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

Checks the parameters AMP-PE cannot run with: wave_order must be a supported Daubechies order (SUPPORTED_ORDERS, 1–4) and nlevel at most MAX_NLEVEL, since the grid is padded to a multiple of 2^nlevel. amp_pe also refuses an nlevel whose padded grid would not fit in memory’s address range.

Trait Implementations

impl Clone for AmpPeParams

fn clone(&self) -> AmpPeParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AmpPeParams

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

Formats the value using the given formatter.

impl Default for AmpPeParams

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for AmpPeParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.