plot_input_current__matrix#

plot_input_current__matrix(
input_current__matrix,
timestep__ms,
axs,
apply_default_formatting=True,
**kwargs,
)[source]#

Plot the input current.

Parameters:

  • input_current__matrix (INPUT_CURRENT__MATRIX) – Matrix of shape (n_pools, t_points) containing current values Each row represents the current for one pool

  • timestep__ms (float) – Time step in milliseconds

  • axs (beartype.cave.IterableType[matplotlib.axes.Axes]) – Matplotlib axes to plot on. This could be the same axis for all pools, or a separate axis for each pool.

  • apply_default_formatting (bool) – Whether to apply default formatting to the plot

  • **kwargs (dict) – Additional keyword arguments to pass to the plot function. Only used if apply_default_formatting is False.

Returns:

The axes that were plotted on

Return type:

beartype.cave.IterableType[matplotlib.axes.Axes]

Raises:

ValueError – If the number of axes does not match the number of pools