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_smith_2009

nilearn.datasets.fetch_atlas_smith_2009(data_dir=None, url=None, resume=True, verbose=1, mirror='origin', dimension=10, resting=True)[source]

Download and load the Smith ICA and BrainMap Probabilistic atlas (2009).

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).

mirrorstr, default=’origin’

By default, the dataset is downloaded from the original website of the atlas. Specifying “nitrc” will force download from a mirror, with potentially higher bandwidth.

dimensionint, default=10

Number of dimensions in the dictionary. Valid dimension available are {10, 20, 70}.

restingbool, default=True

Either to fetch the resting-fMRI or BrainMap components

Returns:
datasklearn.utils.Bunch

Dictionary-like object, contains:

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

  • maps: str. Full path to 4D nifti file containing the requested resting fMRI or BrainMap components (depending on the value passed to resting) image with the number of requested dimensions. The shape of the image is (91, 109, 91, dimension) where dimension is the value passed to dimension.

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

3D and 4D niimgs: handling and visualizing

3D and 4D niimgs: handling and visualizing

Visualizing 4D probabilistic atlas maps

Visualizing 4D probabilistic atlas maps

Regions Extraction of Default Mode Networks

Regions Extraction of Default Mode Networks