src.canns.analyzer.plotting.config

Reusable plotting configuration utilities for analyzer visualizations.

Classes

PlotConfig	Unified configuration class for all plotting helpers in canns.analyzer.
PlotConfigs	Collection of commonly used plot configurations.

Module Contents

class src.canns.analyzer.plotting.config.PlotConfig

Unified configuration class for all plotting helpers in canns.analyzer.

This mirrors the behaviour of the previous visualize module so that reorganising the files does not affect the public API. The attributes map directly to keyword arguments exposed by the high-level plotting functions, allowing users to keep existing configuration objects unchanged after the reorganisation.

__post_init__()

classmethod for_animation(time_steps_per_second, **kwargs)

Return configuration tailored for animations.

classmethod for_static_plot(**kwargs)

Return configuration tailored for static plots.

to_matplotlib_kwargs()

Materialize matplotlib keyword arguments from the config.

clabel: str = 'Value'

color: str = 'black'

figsize: tuple[int, int] = (10, 6)

fps: int = 30

grid: bool = False

kwargs: dict[str, Any] | None = None

repeat: bool = True

save_path: str | None = None

show: bool = True

show_legend: bool = True

show_progress_bar: bool = True

time_steps_per_second: int | None = None

title: str = ''

xlabel: str = ''

ylabel: str = ''

class src.canns.analyzer.plotting.config.PlotConfigs

Collection of commonly used plot configurations.

These helpers mirror the presets that existed in canns.analyzer.visualize so that callers relying on them continue to receive the exact same defaults.

static average_firing_rate_plot(mode='per_neuron', **kwargs)

static energy_landscape_1d_animation(**kwargs)

static energy_landscape_1d_static(**kwargs)

static energy_landscape_2d_animation(**kwargs)

static energy_landscape_2d_static(**kwargs)

static grid_cell_manifold_static(**kwargs)

static raster_plot(mode='block', **kwargs)

static theta_population_activity_static(**kwargs)

static theta_sweep_animation(**kwargs)

static tuning_curve(num_bins=50, pref_stim=None, **kwargs)