Base module for the plotting facilities.
brian_plot(brian_obj, axes=None, **kwds)¶
Plot the data of the given object (e.g. a monitor). This function will call an adequate plotting function for the object, e.g.
SpikeMonitor. The plotting may apply heuristics to get a generally useful plot (e.g. for a
PopulationRateMonitor, it will plot the rates smoothed with a Gaussian window of 1 ms), the exact details are subject to change. This function is therefore mostly meant as a quick and easy way to plot an object, for full control use one of the specific plotting functions.
- brian_obj (object) – The Brian object to plot.
- axes (
Axes, optional) – The
Axesinstance used for plotting. Defaults to
Nonewhich means that a new
Axeswill be created for the plot.
- kwds (dict, optional) – Any additional keywords command will be handed over to matplotlib’s
plotcommand. This can be used to set plot properties such as the
axes – The
Axesinstance that was used for plotting. This object allows to modify the plot further, e.g. by setting the plotted range, the axis labels, the plot title, etc.
add_background_pattern(axes, hatch='xxx', fill=True, fc=(0.9, 0.9, 0.9), ec=(0.8, 0.8, 0.8), zorder=-10, **kwds)¶
Add a “hatching” pattern to the background of the axes (can be useful to make a difference between “no value” and a value mapped to a color value that is identical to the background color). By default, it uses a cross hatching pattern in gray which can be changed by providing the respective arguments. All additional keyword arguments are passed on to the
- axes (
matplotlib.axes.Axes) – The axes where the background pattern should be added.
- hatch (str, optional) – See
matplotlib.patches.Patch.set_hatch. Defaults to
- fill (bool, optional) – See
matplotlib.patches.Patch.set_fill. Defaults to
- fc (mpl color spec or None or 'none') – See
matplotlib.patches.Patch.set_facecolor. Defaults to
(0.9, 0.9, 0.9).
- ec (mpl color spec or None or 'none') – See
matplotlib.patches.Patch.set_edgecolor. Defaults to
(0.8, 0.8, 0.8).
- zorder (int) – See
matplotlib.artist.Artist.set_zorder. Defaults to
- axes (