helper module

Define types and helpers for the visualization library.

create_fig_if_not_exists(axnum, sharex=False, num=1, clean_fig=False, **kwargs)

Check if figures were already created, create it if not.

Parameters:

• axnum (int | list[int] | range) – Axes indexes as understood by Figure.add_subplot, or number of desired axes.

• sharex (bool, optional) – If x axis should be shared. The default is False.

• num (int, optional) – Fig number. The default is 1.

• clean_fig (bool, optional) – If the previous plot should be erased from Figure. The default is False.

Return type:

tuple[Figure, list[Axes]]

clean_figures(fig_ids)

Clean axis of Figs in fignumlist.

Parameters:

fig_ids (Sequence[int | str | Figure | SubFigure])

Return type:

None

clean_axes(ax_ids)

Clean given axis.

Parameters:

ax_ids (Sequence[Axes])

Return type:

None

remove_artists(axe)

Remove lines and plots, but keep labels and grids.

Parameters:

axe (Axes)

Return type:

None

savefig(fig, filepath)

Save the figure.

Parameters:

• fig (Figure)

• filepath (Path)

Return type:

None