add_colorbar

gammapy.visualization.add_colorbar(img, ax, axes_loc=None, **kwargs)

Add colorbar to a given axis.

Parameters

imgAxesImage

The image to plot the colorbar for.

axAxes

Matplotlib axes.

axes_locdict, optional

Keyword arguments passed to append_axes.

kwargsdict, optional

Keyword arguments passed to colorbar.

Returns

cbarcolorbar

The colorbar.

Examples

from gammapy.maps import Map
from gammapy.visualization import add_colorbar
import matplotlib.pyplot as plt
map_ = Map.read("$GAMMAPY_DATA/cta-1dc-gc/cta-1dc-gc.fits.gz")
axes_loc = {"position": "right", "size": "2%", "pad": "10%"}
kwargs_colorbar = {'label':'Colorbar label'}

# Example outside gammapy
fig = plt.figure(figsize=(6, 3))
ax = fig.add_subplot(111)
img = ax.imshow(map_.sum_over_axes().data[0,:,:])
add_colorbar(img, ax=ax, axes_loc=axes_loc, **kwargs_colorbar)

# `add_colorbar` is available for the `plot` function here:
fig = plt.figure(figsize=(6, 3))
ax = fig.add_subplot(111)
map_.sum_over_axes().plot(ax=ax, add_cbar=True, axes_loc=axes_loc,
                          kwargs_colorbar=kwargs_colorbar)