Struct TgvParams 

pub struct TgvParams {
    pub alpha1: f32,
    pub alpha0: f32,
    pub iterations: Option<usize>,
    pub erosions: usize,
    pub step_size: f32,
    pub te: EchoTime,
    pub reference_divergence: bool,
    pub reference_edge_erosion: bool,
    pub reference_output_box: bool,
}

TGV parameters. alpha0/alpha1 are in the reference’s rad units (see the module docs).

Fields

alpha1: f32

First-order TGV weight (gradient term), rad units

alpha0: f32

Second-order TGV weight (symmetric gradient term), rad units

iterations: Option<usize>

Number of primal-dual iterations; None uses get_default_iterations for the voxel size and step_size, as the reference does.

erosions: usize

Number of mask erosions

step_size: f32

Primal step size multiplier (larger = faster but less stable; 1 is the publication)

te: EchoTime

Which echo time a field (TgvInput::FieldPpm) is converted to phase at; a wrapped echo is at its own. Default EchoTime::First: QuantitativeSusceptibilityMappingTGV.jl takes the phase of one echo and its TE (qsm_tgv(phase, mask, res; TE, ...), README, af7650b) and has no rule for a field combined over echoes, so the first echo time, the default where the reference does not say.

reference_divergence: bool

Use the reference’s divergence in the w update (default false: the exact adjoint of the symmetric gradient). The reference scales each row of q by that row’s own resolution; on anisotropic voxels that is not the adjoint, so Chambolle–Pock does not solve the stated TGV problem. No effect on isotropic voxels. See the module docs, Where QSM.rs differs from the reference.

reference_edge_erosion: bool

Erode the mask as the reference does (default false: erode it from the array’s edge too). The reference skips neighbours outside the array, so a mask that reaches an array face is not eroded from it, and keeps voxels whose Laplacian and gradient stencils have no neighbour there. No effect unless the mask reaches an array face.

With this, reference_divergence and reference_output_box, QSM.rs matches the package to float32 rounding (tests/tgv_tgvjl_parity.rs).

reference_output_box: bool

Return χ over the reference’s whole working box (default false: inside the eroded mask only, zero elsewhere). The reference returns every voxel of the eroded mask’s bounding box plus one voxel (reduce_to_mask_box, src/tgv.jl L21, L86-88), so a rim of up to two voxels just outside the eroded mask carries the stencils’ spill-over, where the data term does not act. A comparison with the package inside an uneroded mask counts that rim. See the module docs, Where QSM.rs differs from the reference.

Trait Implementations

impl Clone for TgvParams

fn clone(&self) -> TgvParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TgvParams

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

Formats the value using the given formatter.

impl Default for TgvParams

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for TgvParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.