piel.visual.plot.signals.time

piel.visual.plot.signals.time#

Submodules#

Functions#

plot_multi_data_time_signal_equivalent(multi_signal[, ...])

Plots all rising edge signals on the same figure with a shared x-axis.

plot_multi_data_time_signal_different(multi_signal[, ...])

Plots all rising edge signals on the same figure, but with a shared x-axis and multiple y-axes.

plot_time_signal_data(signal[, fig, axs, ...])

Plots a single time signal on a figure.

Package Contents#

plot_multi_data_time_signal_equivalent(multi_signal: piel.types.MultiTimeSignalData, fig: Any = None, axs: Any = None, subplots_kwargs: dict = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, **kwargs)[source]#

Plots all rising edge signals on the same figure with a shared x-axis.

Parameters:

  • multi_signal (List[TimeSignalData]) – List of rising edge signals.

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

Returns:

None

plot_multi_data_time_signal_different(multi_signal: piel.types.MultiTimeSignalData, fig: Any = None, axs: Any = None, subplots_kwargs: dict = None, xlabel: str | piel.types.Unit | list[piel.types.Unit] = None, ylabel: str | piel.types.Unit | list[piel.types.Unit] | list = None, title: str | piel.types.Unit | list = None, time_range_s: Tuple[float, float] = None, labels: list[str] = None, **kwargs)[source]#

Plots all rising edge signals on the same figure, but with a shared x-axis and multiple y-axes.

Parameters:

  • multi_signal (MultiTimeSignalData) – List of rising edge signals.

  • fig (Any) – Figure object.

  • axs (Any) – Axes object.

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

  • xlabel (str | Unit | list[Unit]) – Label for x-axis.

  • ylabel (str | Unit | list[Unit] | list) – Label for y-axis.

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

  • time_range_s (Tuple[float, float]) – Tuple indicating the (start, end) time for the x-axis range.

Returns:

Figure and Axes objects.

Return type:

fig (Any), axs (Any)

plot_time_signal_data(signal: piel.types.TimeSignalData, fig: Any = None, axs: Any = None, subplots_kwargs: dict = None, xlabel: str | piel.types.Unit = None, ylabel: str | piel.types.Unit = None, title: str | piel.types.Unit = None, **kwargs)[source]#

Plots a single time signal on a figure.

Parameters:

  • signal (TimeSignalData) – The time signal 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