wavelet_coherence

iron_wave::analysis::coherence

Function wavelet_coherence 

Source 
pub fn wavelet_coherence<T>(
    signal1: &Signal<T>,
    signal2: &Signal<T>,
    wavelet: &dyn ContinuousWavelet,
    scales: &[f64],
    sampling_freq: f64,
    config: Option<CoherenceConfig>,
) -> Result<CoherenceResult<T>>
where
    T: Float + FromPrimitive + Send + Sync + SignalType + AddAssign + SubAssign + MulAssign + DivAssign + RemAssign,
Expand description

Compute wavelet coherence between two signals

This function computes the wavelet coherence, which measures the time-localized correlation between two signals in the time-frequency domain.

§Arguments

  • signal1 - First input signal
  • signal2 - Second input signal
  • wavelet - Continuous wavelet to use (e.g., Morlet)
  • scales - Array of scale values to compute
  • sampling_freq - Sampling frequency of the signals
  • config - Optional configuration for smoothing parameters

§Returns

A CoherenceResult containing coherence, phase, and power spectra

§Errors

Returns error if:

  • Signals have different lengths
  • Signals are empty
  • Scales array is empty
  • CWT computation fails