mne.gui.coregistration¶

mne.gui.coregistration(tabbed=False, split=True, scene_width=None, inst=None, subject=None, subjects_dir=None, guess_mri_subject=None, scene_height=None, head_opacity=None, head_high_res=None, trans=None, verbose=None)[source]¶

Coregister an MRI with a subject’s head shape.

The recommended way to use the GUI is through bash with:

$ mne coreg

Parameters:

Parameters:	tabbed : bool Combine the data source panel and the coregistration panel into a single panel with tabs. split : bool Split the main panels with a movable splitter (good for QT4 but unnecessary for wx backend). scene_width : int \| None Specify a minimum width for the 3d scene (in pixels). Default is None, which uses `MNE_COREG_SCENE_WIDTH` config value (which defaults to 500). inst : None \| str Path to an instance file containing the digitizer data. Compatible for Raw, Epochs, and Evoked files. subject : None \| str Name of the mri subject. subjects_dir : None \| path Override the SUBJECTS_DIR environment variable (sys.environ[‘SUBJECTS_DIR’]) guess_mri_subject : bool When selecting a new head shape file, guess the subject’s name based on the filename and change the MRI subject accordingly (default True). scene_height : int \| None Specify a minimum height for the 3d scene (in pixels). Default is None, which uses `MNE_COREG_SCENE_WIDTH` config value (which defaults to 400). head_opacity : float \| None The opacity of the head surface in the range [0., 1.]. Default is None, which uses `MNE_COREG_HEAD_OPACITY` config value (which defaults to 1.). head_high_res : bool \| None Use a high resolution head surface. Default is None, which uses `MNE_COREG_HEAD_HIGH_RES` config value (which defaults to True). trans : str \| None The transform file to use. verbose : bool, str, int, or None If not None, override default verbose level (see `mne.verbose()` and Logging documentation for more).

tabbed : bool

Combine the data source panel and the coregistration panel into a single panel with tabs.

split : bool

Split the main panels with a movable splitter (good for QT4 but unnecessary for wx backend).

scene_width : int | None

Specify a minimum width for the 3d scene (in pixels). Default is None, which uses MNE_COREG_SCENE_WIDTH config value (which defaults to 500).

inst : None | str

Path to an instance file containing the digitizer data. Compatible for Raw, Epochs, and Evoked files.

subject : None | str

Name of the mri subject.

subjects_dir : None | path

Override the SUBJECTS_DIR environment variable (sys.environ[‘SUBJECTS_DIR’])

guess_mri_subject : bool

When selecting a new head shape file, guess the subject’s name based on the filename and change the MRI subject accordingly (default True).

scene_height : int | None

Specify a minimum height for the 3d scene (in pixels). Default is None, which uses MNE_COREG_SCENE_WIDTH config value (which defaults to 400).

head_opacity : float | None

The opacity of the head surface in the range [0., 1.]. Default is None, which uses MNE_COREG_HEAD_OPACITY config value (which defaults to 1.).

head_high_res : bool | None

Use a high resolution head surface. Default is None, which uses MNE_COREG_HEAD_HIGH_RES config value (which defaults to True).

trans : str | None

The transform file to use.

verbose : bool, str, int, or None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more).

Notes

Step by step instructions for the coregistrations can be accessed as slides, for subjects with structural MRI and for subjects for which no MRI is available.