Struct Decomposition 

pub struct Decomposition { /* private fields */ }

Modes laid out as mode × channel × sample, ordered by ascending centre frequency.

Implementations

impl Decomposition

pub fn new( modes: Array3<f64>, centre_frequencies_hz: Vec<f64>, sampling_rate: SamplingRate, labels: Vec<String>, aligned_across_channels: bool, ) -> Result<Self, MethodError>

pub fn per_channel( modes: Array3<f64>, channel_centre_frequencies_hz: Array2<f64>, sampling_rate: SamplingRate, labels: Vec<String>, ) -> Result<Self, MethodError>

Modes from a method that decomposes each channel on its own (VMD, EMD). Mode k need not mean the same oscillation in every channel, so the decomposition is not aligned. Each mode’s centre frequency is the median of its channels’ finite values; NaN marks a channel without that mode.

pub fn with_channel_centre_frequencies( self, frequencies_hz: Array2<f64>, ) -> Result<Self, MethodError>

Attaches per-channel centre frequencies (mode × channel).

pub fn channel_centre_frequencies_hz(&self) -> Option<ArrayView2<'_, f64>>

Mode × channel centre frequencies, when the method gives them per channel.

pub fn modes(&self) -> ArrayView3<'_, f64>

pub fn mode(&self, index: usize) -> ArrayView2<'_, f64>

pub fn centre_frequencies_hz(&self) -> &[f64]

pub fn sampling_rate(&self) -> SamplingRate

pub fn labels(&self) -> &[String]

pub fn aligned_across_channels(&self) -> bool

True when mode k means the same oscillation in every channel.

pub fn n_modes(&self) -> usize

pub fn reconstruct( &self, modes: &[usize], ) -> Result<MultichannelSeries, MethodError>

Sums the chosen modes back into a signal, for example to keep one frequency band.

Trait Implementations

impl Clone for Decomposition

fn clone(&self) -> Decomposition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Decomposition

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

Formats the value using the given formatter.

impl PartialEq for Decomposition

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Decomposition