This documentation is for development version 0.18.dev0.

mne.get_head_surf

mne.get_head_surf(subject, source=('bem', 'head'), subjects_dir=None, verbose=None)[source]

Load the subject head surface.

Parameters:
subject : str

Subject name.

source : 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.

subjects_dir : str, or None

Path to the SUBJECTS_DIR. If None, the path is obtained by using the environment variable SUBJECTS_DIR.

verbose : bool, str, int, or None

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

Returns:
surf : dict

The head surface.