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.5. nilearn.plotting.plot_anat

nilearn.plotting.plot_anat(anat_img=<MNI152Template>, cut_coords=None, output_file=None, display_mode='ortho', figure=None, axes=None, title=None, annotate=True, threshold=None, draw_cross=True, black_bg='auto', dim='auto', cmap=<matplotlib.colors.LinearSegmentedColormap object at 0x7f676cc74350>, vmin=None, vmax=None, **kwargs)

Plot cuts of an anatomical image (by default 3 cuts: Frontal, Axial, and Lateral)

Parameters
anat_imgNiimg-like object

See http://nilearn.github.io/manipulating_images/input_output.html The anatomical image to be used as a background. If None is given, nilearn tries to find a T1 template.

cut_coordsNone, a tuple of floats, or an integer

The MNI coordinates of the point where the cut is performed If display_mode is ‘ortho’ or ‘tiled’, this should be a 3-tuple: (x, y, z) For display_mode == ‘x’, ‘y’, or ‘z’, then these are the coordinates of each cut in the corresponding direction. If None is given, the cuts is calculated automaticaly. If display_mode is ‘x’, ‘y’ or ‘z’, cut_coords can be an integer, in which case it specifies the number of cuts to perform

output_filestring, or None, optional

The name of an image file to export the plot to. Valid extensions are .png, .pdf, .svg. If output_file is not None, the plot is saved to a file, and the display is closed.

display_mode{‘ortho’, ‘tiled’, ‘x’, ‘y’, ‘z’, ‘yx’, ‘xz’, ‘yz’}

Choose the direction of the cuts: ‘x’ - sagittal, ‘y’ - coronal, ‘z’ - axial, ‘ortho’ - three cuts are performed in orthogonal directions, ‘tiled’ - three cuts are performed and arranged in a 2x2 grid.

figureinteger or matplotlib figure, optional

Matplotlib figure used or its number. If None is given, a new figure is created.

axesmatplotlib axes or 4 tuple of float: (xmin, ymin, width, height), optional

The axes, or the coordinates, in matplotlib figure space, of the axes used to display the plot. If None, the complete figure is used.

titlestring, optional

The title displayed on the figure.

annotateboolean, optional

If annotate is True, positions and left/right annotation are added to the plot.

thresholda number, None, or ‘auto’, optional

If None is given, the image is not thresholded. If a number is given, it is used to threshold the image: values below the threshold (in absolute value) are plotted as transparent. If auto is given, the threshold is determined magically by analysis of the image.

draw_crossboolean, optional

If draw_cross is True, a cross is drawn on the plot to indicate the cut plosition.

black_bgboolean, optional

If True, the background of the image is set to be black. If you wish to save figures with a black background, you will need to pass “facecolor=’k’, edgecolor=’k’” to matplotlib.pyplot.savefig.

dimfloat, ‘auto’ (by default), optional

Dimming factor applied to background image. By default, automatic heuristics are applied based upon the image intensity. Accepted float values, where a typical span is between -2 and 2 (-2 = increase contrast; 2 = decrease contrast), but larger values can be used for a more pronounced effect. 0 means no dimming.

cmapmatplotlib colormap, optional

The colormap for the anat

vminfloat

Lower bound for plotting, passed to matplotlib.pyplot.imshow

vmaxfloat

Upper bound for plotting, passed to matplotlib.pyplot.imshow

Notes

Arrays should be passed in numpy convention: (x, y, z) ordered.

For visualization, non-finite values found in passed ‘anat_img’ are set to zero.