mne_gui_addons.view_vol_stc

mne_gui_addons.view_vol_stc(stcs, freq_first=True, group=False, subject=None, subjects_dir=None, src=None, inst=None, use_int=True, show_topomap=True, tmin=None, tmax=None, show=True, block=False, verbose=None)

View a volume time and/or frequency source time course estimate.

Parameters:

stcslist of list | generator

The source estimates, the options are: 1) List of lists or generators for epochs and frequencies (i.e. using mne.minimum_norm.apply_inverse_tfr_epochs() or mne.beamformer.apply_dics_tfr_epochs()– in this case use freq_first=False), or 2) List of source estimates across frequencies (e.g. mne.beamformer.apply_dics_csd()), or 3) List of source estimates across epochs (e.g. mne.minimum_norm.apply_inverse_epochs() and mne.beamformer.apply_dics_epochs()–in this case use freq_first=False), or 4) Single source estimates (e.g. mne.minimum_norm.apply_inverse() and mne.beamformer.apply_dics(), note freq_first will not be used in this case), or 5) List of list of lists or generators for subjects and frequencies and epochs (e.g. mne.minimum_norm.apply_inverse_tfr_epochs() for each subject in a list; use group=True), or 6) List or generator for subjects with stcs from evoked data (e.g. mne.minimum_norm.apply_inverse() or mne.beamformer.apply_dics_csd() for each subject in a list; use group=True).

freq_firstbool

If frequencies are the outer list of stcs use True.

groupbool | str

If data is from different subjects is, group should be True. If data is in time-frequency, group should be 'ITC' to show inter-trial coherence (power is shown by default).

subjectstr

The FreeSurfer subject name.

subjects_dirpath-like | None

The path to the directory containing the FreeSurfer subjects reconstructions. If None, defaults to the SUBJECTS_DIR environment variable.

srcinstance of SourceSpaces

The volume source space for the stc.

instEpochsTFR | AverageTFR | None | list

The time-frequency or data instances to use to plot topography. If group-level results are given (group=True), a list of instances should be provided.

use_intbool

If True, cast the data to integers to reduce memory use.

show_topomapbool

Whether to show the sensor topomap in the GUI.

tminscalar

Time point of the first sample in data.

tmaxscalar

Time point of the last sample in data.

showbool

Show the GUI if True.

blockbool

Whether to halt program execution until the figure is closed.

verbosebool | str | int | None

Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

Returns:

guiinstance of VolSourceEstimateViewer

The graphical user interface (GUI) window.

Examples using mne_gui_addons.view_vol_stc

Volume Source Time Course Estimate for a Group Study

Volume Source Time Course Estimate for a Group Study

Compute evoked ERS source power using DICS, LCMV beamformer, and dSPM

Compute evoked ERS source power using DICS, LCMV beamformer, and dSPM