nilearn.experimental: Experimental Modules

The nilearn.experimental module provides importable modules that enable the use of experimental features.

Warning

All features in the nilearn.experimental module are experimental and subject to change.

They are included in the nilearn package to gather early feedback from users about prototypes of new features. Changes may break backwards compatibility without prior notice or a deprecation cycle. Moreover, some features may be incomplete or may have been tested less thoroughly than the rest of the library.

Use those features at your own risks!

nilearn.experimental.plotting

Functions

plot_surf(surf_map[, surf_mesh, bg_map, hemi])	Plot surfaces with optional background and data.
plot_surf_contours(roi_map[, hemi, surf_mesh])	Plot contours of ROIs on a surface, optionally on a statistical map.
plot_surf_roi(roi_map[, surf_mesh, bg_map, hemi])	Plot ROI on a surface mesh with optional background.
plot_surf_stat_map(stat_map[, surf_mesh, ...])	Plot a stats map on a surface mesh with optional background.
view_surf(surf_mesh[, surf_map, bg_map, hemi])	Insert a surface plot of a surface map into an HTML page.

nilearn.experimental.surface

The nilearn.experimental.surface module.

Classes

SurfaceLabelsMasker(labels_img[, ...])

Extract data from a SurfaceImage, averaging over atlas regions.

Functions

fetch_nki([mesh_type])	Load NKI enhanced surface data into a surface object.
load_fsaverage([mesh_name])	Load fsaverage for both hemispheres.
load_fsaverage_data([mesh_name, mesh_type, ...])	Return freesurfer data on an fsaverage mesh.