Giving credit

Previous topic

7.2.14. nilearn.datasets.fetch_icbm152_2009

Next topic

7.2.16. nilearn.datasets.fetch_localizer_button_task


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.

7.2.15. nilearn.datasets.fetch_icbm152_brain_gm_mask

nilearn.datasets.fetch_icbm152_brain_gm_mask(data_dir=None, threshold=0.2, resume=True, verbose=1)

Downloads ICBM152 template first, then loads ‘gm’ mask image.

New in version 0.2.5.


data_dir: str, optional

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

threshold: float, optional

The parameter which amounts to include the values in the mask image. The values lies above than this threshold will be included. Defaults to 0.2 (one fifth) of values.

resume: bool, optional

If True, try resuming partially downloaded data. Defaults to True.

verbose: int, optional

verbosity level (0 means no message).


gm_mask_img: Nifti image

Corresponding to brain grey matter from ICBM152 template.

See also

for details regarding the ICBM152 template.
for details about version of MNI152 template and related.


This function relies on ICBM152 templates where we particularly pick grey matter template and threshold the template at .2 to take one fifth of the values. Then, do a bit post processing such as binary closing operation to more compact mask image.

Note: It is advised to check the mask image with your own data processing.