spiketools.plts.utils.check_ax

spiketools.plts.utils.check_ax(ax, figsize=None, return_current=False)[source]

Check whether a figure axes object is defined, and define or return current axis if not.

Parameters:
axmatplotlib.Axes or None

Axes object to check if is defined.

figsizetuple of float, optional

Size to make the axis.

return_currentbool, optional, default: False

Whether to return the current axis, if axis is not defined. If False, creates a new plot axis instead.

Returns:
axmatplotlib.Axes

Figure axes object to use.