differt.plotting.process_matplotlib_kwargs

differt.plotting.process_matplotlib_kwargs#

process_matplotlib_kwargs(kwargs)[source]#

Process keyword arguments passed to some Matplotlib plotting utility.

Parameters:

kwargs (MutableMapping[str, Any]) –

A mutable mapping of keyword arguments passed to Matplotlib plotting.

Warning

The keys specified below will be removed from the mapping.

Keyword Arguments:

  • figure (Figure) – The figure that draws contents of the scene. If not provided, will try to access figure from ax (if supplied).

  • ax (Axes3D) – The view on which contents are displayed. If not provided, will try to get axes from figure (if supplied). The default axes will use a 3D projection.

Warning

When supplying both figure and ax, user must ensure that ax in figure.axes evaluates to True.

Return type:

tuple[Figure, Axes3D]

Returns:

The figure and axes used to display contents.

Contents