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.

nilearn.datasets.fetch_surf_fsaverage

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

Download a Freesurfer fsaverage surface.

File names are subject to change and only attribute names are guaranteed to be stable across nilearn versions. See Fischl et al.[1].

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, 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, the interest attributes are :

  • ‘area_left’: Gifti file, left hemisphere area data

  • ‘area_right’: Gifti file, right hemisphere area data

  • ‘curv_left’: Gifti file, left hemisphere curvature data

  • ‘curv_right’: Gifti file, right hemisphere curvature data

  • ‘flat_left’: Gifti file, left hemisphere flat surface mesh

  • ‘flat_right’: Gifti file, right hemisphere flat surface mesh

  • ‘pial_left’: Gifti file, left hemisphere pial surface mesh

  • ‘pial_right’: Gifti file, right hemisphere pial surface mesh

  • ‘infl_left’: Gifti file, left hemisphere inflated pial surface mesh

  • ‘infl_right’: Gifti file, right hemisphere inflated pial

    surface mesh

  • ‘sphere_left’: Gifti file, left hemisphere sphere surface mesh

  • ‘sphere_right’: Gifti file, right hemisphere sphere surface mesh

  • ‘sulc_left’: Gifti file, left hemisphere sulcal depth data

  • ‘sulc_right’: Gifti file, right hemisphere sulcal depth data

  • ‘thick_left’: Gifti file, left hemisphere cortical thickness data

  • ‘thick_right’: Gifti file, right hemisphere cortical thickness data

  • ‘white_left’: Gifti file, left hemisphere white surface mesh

  • ‘white_right’: Gifti file, right hemisphere* white surface mesh

See load_fsaverage and load_fsaverage_data to access fsaverage data as SurfaceImages.

References