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

nilearn.datasets.load_nki(mesh='fsaverage5', mesh_type='pial', n_subjects=1, data_dir=None, url=None, resume=True, verbose=1)[source]

Load NKI enhanced surface data into a surface object.

Added in version 0.11.0.

Parameters:
meshstr, default=’fsaverage5’

Which mesh to fetch. Should be one of the following values:

  • "fsaverage3": the low-resolution fsaverage3 mesh (642 nodes)

  • "fsaverage4": the low-resolution fsaverage4 mesh (2562 nodes)

  • "fsaverage5": the low-resolution fsaverage5 mesh (10242 nodes)

  • "fsaverage6": the medium-resolution fsaverage6 mesh (40962 nodes)

  • "fsaverage7": same as “fsaverage”

  • "fsaverage": the high-resolution fsaverage mesh (163842 nodes)

Note

The high-resolution fsaverage will result in more computation time and memory usage

mesh_typestr, default=’pial’
Must be one of:

  • "pial"

  • "white_matter"

  • "inflated"

  • "sphere"

  • "flat"

n_subjectsint, default=1

The number of subjects to load from maximum of 102 subjects. By default, 1 subjects will be loaded. If None is given, all 102 subjects will be loaded.

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

resumebool, default=True

Whether to resume download of a partly-downloaded file.

verboseint, default=1

Verbosity level (0 means no message).

Returns:
list of SurfaceImage objects

One image per subject.

Examples using nilearn.datasets.load_nki

Seed-based connectivity on the surface

Seed-based connectivity on the surface

A short demo of the surface images & maskers

A short demo of the surface images & maskers