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, optional
Start time of the plot (in ms). If None, plots from the start.
- tmaxfloat, optional
End time of the plot (in ms). If None, plots to the end.
- axinstance of matplotlib figure, optional
The matplotlib axis.
- layerstr, default=’agg’
The layer to plot. Can be one of ‘agg’, ‘L2’, and ‘L5’.
- decimint | list of int, optional
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, default=’k’
RGBA value to use for plotting.
- labelstr, default=’average’
Dipole label. Enabled when average=True.
- averagebool, default=False
If True, render the average across all dpls.
- showbool, default=True
If True, show the figure.
- Returns:
- figinstance of plt.fig
The matplotlib figure handle.
