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_atlas_yeo_2011

nilearn.datasets.fetch_atlas_yeo_2011(data_dir=None, url=None, resume=True, verbose=1, n_networks=7, thickness='thick')[source]

Download and return file names for the Yeo 2011 parcellation.

For more information see the dataset description.

Parameters:
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.

urlstr or None, default=None

URL of file to download. Override download URL. Used for test only (or if you setup a mirror of the data).

resumebool, default=True

Whether to resume download of a partly-downloaded file.

verbosebool or int, default=1

Verbosity level (0 or False means no message).

n_networks{7, 17}, default = 7

Specify the version of the atlas that is returned:

  • 7 networks parcellation,

  • 17 networks parcellation.

Added in Nilearn 0.12.0.

Changed in Nilearn 0.13.0: The default was changed to 7.

thickness{“thin”, “thick”}, default = “thick”

Specific the version of the atlas that is returned:

  • "thick": parcellation fitted to thick cortex segmentations,

  • "thin": parcellation fitted to thin cortex segmentations.

Added in Nilearn 0.12.0.

Changed in Nilearn 0.13.0: The default was changed to “thick”.

Returns:
datasklearn.utils.Bunch

Dictionary-like object, contains:

  • anat: str. Full path to the 3D nifti file containing the anatomy image for reference and visualization.

  • atlas_type: str. Type of atlas. See Probabilistic atlas and Deterministic atlas.

  • labels: list of str. List of the names of the regions.

  • lut: pandas.DataFrame. Act as a look up table (lut) with at least columns ‘index’ and ‘name’. Formatted according to ‘dseg.tsv’ format from BIDS.

  • maps: str. Full path to 3D nifti image containing integer values for each network. The provided images are in MNI152 space and have shapes equal to (256, 256, 256, 1). They contain consecutive integers values from 0 (background) to either 7 or 17 depending on the atlas version considered.

  • template: str. The standardized space of analysis in which the data is provided.

Notes

If the dataset files are already present in the user’s Nilearn data directory, this fetcher will not re-download them. To force a fresh download, you can remove the existing dataset folder from your local Nilearn data directory.

For more details on how Nilearn stores datasets.

Examples using nilearn.datasets.fetch_atlas_yeo_2011

Basic Atlas plotting

Basic Atlas plotting

Comparing connectomes on different reference atlases

Comparing connectomes on different reference atlases

Breaking an atlas of labels in separated regions

Breaking an atlas of labels in separated regions