Struct PreludeParams 

pub struct PreludeParams {
    pub num_phase_partitions: usize,
    pub labelling: PreludeLabelling,
    pub correct_global: bool,
}

Parameters for unwrap_prelude.

The defaults are FSL prelude’s: 8 partitions, regions labelled slice by slice on volumes over 64 voxels in-plane. With them this module gives FSL’s default output (see the module docs for the measured agreement).

Fields

num_phase_partitions: usize

Number of equal bins the phase range [-π, π) is cut into when forming the initial regions (default: 8, FSL prelude’s default, its -n; the report’s worked example uses 6).

More partitions means narrower bins, so a connected component is less likely to contain a wrap — at the price of more, smaller regions and a longer merge. Fewer means larger regions that are more likely to straddle a wrap, which the merge cannot undo: a region is committed to a single offset by construction. Must be at least 1; at 1 every in-mask component is one region and nothing is unwrapped within it.

labelling: PreludeLabelling

How the initial regions are labelled (default: PreludeLabelling::Auto, FSL prelude’s default, which is slice by slice on any in-vivo volume; PreludeLabelling::Slices is prelude --labelslices, PreludeLabelling::Volume is prelude -f).

correct_global: bool

Subtract the median wrap count from the result so the unwrapped phase stays centred near the input range (default: true).

Without it each connected set of regions carries an arbitrary integer multiple of 2π. The default is on because FSL’s prelude output has a median in-mask wrap count of 0 on every volume measured (see the module docs), so this is what reproduces it; it also gives a multi-echo caller echoes whose constants are already near each other before whole turns are aligned between them. Same operation as BestPathParams::correct_global and RomeoParams::correct_global, which default to false because their originals do not do it.

Trait Implementations

impl Clone for PreludeParams

fn clone(&self) -> PreludeParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PreludeParams

impl Debug for PreludeParams

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

Formats the value using the given formatter.

impl Default for PreludeParams

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PreludeParams

fn eq(&self, other: &PreludeParams) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PreludeParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PreludeParams