nested_grid_plotter.multi_imshow#

nested_grid_plotter.multi_imshow(axes: Sequence[Axes], fig: Figure | SubFigure, data: Dict[str, ndarray[tuple[Any, ...], dtype[float64]]], xlabel: str | None = None, ylabel: str | None = None, imshow_kwargs: Dict[str, Any] | None = None, cbar_kwargs: Dict[str, Any] | None = None, is_symmetric_cbar: bool = False, cbar_title: str | None = None) → Colorbar[source]#

Plot multiple 2D field with imshow using a shared and scaled colorbar.

Parameters:

  • axes (Sequence[Axes]) – Sequence of axes on which to plot the given data.

  • fig (Figure) – The figure on which to plot the data. This is useful to position correctly the colorbar.

  • data (Dict[str, npt.NDArray[np.float64]]) – Dictionary of data arrays. Key are used as axis title.

  • xlabel (Optional[str], optional) – Label to apply to all xaxes. The default is None.

  • ylabel (Optional[str], optional) – Label to apply to all yaxes. The default is None.

  • imshow_kwargs (Optional[Dict[str, Any]], optional) – Optional arguments for plt.imshow. The default is None.

  • cbar_kwargs (Optional[Dict[str, Any]], optional) – DESCRIPTION. The default is None.

  • is_symmetric_cbar (bool, optional) – Does the scale need to be symmetric and centered to zero. The default is False.

  • cbar_title (Optional[str], optional) – Label to give to the colorbar. The default is None.

Raises:

ValueError – If the given data arrays do not have the required dimensionality (3).

Returns:

The color bar is returned so it can be further customized.

Return type:

Colorbar

On this page