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.plotting.find_xyz_cut_coords

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

Find the center of the largest activation connected component.

Parameters:

img : 3D Nifti1Image

The brain map.

mask : 3D ndarray, boolean, optional

An optional brain mask.

activation_threshold : float, 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:

x : float

the x world coordinate.

y : float

the y world coordinate.

z : float

the z world coordinate.