CADETProcess.modelBuilder.FlipFlop.plot_events

FlipFlop.plot_events(x_axis_in_minutes: bool = True, ax: ndarray[Axes] | None = None, setup_figure_kwargs: dict | None = None) → tuple[Figure, ndarray[tuple[Any, ...], dtype[Axes]]]

Plot parameter state as a function of time.

The method creates a plot for each parameter timeline and displays the state of the parameter against time. The time is represented on the x-axis, while the parameter state is shown on the y-axis.

Parameters:

x_axis_in_minutes: bool, default=True

If True, the x-axis will be plotted using minutes.

axnp.ndarray[plt.Axes] | None, default=None

Optional array of Matplotlib Axes. If not provided, a new figure is created.

setup_figure_kwargsdict | None, default=None

Additional options to setup the figure.

Returns:

tuple[plt.Figure, npt.NDArray[plt.Axes]]

Figure and axes objects.

Notes

The time is divided into 1001 linearly spaced points between 0 and the cycle time for the evaluation of the parameter state.