mne.viz.eyetracking.plot_gaze#

mne.viz.eyetracking.plot_gaze(epochs, *, calibration=None, width=None, height=None, 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 Epochs object containing eyegaze channels.

calibrationinstance of Calibration | None

An instance of Calibration with information about the screen size, distance, and resolution. If None, you must provide a width and height.

widthint

The width dimension of the plot canvas, only valid if eyegaze data are in pixels. For example, if the participant screen resolution was 1920x1080, then the width should be 1920.

heightint

The height dimension of the plot canvas, only valid if eyegaze data are in pixels. For example, if the participant screen resolution was 1920x1080, then the height should be 1080.

sigmafloat | 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 Colormap to use. Defaults to None, which will use the matplotlib default colormap.

alphafloat

The opacity of the heatmap (default is 1).

vlimtuple of length 2

Colormap limits to use. If a tuple of floats, specifies the lower and upper bounds of the colormap (in that order); providing None for 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 new Figure will be created. Default is None.

showbool

Show the figure if True.

Returns:
figinstance of Figure

The resulting figure object for the heatmap plot.

Notes

New in v1.6.

Examples using mne.viz.eyetracking.plot_gaze#

Working with eye tracker data in MNE-Python

Working with eye tracker data in MNE-Python

Plotting eye-tracking heatmaps in MNE-Python

Plotting eye-tracking heatmaps in MNE-Python