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_pauli_2017

nilearn.datasets.fetch_atlas_pauli_2017(atlas_type='probabilistic', data_dir=None, verbose=1)[source]

Download the Pauli et al. (2017) atlas.

This atlas has 12 subcortical nodes in total. See Pauli et al. (2017) atlas[1] and Pauli et al.[2].

Parameters:
atlas_type{‘probabilistic’, ‘deterministic’}, default=’probabilistic’

Which type of the atlas should be download. This can be ‘probabilistic’ for the Probabilistic atlas, or ‘deterministic’ for the Deterministic atlas.

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.

verboseint, default=1

Verbosity level (0 means no message).

Returns:
datasklearn.utils.Bunch

Dictionary-like object, contains:

  • ‘maps’: str,

    path to nifti file containing the Nifti1Image. If atlas_type='probabilistic', the image shape is (193, 229, 193, 16). If atlas_type='deterministic' the image shape is (198, 263, 212), and values are indices in the list of labels (integers from 0 to 16).

  • ‘labels’list of str

    List of the names of the regions. The list contains values for both probabilitic and deterministic types.

  • ‘description’str

    Description of the dataset.

  • lutpandas.DataFrame

    Act as a look up table (lut) with at least columns ‘index’ and ‘name’. Formatted according to ‘dseg.tsv’ format from BIDS. Only when atlas_type=”deterministic”

  • ‘template’str

    The standardized space of analysis in which the atlas results are provided. When known it should be a valid template name taken from the spaces described in the BIDS specification.

  • ‘atlas_type’str

    Type of atlas. See Probabilistic atlas and Deterministic atlas.

References