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_atlas_smith_2009#
- nilearn.datasets.fetch_atlas_smith_2009(data_dir=None, url=None, resume=True, verbose=1, mirror='origin', dimension=None, resting=True)[source]#
Download and load the Smith ICA and BrainMap Probabilistic atlas (2009).
- Parameters:
- data_dir
pathlib.Pathorstr, optional Path where data should be downloaded. By default, files are downloaded in home directory.
- url
str, default=None URL of file to download. Override download URL. Used for test only (or if you setup a mirror of the data).
- resume
bool, default=True Whether to resume download of a partly-downloaded file.
- verbose
int, default=1 Verbosity level (0 means no message).
- mirror
str, optional 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. Default=’origin’.
- dimension: :obj:`int`, optional
Number of dimensions in the dictionary. Valid resolutions available are {10, 20, 70}.
- resting: :obj:`bool`, optional
Either to fetch the resting-fMRI or BrainMap components Default=True.
- data_dir
- Returns:
- data
sklearn.utils.Bunch Dictionary-like object, contains:
‘rsn20’:
str, path to nifti file containing the 20-dimensional ICA, resting-fMRI components. The shape of the image is(91, 109, 91, 20).‘rsn10’:
str, path to nifti file containing the 10 well-matched maps from the 20 maps obtained as for ‘rsn20’, as shown in [1]. The shape of the image is(91, 109, 91, 10).‘bm20’:
str, path to nifti file containing the 20-dimensional ICA, BrainMap components. The shape of the image is(91, 109, 91, 20).‘bm10’:
str, path to nifti file containing the 10 well-matched maps from the 20 maps obtained as for ‘bm20’, as shown in [1]. The shape of the image is(91, 109, 91, 10).‘rsn70’:
str, path to nifti file containing the 70-dimensional ICA, resting-fMRI components. The shape of the image is(91, 109, 91, 70).‘bm70’:
str, path to nifti file containing the 70-dimensional ICA, BrainMap components. The shape of the image is(91, 109, 91, 70).‘description’:
str, description of the atlas.
- data
- Warns:
- DeprecationWarning
If a dimension input is provided, the current behavior (returning multiple maps) is deprecated. Starting in version 0.13, one map will be returned in a ‘maps’ dict key depending on the dimension and resting value.
Notes
For more information about this dataset’s structure: http://www.fmrib.ox.ac.uk/datasets/brainmap+rsns/
References
Examples using nilearn.datasets.fetch_atlas_smith_2009#
Regions Extraction of Default Mode Networks using Smith Atlas