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.5.21. nilearn.image.threshold_img

nilearn.image.threshold_img(img, threshold, cluster_threshold=0, two_sided=True, mask_img=None, copy=True)[source]

Threshold the given input image, mostly statistical or atlas images.

Thresholding can be done based on direct image intensities or selection threshold with given percentile.

Changed in version 0.8.2: New cluster_threshold and two_sided parameters added.

New in version 0.2.

imga 3D/4D Niimg-like object

Image containing statistical or atlas maps which should be thresholded.

thresholdfloat or str

If float, we threshold the image based on image intensities meaning voxels which have intensities greater than this value will be kept. The given value should be within the range of minimum and maximum intensity of the input image. If string, it should finish with percent sign e.g. “80%” and we threshold based on the score obtained using this percentile on the image data. The voxels which have intensities greater than this score will be kept. The given string should be within the range of “0%” to “100%”.

cluster_thresholdfloat, optional

Cluster size threshold, in voxels. In the returned thresholded map, sets of connected voxels (clusters) with size smaller than this number will be removed. Default=0.

New in version 0.8.2.

two_sidedbool, optional

Whether the thresholding should yield both positive and negative part of the maps. Default=True.

New in version 0.8.2.

mask_imgNiimg-like object, default None, optional

Mask image applied to mask the input data. If None, no masking will be applied.

copybool, optional

If True, input array is not modified. True by default: the filtering is not performed in-place. Default=True.


Thresholded image of the given input image.

See also


Threshold a statistical image using the alpha value, optionally with false positive control.