Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

fetch_surf_fsaverage

nilearn.datasets.fetch_surf_fsaverage(mesh='fsaverage5', data_dir=None)[source]

Download a Freesurfer fsaverage surface.

For more information see the dataset description.

File names are subject to change and only attribute names are guaranteed to be stable across nilearn versions.

Changed in Nilearn 0.14.0: The data for fsaverage3 and fsaverage4 have been updated to have their vertices in the same order as fsaverage5-7. Old faulty local copies of fsaverage3 and fsaverage4 are corrected the first time they are loaded.

Parameters:
meshstr, default=’fsaverage5’

Which mesh to fetch. Should be one of the following values:

  • "fsaverage3": the low-resolution fsaverage3 mesh (642 nodes)

  • "fsaverage4": the low-resolution fsaverage4 mesh (2562 nodes)

  • "fsaverage5": the low-resolution fsaverage5 mesh (10242 nodes)

  • "fsaverage6": the medium-resolution fsaverage6 mesh (40962 nodes)

  • "fsaverage7": same as “fsaverage”

  • "fsaverage": the high-resolution fsaverage mesh (163842 nodes)

Note

The high-resolution fsaverage will result in more computation time and memory usage

data_dirpathlib.Path or str or None, optional

Path where data should be downloaded. By default, files are downloaded in a nilearn_data folder in the home directory of the user. See also nilearn.datasets.utils.get_data_dirs.

Returns:
datasklearn.utils.Bunch

Dictionary-like object, contains:

  • area_left: str. Full path to a Gifti file containing left hemisphere area data

  • area_right: str. Full path to a Gifti file containing right hemisphere area data

  • curv_left: str. Full path to a Gifti file containing left hemisphere curvature data

  • curv_right: str. Full path to a Gifti file containing right hemisphere curvature data

  • flat_left: str. Full path to a Gifti file containing left hemisphere flat surface mesh

  • flat_right: str. Full path to a Gifti file containing right hemisphere flat surface mesh

  • infl_left: str. Full path to a Gifti file containing left hemisphere inflated pial surface mesh

  • infl_right: str. Full path to a Gifti file containing right hemisphere inflated pial surface mesh

  • pial_left: str. Full path to a Gifti file containing left hemisphere pial surface mesh

  • pial_right: str. Full path to a Gifti file containing right hemisphere pial surface mesh

  • sphere_left: str. Full path to a Gifti file containing left hemisphere sphere surface mesh

  • sphere_right: str. Full path to a Gifti file containing right hemisphere sphere surface mesh

  • sulc_left: str. Full path to a Gifti file containing left hemisphere sulcal depth data

  • sulc_right: str. Full path to a Gifti file containing right hemisphere sulcal depth data

  • thick_left: str. Full path to a Gifti file containing left hemisphere cortical thickness data

  • thick_right: str. Full path to a Gifti file containing right hemisphere cortical thickness data

  • white_left: str. Full path to a Gifti file containing left hemisphere white surface mesh

  • white_right: str. Full path to a Gifti file containing right hemisphere white surface mesh

See also

nilearn.datasets.load_fsaverage
nilearn.datasets.load_fsaverage_data