Caution

You're reading the documentation for a development version. For the latest released version, please have a look at 0.11.0.

librosa.display.colorbar_db

librosa.display.colorbar_db(im, *, ax=None, fig=None, format='% -3.f', **kwargs)

Attach a colorbar to an image representing decibel-scaled data.

Parameters:

immatplotlib.cm.ScalarMappable

The image to which the colorbar will be attached. Generally this will be a matplotlib.image.AxesImage or matplotlib.collections.QuadMesh as returned by specshow.

axmatplotlib.axes.Axes or None

The axes to which the colorbar will be attached. If None, the colorbar will be attached to the axes of im.

figmatplotlib.figure.Figure, SubFigure, or None

The figure to which the colorbar will be attached. If None, the colorbar will be attached to the figure of im.

formatstr

The format string for the colorbar ticks. Default is “% -3.f”, which displays integer values. You can change this to a different format if needed.

**kwargs

Additional keyword arguments to pass to fig.colorbar.

Returns:

cbarmatplotlib.colorbar.Colorbar

The created colorbar object.

See also

specshow

colorbar_phase

matplotlib.colorbar.Colorbar

Examples

Attach a colorbar to a magnitude spectrogram

>>> import matplotlib.pyplot as plt
>>> import librosa
>>> y, sr = librosa.loadx('trumpet')
>>> S = librosa.stft(y)
>>> fig, ax = plt.subplots()
>>> im = librosa.display.specshow(S, ax=ax, y_axis='log', x_axis='time', vscale='dB')
>>> librosa.display.colorbar_db(im)
>>> plt.show()

Attach a colorbar to one subplot axes. We can also set a label for the colorbar.

>>> fig, ax = plt.subplots(nrows=2, sharex=True, sharey=True)
>>> im_mag = librosa.display.specshow(S, ax=ax[0], y_axis='log', x_axis='time', vscale='dBFS')
>>> cbar = librosa.display.colorbar_db(im_mag, ax=ax[0], label='dBFS')
>>> im_ph = librosa.display.specshow(S, ax=ax[1], y_axis='log', x_axis='time', vscale='dphase')
>>> cbar = librosa.display.colorbar_phase(im_ph, ax=ax[1])
>>> ax[0].label_outer()
>>> plt.show()