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.

7.10.2. nilearn.plotting.find_xyz_cut_coords

nilearn.plotting.find_xyz_cut_coords(img, mask_img=None, activation_threshold=None)

Find the center of the largest activation connected component.

Parameters
img3D Nifti1Image

The brain map.

mask_img3D Nifti1Image, optional

An optional brain mask, provided mask_img should not be empty.

activation_thresholdfloat, optional

The lower threshold to the positive activation. If None, the activation threshold is computed using the 80% percentile of the absolute value of the map.

Returns
xfloat

the x world coordinate.

yfloat

the y world coordinate.

zfloat

the z world coordinate.