Struct DecomposeParams 

pub struct DecomposeParams {
    pub b0: f64,
    pub n_inner: usize,
    pub chi_bound: DecomposeChiBound,
    pub lsqcurvefit: LsqTrrOptions,
    pub unwrap_phase: bool,
    pub solvers: DecomposeStageSolvers,
}

Parameters for decompose.

Fields

b0: f64

Main field strength in Tesla.

n_inner: usize

Number of alternating 3-stage fit passes per voxel (reference default: 10).

chi_bound: DecomposeChiBound

The bound on |χ+| and |χ−| in the stage-3 search. Default: the authors’ 0.5 ppm (DecomposeChiBound::Ppm); DecomposeChiBound::EchoSpacing takes it from the scan (see the module docs, The χ bound).

lsqcurvefit: LsqTrrOptions

optimoptions('lsqcurvefit', …) of every stage: iterations, evaluations, tolerances and finite-difference settings. Default: MATLAB’s defaults ([LsqTrrOptions::default]), which the authors’ code keeps (MaxIterations 400, the 1e-6 tolerances).

unwrap_phase: bool

Unwrap the phase along the echoes (see the module docs, Phase unwrapping). Default false: the authors’ code takes every phase on its principal branch (log, angle). It leaves the χ search to chi_bound.

solvers: DecomposeStageSolvers

The solver of each of the three stages (see DecomposeStageSolvers).

Implementations

impl DecomposeParams

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

Checks a fixed chi_bound (DecomposeChiBound::Ppm): it must be ≥ 0 ppm (a negative bound leaves the fit’s lower bound above its upper one). An EchoSpacing bound depends on the echo times, and decompose checks it.

Trait Implementations

impl Clone for DecomposeParams

fn clone(&self) -> DecomposeParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DecomposeParams

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

Formats the value using the given formatter.

impl Default for DecomposeParams

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for DecomposeParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.