Ctrl+K

default_plot

Contents

default_plot#

Class method.

default_plot(data, states_list=None, dae_states_list=None, inputs_list=None, aux_list=None, **kwargs)[source]#

Pass a do_mpc.data.Data object and create a default do-mpc plot. By default all states, inputs and auxiliary expressions are plotted on individual axes. Pass lists of states, inputs and aux names (string) to plot only a subset of these trajectories.

Returns a figure, axis and configured Graphics object.

Parameters:

  • data – do-mpc data instance.

  • states_list (list) – List of strings containing a subset of state names defined in py:class:do_mpc.model.Model. These states are plotted.

  • dae_states_list (list) – List of strings containing a subset of dae states (_z) names defined in py:class:do_mpc.model.Model. These states are plotted.

  • inputs_list (list) – List of strings containing a subset of input names defined in py:class:do_mpc.model.Model. These inputs are plotted.

  • aux_list (list) – List of strings containing a subset of auxiliary expression names defined in py:class:do_mpc.model.Model. These values are plotted.

  • kwargs – Further arguments are passed to the call of plt.subplots(n_plot, 1, sharex=True, **kwargs).

Returns:

Tuple[figure, axes, Graphics] – Matplotlib fig and ax and configured Graphics object.

This page is auto-generated. Page source is not available on Github.

Contents