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.

8.2.26. 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. Default=’fsaverage5’.

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

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

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

  • ‘fsaverage5_sphere’: this option has been deprecated

    and will be removed in v0.9.0. fsaverage5 sphere coordinates can now be accessed through attributes sphere_{left, right} using mesh=’fsaverage5’

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

  • ‘fsaverage7’: same as ‘fsaverage’

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

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

data_dirstr, optional

Path of the data directory. Used to force data storage in a specified location.

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

1

Bruce Fischl, Martin I. Sereno, Roger B.H. Tootell, and Anders M. Dale. High-resolution intersubject averaging and a coordinate system for the cortical surface. Human Brain Mapping, 8(4):272–284, 1999. URL: https://onlinelibrary.wiley.com/doi/abs/10.1002/%28SICI%291097-0193%281999%298%3A4%3C272%3A%3AAID-HBM10%3E3.0.CO%3B2-4, arXiv:https://onlinelibrary.wiley.com/doi/pdf/10.1002/%28SICI%291097-0193%281999%298%3A4%3C272%3A%3AAID-HBM10%3E3.0.CO%3B2-4, doi:https://doi.org/10.1002/(SICI)1097-0193(1999)8:4<272::AID-HBM10>3.0.CO;2-4.