Struct SeparationInputs

Source

pub struct SeparationInputs<'a> {
    pub local_field_ppm: &'a [f64],
    pub qsm: &'a [f64],
    pub mask: &'a [u8],
    pub r2prime: Option<&'a [f64]>,
    pub r2star: Option<&'a [f64]>,
    pub magnitude_rss: Option<&'a [f64]>,
    pub magnitude_multi: Option<&'a [f64]>,
    pub se_magnitude_multi: Option<&'a [f64]>,
}

Expand description

Inputs for run_separation. Provide whatever the chosen algorithm needs; the dispatcher errors if a required input is missing.

Fields§

§local_field_ppm: &'a [f64]

Local (tissue) field in ppm — for ChiSepIlsqr / ChiSepMedi.

§qsm: &'a [f64]

Conventional QSM χ_total in ppm — the QSM-init for ChiSepIlsqr and the input for R2starQsm / WaveSep / Decompose / HcChisep.

§mask: &'a [u8]

Binary brain mask (n_voxels, 1 = inside).

§r2prime: Option<&'a [f64]>

R2’ map in Hz (ChiSepIlsqr / ChiSepMedi / WaveSep / HcChisep).

§r2star: Option<&'a [f64]>

R2* map in Hz (R2starQsm); if absent, fit from magnitude_multi.

§magnitude_rss: Option<&'a [f64]>

Root-sum-of-squares magnitude (ChiSepIlsqr / ChiSepMedi).

§magnitude_multi: Option<&'a [f64]>

Multi-echo magnitude, voxel-major (n_voxels, n_echoes) (R2starQsm / Decompose / HcChisep).

§se_magnitude_multi: Option<&'a [f64]>

Multi-echo spin-echo magnitude, voxel-major (n_voxels, n_se) (HcChisep, optional).

Trait Implementations§

Source §

impl<'a> Clone for SeparationInputs<'a>

Source §

fn clone(&self) -> SeparationInputs<'a>

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<'a> Copy for SeparationInputs<'a>

Auto Trait Implementations§

§

impl<'a> UnwindSafe for SeparationInputs<'a>

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> CloneAny for T
where T: Any + Clone,

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. 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> DynClone for T
where T: Clone,

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into 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

§