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 [1].

Parameters:
meshstr, optional

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

Default=’fsaverage5’.

data_dirpathlib.Path or str, optional

Path where data should be downloaded. By default, files are downloaded in home directory.

Returns:
datasklearn.datasets.base.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

  • ‘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

References

Examples using nilearn.datasets.fetch_surf_fsaverage#

Seed-based connectivity on the surface

Seed-based connectivity on the surface

Seed-based connectivity on the surface
Loading and plotting of a cortical surface atlas

Loading and plotting of a cortical surface atlas

Loading and plotting of a cortical surface atlas
Making a surface plot of a 3D statistical map

Making a surface plot of a 3D statistical map

Making a surface plot of a 3D statistical map
Cortical surface-based searchlight decoding

Cortical surface-based searchlight decoding

Cortical surface-based searchlight decoding
Example of surface-based first-level analysis

Example of surface-based first-level analysis

Example of surface-based first-level analysis
Surface-based dataset first and second level analysis of a dataset

Surface-based dataset first and second level analysis of a dataset

Surface-based dataset first and second level analysis of a dataset