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.21. nilearn.plotting.view_stat_map

nilearn.plotting.view_stat_map(stat_map_img, threshold=None, bg_img='MNI152', vmax=None, cmap='cold_hot', symmetric_cmap=True)

Insert a surface plot of a surface map into an HTML page.

Parameters:

stat_map_img : Niimg-like object

See http://nilearn.github.io/manipulating_images/input_output.html The statistical map image. Should be 3D or 4D with exactly one time point (i.e. stat_map_img.shape[-1] = 1)

threshold : str, number or None, optional (default=None)

If None, no thresholding. If it is a number only values of amplitude greater than threshold will be shown. If it is a string it must finish with a percent sign, e.g. “25.3%”, and only values of amplitude above the given percentile will be shown.

bg_img : Niimg-like object, optional (default=’MNI152’)

See http://nilearn.github.io/manipulating_images/input_output.html The background image that the stat map will be plotted on top of. If nothing is specified, the MNI152 template will be used.

vmax : float, optional (default=None)

Upper bound for plotting

cmap : str or matplotlib colormap, optional

symmetric_cmap : bool, optional (default=True)

Make colormap symmetric (ranging from -vmax to vmax). Set it to False if you are plotting an atlas or an anatomical image.

Returns:

StatMapView : plot of the stat map.

It can be saved as an html page or rendered (transparently) by the Jupyter notebook.

7.10.21.1. Examples using nilearn.plotting.view_stat_map