mne.datasets.fetch_fsaverage#

mne.datasets.fetch_fsaverage(subjects_dir=None, *, verbose=None)[source]#

Fetch and update fsaverage.

Parameters:
subjects_dirstr | None

The path to use as the subjects directory in the MNE-Python config file. None will use the existing config variable (i.e., will not change anything), and if it does not exist, will use ~/mne_data/MNE-fsaverage-data.

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.

Returns:
fs_dirpathlib.Path

The fsaverage directory. (essentially subjects_dir / 'fsaverage').

Changed in version 1.8: A pathlib.Path object is returned instead of a string.

Notes

This function is designed to provide

  1. All modern (Freesurfer 6) fsaverage subject files

  2. All MNE fsaverage parcellations

  3. fsaverage head surface, fiducials, head<->MRI trans, 1- and 3-layer BEMs (and surfaces)

This function will compare the contents of subjects_dir/fsaverage to the ones provided in the remote zip file. If any are missing, the zip file is downloaded and files are updated. No files will be overwritten.

New in v0.18.

On this page