mne.bem.make_scalp_surfaces

mne.bem.make_scalp_surfaces(subject, subjects_dir=None, force=True, overwrite=False, no_decimate=False, 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_dirstr | pathlib.Path | None

The path to 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.

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.

verbosebool | str | int | None

If not None, override default verbose level (see mne.verbose() and Logging documentation for more). If used, it should be passed as a keyword-argument only.