Struct WaveletCoeffs 

#[non_exhaustive]
pub struct WaveletCoeffs {
    pub approx: Vec<f64>,
    pub details: Vec<Vec<f64>>,
    pub levels: usize,
    pub signal_len: usize,
    pub family: WaveletFamily,
    pub mode: BoundaryMode,
    /* private fields */
}

Multi-level orthogonal DWT coefficients (the Mallat pyramid) for one signal.

Produced by decompose and inverted by reconstruct. Holds the final coarse approximation, the per-level detail bands, and the metadata reconstruction needs to return exactly the original number of samples.

The detail bands are stored finest-first: details[0] is the level-1 detail (highest frequency, longest band) and details[levels - 1] is the coarsest detail produced alongside the final approximation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

approx: Vec<f64>

The final coarse approximation band (output of the last analysis level).

details: Vec<Vec<f64>>

Per-level detail bands, finest-first: details[0] is the level-1 detail.

levels: usize

Number of decomposition levels (== details.len()).

signal_len: usize

Original signal length, so reconstruct returns exactly this many samples.

family: WaveletFamily

The wavelet family used for the transform (needed to rebuild the filter bank).

mode: BoundaryMode

The boundary mode used for the transform.

Implementations

impl WaveletCoeffs

pub fn levels(&self) -> usize

Number of decomposition levels.

pub fn signal_len(&self) -> usize

Original signal length (the number of samples reconstruct returns).

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

The final coarse approximation band.

pub fn detail(&self, level: usize) -> Option<&[f64]>

The detail band at level (finest-first: 0 is the level-1 detail).

Returns None if level >= levels.

pub fn family(&self) -> &WaveletFamily

The wavelet family used for the transform.

pub fn mode(&self) -> BoundaryMode

The boundary mode used for the transform.

Trait Implementations

impl Clone for WaveletCoeffs

fn clone(&self) -> WaveletCoeffs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WaveletCoeffs

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

Formats the value using the given formatter.

impl PartialEq for WaveletCoeffs

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WaveletCoeffs