Symlet

Struct Symlet 

pub struct Symlet { /* private fields */ }
Expand description

Symlet wavelet family

Symlets are a family of wavelets that are nearly symmetrical, designed by Ingrid Daubechies as modifications of the Daubechies wavelets with increased symmetry. They have the same number of vanishing moments as Daubechies wavelets but with better symmetry properties.

§Mathematical Foundation

Symlets were designed by Ingrid Daubechies to be as symmetric as possible while maintaining the same orthogonality and compact support properties as standard Daubechies wavelets. They minimize the phase nonlinearity of the transfer function.

§Coefficient Sources

All coefficients are canonical PyWavelets values, ensuring machine-precision accuracy (~2e-16 sum error) and cross-library compatibility.

References:

  • PyWavelets - Primary source for canonical coefficients (pywt.Wavelet(‘symN’).dec_lo)
  • Daubechies, I. (1992). “Ten Lectures on Wavelets”, CBMS-NSF Regional Conference Series in Applied Mathematics, vol. 61, SIAM, Philadelphia, Chapter 8 (Symmetry for Compactly Supported Wavelet Bases).
  • Percival, D.B. and Walden, A.T. (2000). “Wavelet Methods for Time Series Analysis”, Cambridge University Press, Table 114.

§Properties

All coefficients satisfy:

  • Σh[n] = √2 (DC gain normalization)
  • Σh[n]² = 1 (energy normalization)
  • Near-symmetry (improved phase linearity compared to Daubechies)

§Supported Orders

This implementation includes SYM2-SYM10.

Implementations§

§

impl Symlet

pub fn new(order: usize) -> Self

Create a Symlet wavelet of given order

pub fn sym2() -> Self

pub fn sym3() -> Self

pub fn sym4() -> Self

pub fn sym5() -> Self

pub fn sym6() -> Self

pub fn sym7() -> Self

pub fn sym8() -> Self

pub fn sym9() -> Self

pub fn sym10() -> Self

Trait Implementations§

§

impl Clone for Symlet

§

fn clone(&self) -> Symlet

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
§

impl Debug for Symlet

§

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

Formats the value using the given formatter. Read more
§

impl Wavelet for Symlet

§

fn as_any(&self) -> &dyn Any

Allow downcasting to concrete types
§

fn name(&self) -> &str

Get the name of the wavelet
§

fn vanishing_moments(&self) -> usize

Get the number of vanishing moments
§

fn support_width(&self) -> usize

Get the support width (filter length)
§

fn low_pass_decomposition(&self) -> &[f64]

Get the low-pass decomposition filter coefficients
§

fn high_pass_decomposition(&self) -> &[f64]

Get the high-pass decomposition filter coefficients
§

fn low_pass_reconstruction(&self) -> &[f64]

Get the low-pass reconstruction filter coefficients
§

fn high_pass_reconstruction(&self) -> &[f64]

Get the high-pass reconstruction filter coefficients
§

fn is_orthogonal(&self) -> bool

Check if the wavelet is orthogonal
§

fn is_biorthogonal(&self) -> bool

Check if the wavelet is biorthogonal

Auto Trait Implementations§

§

impl Freeze for Symlet

§

impl RefUnwindSafe for Symlet

§

impl Send for Symlet

§

impl Sync for Symlet

§

impl Unpin for Symlet

§

impl UnwindSafe for Symlet

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

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

§

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> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn into(self) -> U

Calls U::from(self).

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

§

impl<T> IntoEither for T

§

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
§

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
§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
§

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

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

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

§

type Error = Infallible

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

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

Performs the conversion.
§

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

§

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

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

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

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,