Struct SSWTPlan 

pub struct SSWTPlan { /* private fields */ }

Reusable SSWT execution plan.

A plan owns an SSWTConfig and precomputes config-derived state that is otherwise rebuilt on every sswt / sswt_into call: the output frequency grid, scale-integration weights, frequency-bin mapper, and SST inversion constant. It also lazily caches the CWT wavelet spectra for the most recent signal FFT length. Use it when repeatedly applying the same SSWT configuration to many signals or rolling windows.

The plan-owned spectrum cache costs roughly scales.len() * fft_size * size_of::<Complex64>() bytes for the most recent FFT length. Planned transforms also reuse a thread-local flat CWT coefficient scratch buffer that can grow to scales.len() * signal.len() * size_of::<Complex64>() bytes per calling thread. SSWTPlan::new defaults to SSWTPlanMemoryMode::Balanced; use SSWTPlan::with_options with SSWTPlanOptions::fast to enable capped parallel reassignment with up to four transient partial output planes for large transforms.

The input-dependent pieces remain per-call: signal-length validation, gamma resolution when SSWTConfig::gamma is None, the signal FFT, and the output/time buffers.

Implementations

impl SSWTPlan

pub fn new(config: SSWTConfig) -> Result<Self>

Build a reusable plan from an SSWTConfig.

This validates every config-only invariant. Signal length is checked when the plan is executed because it depends on the input.

pub fn with_options( config: SSWTConfig, options: SSWTPlanOptions, ) -> Result<Self>

Build a reusable plan from an SSWTConfig and explicit options.

This validates every config-only invariant. Signal length is checked when the plan is executed because it depends on the input.

pub fn config(&self) -> &SSWTConfig

Return the configuration owned by this plan.

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

Return the cached output frequency grid in Hz.

pub fn options(&self) -> SSWTPlanOptions

Return the options used by this plan.

pub fn transform(&self, signal: &Signal<f64>) -> Result<SSWTResult>

Execute the plan and return a fresh SSWTResult.

pub fn transform_into( &self, signal: &Signal<f64>, out: &mut SSWTResult, ) -> Result<()>

Execute the plan into a caller-supplied result, reusing result buffers.

Trait Implementations

impl Debug for SSWTPlan

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

Formats the value using the given formatter.