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.

8.10.15. nilearn.plotting.plot_prob_atlas

nilearn.plotting.plot_prob_atlas(maps_img, bg_img=<MNI152Template>, view_type='auto', threshold='auto', linewidths=2.5, cut_coords=None, output_file=None, display_mode='ortho', figure=None, axes=None, title=None, annotate=True, draw_cross=True, black_bg='auto', dim='auto', colorbar=False, cmap=<matplotlib.colors.LinearSegmentedColormap object>, vmin=None, vmax=None, alpha=0.7, **kwargs)[source]

Plot the probabilistic atlases onto the anatomical image by default MNI template

Parameters
maps_imgNiimg-like object or the filename

4D image of the probabilistic atlas maps.

bg_imgNiimg-like object, optional

See http://nilearn.github.io/manipulating_images/input_output.html The anatomical image to be used as a background. If nothing is specified, the MNI152 template will be used. To turn off background image, just pass “bg_img=False”. Default=MNI152TEMPLATE.

New in version 0.4.0.

view_type{‘auto’, ‘contours’, ‘filled_contours’, ‘continuous’}, optional

By default view_type == ‘auto’, means maps will be displayed automatically using any one of the three view types. The automatic selection of view type depends on the total number of maps. If view_type == ‘contours’, maps are overlayed as contours If view_type == ‘filled_contours’, maps are overlayed as contours along with color fillings inside the contours. If view_type == ‘continuous’, maps are overlayed as continous colors irrespective of the number maps. Default=’auto’.

thresholda str or a number, list of str or numbers, optional

This parameter is optional and is used to threshold the maps image using the given value or automatically selected value. The values in the image above the threshold level will be visualized. The default strategy, computes a threshold level that seeks to minimize (yet not eliminate completely) the overlap between several maps for a better visualization. The threshold can also be expressed as a percentile over the values of the whole atlas. In that case, the value must be specified as string finishing with a percent sign, e.g., “25.3%”. If a single string is provided, the same percentile will be applied over the whole atlas. Otherwise, if a list of percentiles is provided, each 3D map is thresholded with certain percentile sequentially. Length of percentiles given should match the number of 3D map in time (4th) dimension. If a number or a list of numbers, the given value will be used directly to threshold the maps without any percentile calculation. If None, a very small threshold is applied to remove numerical noise from the maps background.

linewidthsfloat, optional

This option can be used to set the boundary thickness of the contours. Default=2.5.

cut_coordsNone, a tuple of floats, or an integer, optional

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. If display_mode is ‘mosaic’, and the number of cuts is the same for all directions, cut_coords can be specified as an integer. It can also be a length 3 tuple specifying the number of cuts for every direction if these are different.

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’, ‘mosaic’, ‘x’, ‘y’, ‘z’, ‘yx’, ‘xz’, ‘yz’}, optional

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, ‘mosaic’ - three cuts are performed along multiple rows and columns, Default=’ortho’.

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. Default=True.

draw_crossboolean, optional

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

black_bgboolean or ‘auto’, 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 pylab’s savefig. Default=’auto’.

dimfloat or ‘auto’, optional

Dimming factor applied to background image. By default, automatic heuristics are applied based upon the background 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. Default=’auto’.

cmapmatplotlib colormap, optional

The colormap for the atlas maps. Default=plt.cm.gist_rainbow.

colorbarboolean, optional

If True, display a colorbar on the right of the plots. Default=False.

vminfloat, optional

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

vmaxfloat, optional

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

alphafloat between 0 and 1, optional

Alpha sets the transparency of the color inside the filled contours. Default=0.7.

See also

nilearn.plotting.plot_roi

To simply plot max-prob atlases (3D images)