Enum ContinuousWaveletSpec 

#[non_exhaustive]
pub enum ContinuousWaveletSpec {
    Morlet {
        omega: f64,
    },
    Paul {
        order: usize,
    },
    Dog {
        order: usize,
    },
}

Continuous wavelet selector for productized CWT analytics. Each variant maps to a ferro_wave::transform analytic-friendly continuous wavelet.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Morlet

Morlet wavelet with central frequency omega0 (typical 5–6). Recommended default for daily EOD phase coherence.

Fields

omega: f64

Central angular frequency ω₀ of the Morlet wavelet.

Paul

Paul wavelet of integer order. Asymmetric time localisation; good for modulated oscillation detection.

Order is bounded to 1..=MAX_PAUL_ORDER at config-validate time. The underlying ComplexPaul evaluates factorial(order) per cell during normalisation; orders past ~20 risk f64 overflow (170! is the largest representable factorial), and orders past the typical practical range (1–10) burn CPU on factorial growth without changing the wavelet’s qualitative shape.

Fields

order: usize

Paul wavelet order parameter (m).

Dog

Derivative-of-Gaussian wavelet of integer order.

Only order == 2 (the complex Mexican-hat DOG) is supported today. Arbitrary-order DOG is reserved for a future ferro-wave release and CwtPhaseCoherenceConfig::validate rejects other values at config-validate time. The variant carries order in the API to lock the future contract; serde round-trips of any order succeed, but only Dog { order: 2 } actually computes.

Fields

order: usize

DOG order parameter (must be 2 for now).

Implementations

impl ContinuousWaveletSpec

pub fn as_str(self) -> &'static str

Stable wire-friendly identifier.

pub fn fourier_factor(self) -> f64

Canonical Fourier factor λ/s relating wavelet scale s to the equivalent Fourier period λ = (λ/s)·s, from Torrence & Compo (1998), “A Practical Guide to Wavelet Analysis”, BAMS 79(1), Table 1:

• Morlet(ω₀): 4π / (ω₀ + √(2 + ω₀²)) — for ω₀=6 this is ≈1.03304.
• Paul(m): 4π / (2m + 1).
• DOG(m): 2π / √(m + ½) — for m=2 (Mexican hat) ≈3.97384.

A target analysis period P therefore maps to scale s = P / (λ/s). The earlier implementation used the naive peak-frequency relation λ/s = 2π/ω₀ (≈1.0472 for ω₀=6), biasing the scale–period map by ~1.4%.

Trait Implementations

impl Clone for ContinuousWaveletSpec

fn clone(&self) -> ContinuousWaveletSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContinuousWaveletSpec

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

Formats the value using the given formatter.

impl Default for ContinuousWaveletSpec

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ContinuousWaveletSpec

fn eq(&self, other: &ContinuousWaveletSpec) -> 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 Copy for ContinuousWaveletSpec

impl StructuralPartialEq for ContinuousWaveletSpec