Struct InverseOperator

Source

pub struct InverseOperator {
    pub eigen_fields: Array2<f64>,
    pub sing: Array1<f64>,
    pub eigen_leads: Array2<f64>,
    pub source_cov: Array1<f64>,
    pub eigen_leads_weighted: bool,
    pub n_sources: usize,
    pub orientation: SourceOrientation,
    pub source_nn: Array2<f64>,
    pub whitener: Array2<f64>,
    pub n_nzero: usize,
    pub noise_cov: NoiseCov,
}

Expand description

Prepared inverse operator, ready for application to data.

Created by make_inverse_operator and consumed by apply_inverse. Contains the SVD decomposition of the whitened gain matrix plus all metadata needed to reconstruct source currents.

Fields§

§eigen_fields: Array2<f64>

Left singular vectors transposed: U^T, shape [n_nzero, n_channels].

§sing: Array1<f64>

Singular values, length n_nzero.

§eigen_leads: Array2<f64>

Right singular vectors: V, shape [n_sources × n_orient, n_nzero].

§source_cov: Array1<f64>

Source covariance diagonal (depth + orient priors), length n_sources × n_orient.

§eigen_leads_weighted: bool

Whether eigen_leads already includes √source_cov (set by eLORETA).

§n_sources: usize

Number of source locations.

§orientation: SourceOrientation

Orientation mode.

§source_nn: Array2<f64>

Source normals, shape [n_sources × n_orient, 3].

§whitener: Array2<f64>

Whitener matrix, shape [n_nzero, n_channels].

§n_nzero: usize

Number of non-zero eigenvalues in the noise covariance.

§noise_cov: NoiseCov

Noise covariance (retained for eLORETA computation).

Trait Implementations§

Source §

impl Clone for InverseOperator

Source §

fn clone(&self) -> InverseOperator

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for InverseOperator

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for InverseOperator

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

Source §

impl<T> ByRef<T> for T

Source §

fn by_ref(&self) -> &T

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

Source §

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

Source §

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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

Source §