hnn_core.viz.plot_dipole

hnn_core.viz.plot_dipole(dpl, tmin=None, tmax=None, ax=None, layer='agg', decim=None, color='k', label='average', average=False, show=True)[source]

Simple layer-specific plot function.

Parameters
dplinstance of Dipole | list of Dipole instances

The Dipole object.

tminfloat or None

Start time of plot in milliseconds. If None, plot entire simulation.

tmaxfloat or None

End time of plot in milliseconds. If None, plot entire simulation.

axinstance of matplotlib figure | None

The matplotlib axis

layerstr

The layer to plot. Can be one of ‘agg’, ‘L2’, and ‘L5’

decimint or list of int or None (default)

Optional (integer) factor by which to decimate the raw dipole traces. The SciPy function decimate() is used, which recommends values <13. To achieve higher decimation factors, a list of ints can be provided. These are applied successively.

colortuple of float | str

RGBA value to use for plotting. By default, ‘k’ (black)

labelstr

Dipole label. Enabled when average=True

averagebool

If True, render the average across all dpls.

showbool

If True, show the figure

Returns
figinstance of plt.fig

The matplotlib figure handle.

Examples using hnn_core.viz.plot_dipole