mne.viz.eyetracking.plot_gaze#
- mne.viz.eyetracking.plot_gaze(epochs, width, height, *, sigma=25, cmap=None, alpha=1.0, vlim=(None, None), axes=None, show=True)[source]#
Plot a heatmap of eyetracking gaze data.
- Parameters:
- epochsinstance of
Epochs The
Epochsobject containing eyegaze channels.- width
int The width dimension of the plot canvas. For example, if the eyegaze data units are pixels, and the participant screen resolution was 1920x1080, then the width should be 1920.
- height
int The height dimension of the plot canvas. For example, if the eyegaze data units are pixels, and the participant screen resolution was 1920x1080, then the height should be 1080.
- sigma
float|None The amount of Gaussian smoothing applied to the heatmap data (standard deviation in pixels). If
None, no smoothing is applied. Default is 25.- cmapmatplotlib colormap |
str|None The
Colormapto use. Defaults toNone, which will use the matplotlib default colormap.- alpha
float The opacity of the heatmap (default is 1).
- vlim
tupleof length 2 Colormap limits to use. If a
tupleof floats, specifies the lower and upper bounds of the colormap (in that order); providingNonefor either entry will set the corresponding boundary at the min/max of the data. Defaults to(None, None).- axesinstance of
Axes|None The axes to plot to. If
None, a newFigurewill be created. Default isNone.- showbool
Show the figure if
True.
- epochsinstance of
- Returns:
- figinstance of
Figure The resulting figure object for the heatmap plot.
- figinstance of
Notes
New in v1.6.
