pybop.plot.dataset#

Functions#

dataset(dataset[, signal, labels, show, backend, ...])

Quickly plot a PyBOP Dataset using Plotly.

Module Contents#

pybop.plot.dataset.dataset(dataset, signal=None, labels=None, show=True, backend=None, figures=None, axes=None)[source]#

Quickly plot a PyBOP Dataset using Plotly.

Parameters:

  • dataset (object) – A PyBOP dataset.

  • signal (list or str, optional) – The name of the time series to plot (default: “Voltage [V]”).

  • labels (list or str, optional) – Name(s) for the trace(s) (default: “Data”).

  • show (bool, optional) – If True, the figure is shown upon creation (default: True).

  • backend (str or pybop.plot.backends.PlotBackend, optional) – The plotting backend to be used.

  • figures (figure object, optional) – Figure for plotting. If not provided a new figure is created

  • axes (axis, optional) – Thes axis to be used for plotting plotly: axis expected to be of the form tuple(row, col)

Returns:

  • fig (if show is False; plotly.graph_objs.Figure or matplotlib.figure.Figure) – The figure object for the scatter plot.

  • None (if show is True)