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.

8.13.1. nilearn.reporting.get_clusters_table

nilearn.reporting.get_clusters_table(stat_img, stat_threshold, cluster_threshold=None, two_sided=False, min_distance=8.0)[source]

Creates pandas dataframe with img cluster statistics.

stat_imgNiimg-like object,

Statistical image (presumably in z- or p-scale).


Cluster forming threshold in same scale as stat_img (either a p-value or z-scale value).

cluster_thresholdint or None, optional

Cluster size threshold, in voxels.

two_sidedbool, optional

Whether to employ two-sided thresholding or to evaluate positive values only. Default=False.

min_distancefloat, optional

Minimum distance between subpeaks in mm. Default=8mm.


Table with peaks and subpeaks from thresholded stat_img. For binary clusters (clusters with >1 voxel containing only one value), the table reports the center of mass of the cluster, rather than any peaks/subpeaks.