Struct RomeoParams 

pub struct RomeoParams {

    pub phase_coherence: bool,
    pub phase_gradient_coherence: bool,
    pub phase_linearity: bool,
    pub mag_coherence: bool,
    pub mag_weight: bool,
    pub mag_weight2: bool,
    pub bestpath: bool,
    pub template: usize,
    pub individual: bool,
    pub correct_global: bool,
    pub temporal_uncertain_unwrapping: f64,
    pub max_seeds: u8,
    pub merge_regions: bool,
    pub correct_regions: bool,
    pub wrap_addition: f64,
}

Parameters for ROMEO phase unwrapping.

Weight components can be toggled individually. Each multiplies into the final edge weight as 0.1 + 0.9 * component_value.

The default enables phase coherence, phase gradient coherence, phase linearity, and magnitude coherence (equivalent to :romeo in ROMEO.jl).

Fields

phase_coherence: bool

Phase coherence: 1 - |wrap(Δφ)| / π. Always recommended. (default: true)

phase_gradient_coherence: bool

Phase gradient coherence: consistency between echo pairs. Needs multi-echo data (phase2 + TEs). Automatically disabled if unavailable. (default: true)

phase_linearity: bool

Phase linearity: second-derivative smoothness along each edge. (default: true)

mag_coherence: bool

Magnitude coherence: (min/max)² of neighbor magnitudes. (default: true)

mag_weight: bool

Magnitude weight: penalizes low-signal voxels relative to the 95th percentile. (default: false)

mag_weight2: bool

Magnitude weight 2: penalizes abnormally high signal (flow artifacts). (default: false)

bestpath: bool

Use Best-path weights (Abdul-Rahman) instead of ROMEO weights. When true, the individual weight flags above are ignored. (default: false)

template: usize

Template echo index for spatial unwrapping, 0-indexed (default: 0). Only used for multi-echo template-based unwrapping.

individual: bool

Unwrap each echo individually instead of template-based (default: false).

correct_global: bool

Correct global 2π offsets between echoes (default: false). Recommended when using individual mode.

temporal_uncertain_unwrapping: f64

Quality threshold for re-unwrapping uncertain voxels after temporal unwrapping. Range [0, 1], set to 0 to disable. (default: 0.5)

max_seeds: u8

Maximum number of seed regions (default: 1, max: 255).

merge_regions: bool

Merge neighboring regions after unwrapping (default: false).

correct_regions: bool

Correct each region’s median to nearest 0 by adding n·2π (default: false).

wrap_addition: f64

Additional phase tolerance beyond π for neighbor differences. Range [0, π]. (default: 0.0)

Implementations

impl RomeoParams

pub fn from_weight_type(wt: RomeoWeightType) -> Self

Create params matching a ROMEO.jl weight type preset.

pub fn weight_flags(&self) -> [bool; 6]

Convert the boolean fields to the 6-element flag array used internally.

Trait Implementations

impl Clone for RomeoParams

fn clone(&self) -> RomeoParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RomeoParams

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

Formats the value using the given formatter.

impl Default for RomeoParams

fn default() -> Self

Returns the “default value” for a type.

impl Serialize for RomeoParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.