mne.viz.plot_chpi_snr#
- mne.viz.plot_chpi_snr(snr_dict, axes=None)[source]#
Plot time-varying SNR estimates of the HPI coils.
- Parameters:
- snr_dict
dict
The dictionary returned by
compute_chpi_snr
. Must have keystimes
,freqs
,TYPE_snr
,TYPE_power
, andTYPE_resid
(whereTYPE
can bemag
orgrad
or both).- axes
None
|list
ofmatplotlib.axes.Axes
Figure axes in which to draw the SNR, power, and residual plots. The number of axes should be 3× the number of MEG sensor types present in
snr_dict
. IfNone
(the default), a newFigure
is created with the required number of axes.
- snr_dict
- Returns:
- figinstance of
matplotlib.figure.Figure
A figure with subplots for SNR, power, and residual variance, separately for magnetometers and/or gradiometers (depending on what is present in
snr_dict
).
- figinstance of
Notes
If you supply a list of existing
Axes
, then the figure legend will not be drawn automatically. If you still want it, runningfig.legend(loc='right', title='cHPI frequencies')
will recreate it, though you may also need to manually adjust the margin to make room for it (e.g., usingfig.subplots_adjust(right=0.8)
).New in version 0.24.
Examples using mne.viz.plot_chpi_snr
#
Extracting and visualizing subject head movement