piel.visual.plot.signals.dc.overlay

piel.visual.plot.signals.dc.overlay#

Attributes#

logger

Functions#

plot_signal_dc_collection_equivalent(signal_dc_collection)

Plots inputs vs outputs from a SignalDCCollection on a figure.

Module Contents#

logger#
plot_signal_dc_collection_equivalent(signal_dc_collection: piel.types.SignalDCCollection, fig: Any = None, axs: Any = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, title: str | piel.types.Unit = None, labels: list[str] = None, subplots_kwargs: dict = None, plot_kwargs: dict = None, **kwargs)[source]#

Plots inputs vs outputs from a SignalDCCollection on a figure.

Parameters:

  • signal_dc_collection (SignalDCCollection) – The collection of DC signals to plot.

  • fig (matplotlib.figure.Figure, optional) – Existing figure to plot on. If None, a new figure is created.

  • axs (list[matplotlib.axes.Axes, optional]) – Existing list of axes to plot on. If None, new axes are created. Plots on [0] by default.

  • subplots_kwargs (dict, optional) – Keyword arguments to pass to create_axes_per_figure.

  • xlabel (str | Unit, optional) – Label for the x-axis. If a Unit is provided, applies unit correction.

  • ylabel (str | Unit, optional) – Label for the y-axis. If a Unit is provided, applies unit correction.

  • title (str | Unit, optional) – Title for the plot.

  • **kwargs – Additional keyword arguments to pass to the save function.

Returns:

A tuple containing the figure and axes objects.

Return type:

tuple

Contents