Load the subject head surface.
str
Subject name.
str
| list
of str
Type to load. Common choices would be 'bem'
or 'head'
. We first
try loading '$SUBJECTS_DIR/$SUBJECT/bem/$SUBJECT-$SOURCE.fif'
, and
then look for '$SUBJECT*$SOURCE.fif'
in the same directory by going
through all files matching the pattern. The head surface will be read
from the first file containing a head surface. Can also be a list
to try multiple strings.
str
, or None
Path to the SUBJECTS_DIR. If None, the path is obtained by using the environment variable SUBJECTS_DIR.
What to do if the surface is found to have topological defects.
Can be 'raise'
(default) to raise an error, 'warn'
to emit a
warning, or 'ignore'
to ignore when one or more defects are found.
Note that a lot of computations in MNE-Python assume the surfaces to be
topologically correct, topological defects may still make other
computations (e.g., mne.make_bem_model
and mne.make_bem_solution
)
fail irrespective of this parameter.
New in version 1.0.
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.
dict
The head surface.