mne_gui_addons.locate_ieeg(info, trans, base_image, subject=None, subjects_dir=None, groups=None, targets=None, show=True, block=False, verbose=None)#

Locate intracranial electrode contacts.


The mne.Info object with information about the sensors and methods of measurement.

transstr | dict | instance of Transform

If str, the path to the head<->MRI transform *-trans.fif file produced during coregistration. Can also be 'fsaverage' to use the built-in fsaverage transformation.

base_imagepath-like | nibabel.spatialimages.SpatialImage

The CT or MR image on which the electrode contacts can located. It must be aligned to the Freesurfer T1 if subject and subjects_dir are provided. Path-like inputs and nibabel image objects are supported.


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.

groupsdict | None

A dictionary with channels as keys and their group index as values. If None, the groups will be inferred by the channel names. Channel names must have a format like LAMY 7 where a string prefix like LAMY precedes a numeric index like 7. If the channels are formatted improperly, group plotting will work incorrectly. Group assignments can be adjusted in the GUI.

targetsdict | None

An optional dictionary with group (electrode/grid) names as keys and a list containing 1) the planned target location for the first electrode contact and 2) the next contact or planned entry point (for sEEG). Including only the target location is also an option. If not provided, automatic contact locations will not be found.


Show the GUI if True.


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.

guiinstance of IntracranialElectrodeLocator

The graphical user interface (GUI) window.

Examples using mne_gui_addons.locate_ieeg#

Locating micro-scale intracranial electrode contacts

Locating micro-scale intracranial electrode contacts

Locating intracranial electrode contacts

Locating intracranial electrode contacts