mne.bem.make_scalp_surfaces#

mne.bem.make_scalp_surfaces(subject, subjects_dir=None, force=True, overwrite=False, no_decimate=False, *, threshold=20, mri='T1.mgz', verbose=None)[source]#

Create surfaces of the scalp and neck.

The scalp surfaces are required for using the MNE coregistration GUI, and allow for a visualization of the alignment between anatomy and channel locations.

Parameters:

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.

forcebool

Force creation of the surface even if it has some topological defects. Defaults to True. See Fixing BEM and head surfaces for ideas on how to fix problematic meshes.

overwritebool

If True (default False), overwrite the destination file if it exists.

no_decimatebool

Disable the “medium” and “sparse” decimations. In this case, only a “dense” surface will be generated. Defaults to False, i.e., create surfaces for all three types of decimations.

thresholdint

The threshold to use with the MRI in the call to mkheadsurf. The default is 20.

New in version 1.1.

mristr

The MRI to use. Should exist in $SUBJECTS_DIR/$SUBJECT/mri.

New in version 1.1.

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.