API Reference¶

Note

The API reference below is auto-generated from the source code docstrings and is maintained in English only. This is consistent with the practice adopted by major scientific Python projects (NumPy, SciPy, scikit-learn) and reflects the technical audience of the reference material. Narrative documentation (tutorial, background, usage, algorithms) is available in Portuguese.

This page documents every public module in the chaotic_pfc package. Each link below opens the module’s reference, listing its functions, classes, and dataclasses with full signatures and NumPy-style docstrings extracted from the source.

`chaotic_pfc.dynamics.maps`	maps.py Hénon map variants used as chaotic oscillators throughout the communication system.
`chaotic_pfc.dynamics.signals`	signals.py Generators for the information-bearing messages used throughout the chaotic communication pipeline.
`chaotic_pfc.dynamics.lyapunov`	lyapunov.py Lyapunov exponent computation for the Hénon map (2-D) and the Hénon map with a pole filter (4-D).
`chaotic_pfc.dynamics.spectral`	spectral.py Power-spectral-density estimation utilities used by the plotting layer.
`chaotic_pfc.comms.transmitter`	transmitter.py Chaos-based modulator. Implements the Transmitter protocol — a callable that embeds a message in the state of a Hénon oscillator.
`chaotic_pfc.comms.channel`	channel.py Transmission-channel models sitting between the chaotic transmitter and the receiver.
`chaotic_pfc.comms.receiver`	receiver.py Chaos-synchronisation demodulator. Implements the Receiver protocol — a callable that extracts the original message from a transmitted (and possibly channel-distorted) carrier.
`chaotic_pfc.comms.protocols`	Structural contracts for the communication pipeline.
`chaotic_pfc.analysis.sweep`	Parameter-sweep computation of Lyapunov exponents for the Henon map with an internal FIR filter.
`chaotic_pfc.analysis.stats`	Statistical analysis of Lyapunov sweep results.
`chaotic_pfc.analysis.latex_export`	LaTeX table export for chaotic-PFC analysis results.
`chaotic_pfc.analysis.sweep_plotting`	sweep_plotting.py Figures for Lyapunov classification maps produced by chaotic_pfc.sweep.
`chaotic_pfc.analysis.sweep_plotting_3d`	sweep_plotting_3d.py Plotly-based 3-D visualisation of a stack of Kaiser β-sweeps.
`chaotic_pfc.plotting.figures`	figures.py Publication-quality SVG figures with LaTeX-style labels.
`chaotic_pfc.config`	config.py Centralised configuration for all experiments.
`chaotic_pfc.cli`	cli Unified command-line interface for the chaotic_pfc package.