Skip to main content

FieldMappingResult

Struct FieldMappingResult 

Source
pub struct FieldMappingResult {
    pub b0_field_ppm: Vec<f64>,
    pub valid_mask: Vec<u8>,
    pub phase_offset: Option<Vec<f64>>,
    pub robust_fit: Option<RobustFitReport>,
    pub reliability: Option<Vec<u8>>,
    pub qsmart_fit_threshold: Option<f64>,
    pub field_noise_ppm: Option<Vec<f64>>,
    pub complex_fit: Option<FitPpmComplexResult>,
}
Expand description

Results from field mapping stage

Fields§

§b0_field_ppm: Vec<f64>

B0 field map in ppm; 0 outside valid_mask (inside mask).

§valid_mask: Vec<u8>

Where the field is defined: the brain mask passed in, less the voxels where MCPC-3D-S’s phase offset is undefined (PhaseOffsetRemoval::valid) when phase-offset removal ran; the brain mask itself on every other path. The reference (MriResearchTools’ mcpc3ds → ROMEO.jl → calculateB0_unwrapped) leaves the field NaN there, so later stages (background removal, inversion, referencing) must work in this mask, not in the brain mask.

§phase_offset: Option<Vec<f64>>

Phase offset map (if phase offset removal was used); 0 where it is undefined.

§robust_fit: Option<RobustFitReport>

What the robust fit found, when B0EstimationMethod::RobustFit combined the echoes; None for every other method.

§reliability: Option<Vec<u8>>

QSMART’s reliability map R_0 (1 = reliable), when B0EstimationMethod::QsmartEchofit combined the echoes; None for every other method. Pass it to run_qsmart.

§qsmart_fit_threshold: Option<f64>

The blurred echo-fit residual reliability was cut at, when B0EstimationMethod::QsmartEchofit combined the echoes: the percentile’s value for QsmartFitThreshold::Percentile, the value itself for a fixed threshold (echofit.m prints it as “Setting adaptive echo-fit threshold at %2.2f”). None for every other method.

§field_noise_ppm: Option<Vec<f64>>

Standard deviation of b0_field_ppm per voxel, in ppm, for the methods that estimate it: B0EstimationMethod::ComplexFit (Fit_ppm_complex.m’s dp1, MEDI’s N_std, which MEDI passes to PDF and MEDI_L1). None for every other method.

§complex_fit: Option<FitPpmComplexResult>

MEDI’s complex fit itself, when B0EstimationMethod::ComplexFit made the field map: fit_ppm_complex’s result, before spatial unwrapping. Its field is MEDI’s iFreq_raw (phase per echo spacing, radians, wrapped) and its noise MEDI’s N_std (radians per echo spacing), so a caller that wants them need not run the fit again. None for every other method.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSend for T
where T: Any + Send,

§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_sync(self: Box<T>) -> Box<dyn Any + Send + Sync>

Converts Box<Trait> (where Trait: DowncastSync) to Box<dyn Any + Send + Sync>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Converts Arc<Trait> (where Trait: DowncastSync) to Arc<Any>, which can then be downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.