visbrain.mne.mne_plot_source_estimation¶
-
visbrain.mne.
mne_plot_source_estimation
(sbj, sbj_dir, fwd_file, stc_file=None, hemisphere='both', parc='aparc', active_data=0, kw_brain_obj={}, kw_source_obj={}, kw_activation={}, show=True)[source][source]¶ Plot source estimation.
- Parameters
- sbjstring
The subject name.
- sbj_dirstring
Path to the subject directory.
- fwd_filestring
The file name of the forward solution, which should end with -fwd.fif or -fwd.fif.gz.
- stc_filestring | None
Path to the .stc inverse solution file.
- hemisphere{‘left’, ‘both’, ‘right’}
The hemisphere to plot.
- parcstring | ‘aparc’
The parcellation to use, e.g., ‘aparc’ or ‘aparc.a2009s’.
- active_dataarray_like, int | 0
The data to set to vertices. If an stc file is provided and if active_data is an integer, it describes the time instant in which you want to see the activation. Otherwise, active_data must be an array with the same same shape as the number of active vertices.
- kw_brain_objdict | {}
Additional inputs to pass to the
visbrain.objects.BrainObj
class.- kw_source_objdict | {}
Additional inputs to pass to the
visbrain.objects.SourceObj
class.- kw_activationdict | {}
Additional inputs to pass to the
visbrain.objects.BrainObj.add_activation
method.- showbool | False
If True, the window of the
visbrain.Brain
module is automatically displayed. If False, avisbrain.objects.BrainObj
and avisbrain.objects.SourceObj
are returned. Finally, if ‘scene’avisbrain.objects.SceneObj
is returned.
- Returns
- b_objBrainObj
A predefined
visbrain.objects.BrainObj
(if show=False)- s_objSourceObj
A predefined
visbrain.objects.SourceObj
, hide by default (if show=False)