Struct SSWTResult 

#[non_exhaustive]
pub struct SSWTResult {
    pub coefficients: Matrix2D<Complex64>,
    pub frequencies: Vec<f64>,
    pub instantaneous_frequency: Vec<Vec<f64>>,
    pub time: Vec<f64>,
    pub sampling_freq: f64,
    pub gamma_used: f64,
    pub sst_inversion_constant: f64,
}

Result of sswt.

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.

coefficients: Matrix2D<Complex64>

Reassigned coefficients in row-major [freq_bin, time] order.

frequencies: Vec<f64>

Output frequency grid in Hz, length SSWTConfig::num_freq_bins.

instantaneous_frequency: Vec<Vec<f64>>

Pre-reassignment instantaneous-frequency map indexed [scale][time]. Cells where |W(a, b)| <= γ (or the ratio is non-finite) are encoded as f64::NAN.

time: Vec<f64>

Time axis in seconds, length equal to the input signal.

sampling_freq: f64

Sampling frequency in Hz (copied from the config for self-containedness).

gamma_used: f64

The resolved γ actually used (the config’s value, or the auto 1e-6 · ‖x‖₂ if it was None).

sst_inversion_constant: f64

wavelet.sst_inversion_constant() captured during the forward transform. Used by sswt_extract_component for ridge inversion. Equals R_ψ = ∫₀^∞ Ψ̂*(ω) dω / ω — not the CWT admissibility constant C_ψ used by icwt. See crate::transform::ContinuousWavelet::sst_inversion_constant.

Implementations

impl SSWTResult

pub fn empty() -> Self

Construct an empty result suitable for reuse with sswt_into. All Vecs start empty; scalar metadata fields are zero. The first sswt_into call resizes everything in place; subsequent calls on the same instance reuse the existing allocations.

pub fn magnitude(&self) -> Vec<Vec<f64>>

Magnitude |T(ω, b)|.

pub fn power(&self) -> Vec<Vec<f64>>

Power |T(ω, b)|².

pub fn num_freq_bins(&self) -> usize

Number of reassigned frequency bins.

pub fn signal_length(&self) -> usize

Number of time samples per frequency bin.

pub fn coefficient(&self, freq_bin: usize, time_idx: usize) -> Option<Complex64>

Return the reassigned coefficient at (freq_bin, time_idx).

pub fn coefficient_row(&self, freq_bin: usize) -> Option<&[Complex64]>

Return a contiguous frequency-bin row of reassigned coefficients.

pub fn nearest_freq_bin(&self, hz: f64) -> usize

Index of the Self::frequencies bin closest to hz. Performs an O(N) linear scan; SST grids are small (typically num_freq_bins ≤ 1024).

Trait Implementations

impl Clone for SSWTResult

fn clone(&self) -> SSWTResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SSWTResult

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

Formats the value using the given formatter.