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:
sbj : string

The subject name.

sbj_dir : string

Path to the subject directory.

fwd_file : string

The file name of the forward solution, which should end with -fwd.fif or -fwd.fif.gz.

stc_file : string | None

Path to the .stc inverse solution file.

hemisphere : {‘left’, ‘both’, ‘right’}

The hemisphere to plot.

parc : string | ‘aparc’

The parcellation to use, e.g., ‘aparc’ or ‘aparc.a2009s’.

active_data : array_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_obj : dict | {}

Additional inputs to pass to the visbrain.objects.BrainObj class.

kw_source_obj : dict | {}

Additional inputs to pass to the visbrain.objects.SourceObj class.

kw_activation : dict | {}

Additional inputs to pass to the visbrain.objects.BrainObj.add_activation method.

show : bool | False

If True, the window of the visbrain.Brain module is automatically displayed. If False, a visbrain.objects.BrainObj and a visbrain.objects.SourceObj are returned. Finally, if ‘scene’a visbrain.objects.SceneObj is returned.

Returns:
b_obj : BrainObj

A predefined visbrain.objects.BrainObj (if show=False)

s_obj : SourceObj

A predefined visbrain.objects.SourceObj, hide by default (if show=False)

Examples using visbrain.mne.mne_plot_source_estimation