# Rust API

The Rust API documentation is generated by rustdoc into this site's `rust/` folder. Start from the
crate for the layer you need:

| Crate | What it holds |
|---|---|
| <a href="../rust/modewise_signals/index.html">modewise_signals</a> | `MultichannelSeries` and `SamplingRate` |
| <a href="../rust/modewise_decomposition/index.html">modewise_decomposition</a> | `Decomposition`, `ModeDecomposer`, instantaneous attributes and loadings |
| <a href="../rust/modewise_spectral/index.html">modewise_spectral</a> | `TimeFrequencyMap` and `TimeFrequencyTransform` |
| <a href="../rust/modewise_mvmd/index.html">modewise_mvmd</a>, <a href="../rust/modewise_emd/index.html">modewise_emd</a>, <a href="../rust/modewise_wavelet/index.html">modewise_wavelet</a>, <a href="../rust/modewise_vlmd/index.html">modewise_vlmd</a> | decompositions |
| <a href="../rust/modewise_stft/index.html">modewise_stft</a>, <a href="../rust/modewise_cwt/index.html">modewise_cwt</a>, <a href="../rust/modewise_hilbert/index.html">modewise_hilbert</a> | spectra and time–frequency maps |
| <a href="../rust/modewise_fc/index.html">modewise_fc</a>, <a href="../rust/modewise_stats/index.html">modewise_stats</a> | connectivity and group statistics |
| <a href="../rust/modewise_pipeline/index.html">modewise_pipeline</a>, <a href="../rust/modewise_operations/index.html">modewise_operations</a> | the pipeline engine and the built-in operations |
| <a href="../rust/modewise_dataset/index.html">modewise_dataset</a>, <a href="../rust/modewise_results/index.html">modewise_results</a> | datasets on disk and results folders |

Run `cargo doc --workspace --no-deps --open` to read it locally.