eegdash.viz package#

Submodules#

Module contents#

EEGDash visualization helpers (palette, Data Rail, figure-level styling).

Public surface:

  • use_eegdash_style() – one-call rcParams + palette setup for tutorials.

  • style_figure() – apply the EEGDash identity to every axes in a figure and attach the title/subtitle/source block + Data Rail.

  • chance_line() – add a labelled chance-level reference line.

  • Palette constants EEGDASH_BLUE, EEGDASH_ORANGE, …, EEGDASH_PALETTE.

eegdash.viz.chance_line(ax, level: float, *, label: str = 'chance')[source]

Add a horizontal dashed reference line at level.

eegdash.viz.get_eegdash_palette(n: int) → list[str][source]

Return n colors from the EEGDash data-viz palette.

eegdash.viz.style_figure(fig, *, title: str, subtitle: str = '', source: str = '', data_rail: bool = True, grid_axis: str = 'y') → None[source]

Apply the EEGDash identity to every axes in fig.

Parameters:

  • fig (matplotlib.figure.Figure) – Target figure.

  • title (str) – Short, 1-line figure title (top-left).

  • subtitle (str) – Dataset/task/split context line.

  • source (str) – Provenance footer (italic, bottom-left).

  • data_rail (bool, default True) – Attach the Data Rail.

  • grid_axis ({"y", "x", "both", "none"}) – Grid orientation.

eegdash.viz.use_eegdash_style() → None[source]

Configure matplotlib (and seaborn if installed) for EEGDash plots.