rizer.misc.simulation.plot_registry#

Canonical registries for plot kinds and experimental quantities.

Single source of truth for (a) which SimulationPlotter plot methods exist and what experimental data they can overlay, and (b) the fixed vocabulary of experimental quantities produced by rizer.io.experimental_data.load_experiment_data. The Rizer Spice backend (and, through it, the frontend) reads both from here instead of each hand-maintaining its own copy of these lists.

Attributes#

Classes#

PlotKind

One SimulationPlotter plot method and its experiment-comparison needs.

Module Contents#

class rizer.misc.simulation.plot_registry.PlotKind#

One SimulationPlotter plot method and its experiment-comparison needs.

Parameters:
  • id (str) – Name of the corresponding SimulationPlotter method.

  • display_name (str) – Human-readable label for UI pickers.

  • requires_simulation (bool, optional) – False for a plot kind whose only content can be an experiment overlay (experiment_quantities non-empty) – the simulated curve, if any run is also selected, is additive, not required. Default True.

  • experiment_quantities (tuple of str, optional) – Canonical quantity names (keys of rizer.io.experimental_data.load_experiment_data._UNIT_VARIANTS) this plot can overlay experimental data for. Empty if the plot has no experiment-comparison mode. Default empty.

  • curve_groups (tuple of str, optional) – Curve-group ids this plot can emit, each shared by every run’s/ experiment’s trace of that kind (e.g. “mid_cable_voltage”) – the frontend’s curve-checkbox list source of truth. Empty for a plot kind with no per-curve visibility toggle. Default empty.

id: str#
display_name: str#
requires_simulation: bool = True#
experiment_quantities: tuple[str, Ellipsis] = ()#
curve_groups: tuple[str, Ellipsis] = ()#
rizer.misc.simulation.plot_registry.ELECTRICAL_SIGNALS_SIM_ATTRS: dict[str, tuple[str, str, float]]#
rizer.misc.simulation.plot_registry.ELECTRICAL_SIGNALS_EXPERIMENT_ATTRS: dict[str, tuple[str, str]]#
rizer.misc.simulation.plot_registry.PLOT_KINDS: tuple[PlotKind, Ellipsis]#
rizer.misc.simulation.plot_registry.PLOT_KINDS_BY_ID: dict[str, PlotKind]#