pybop.plot.problem#

Functions#

problem(problem[, inputs, title, show, backend, ...])

Produce a quick plot of the target dataset against optimised model output.

Module Contents#

pybop.plot.problem.problem(problem: pybop.problems.problem.Problem, inputs: pybop.parameters.parameter.Inputs = None, title='Scatter Plot', show: bool = True, backend: str = None, figures=None, axes=None)[source]#

Produce a quick plot of the target dataset against optimised model output.

Generates an interactive plot comparing the simulated model output with an optional target dataset and visualises uncertainty.

Parameters:

  • problem (pybop.Problem) – Problem object with dataset and targets attributes.

  • inputs (Inputs) – Optimised (or example) parameter values.

  • title (str, optional:) – The title of the plot (default: “Scatter Plot”)

  • 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 for each problem. Can be a single figure or one figure per target.

  • axes (axis, optional) – The axes to be used for plotting. One axis per target is expected. plotly: axes expected to be of the form list of tuple(row, col)

Returns:

  • None (if show is True)

  • Figure or list of figures (if show is False) – A single figure or a list of figures containing the plots for each target in the problem. If show is True, the figures will be displayed and None will be returned.