API reference

Generated from the docstrings in src/ssvep by mkdocstrings, so it cannot drift from the code the way a hand-written reference does. If something here is wrong, fix the docstring.

The decode, spectral and metrics layers take plain arrays plus sfreq — shape (n_channels, n_times) — and nothing else. That boundary is deliberate: the same function runs offline over a whole recording and online over a single sliding window, so an online result and an offline one cannot disagree because they went through different code.

The reference has one page per subpackage:

• ssvep.classification — the decode engine: decoding, spectral analysis, metrics and visualisation.
• ssvep.stim — stimulus design: flicker math and design-time validation, the run builder, image stimuli.
• ssvep.runtime — sessions and acquisition: the run plan, the session protocol and resolver, session purpose and data-use tier, and the session lifecycle.
• ssvep.io — manifests and data: run manifest I/O and BIDS conversion.
• ssvep.analysis — offline pipelines: the batch pipeline, between-condition contrasts, the contrast report and the synthetic dataset generator.