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_localizer_button_task#

nilearn.datasets.fetch_localizer_button_task(data_dir=None, url=None, verbose=1, legacy_format=True)[source]#

Fetch left vs right button press contrast maps from the localizer.

Parameters:
data_dirpathlib.Path or str, 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, default=None

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

verboseint, default=1

Verbosity level (0 means no message).

legacy_formatbool, default=True

If set to True, the fetcher will return recarrays. Otherwise, it will return pandas dataframes.

Returns:
dataBunch

Dictionary-like object, the interest attributes are :

  • ‘cmaps’: string list, giving paths to nifti contrast maps

  • ‘tmap’: string, giving paths to nifti contrast maps

  • ‘anat’: string, giving paths to normalized anatomical image

Notes

This function is only a caller for the fetch_localizer_contrasts in order to simplify examples reading and understanding. The ‘left vs right button press’ contrast is used.