plot_gaze_heatmap

Creates a heatmap showing the distribution of eye_x and eye_y coordinates
across the entire screen area. The heatmap shows where the participant
looked most frequently during the recording period.

Pupillometry offers a non-invasive window into the mind and has been used extensively as a psychophysiological readout of arousal signals linked with cognitive processes like attention, stress, and emotional states [Clewett et al. (2020) <doi:10.1038/s41467-020-17851-9>; Kret & Sjak-Shie (2018) <doi:10.3758/s13428-018-1075-y>; Strauch (2024) <doi:10.1016/j.tins.2024.06.002>]. Yet, despite decades of pupillometry research, many established packages and workflows to date lack design patterns based on Findability, Accessibility, Interoperability, and Reusability (FAIR) principles [see Wilkinson et al. (2016) <doi:10.1038/sdata.2016.18>]. 'eyeris' provides a modular, performant, and extensible preprocessing framework for pupillometry data with BIDS-like organization and interactive output reports [Esteban et al. (2019) <doi:10.1038/s41592-018-0235-4>; Gorgolewski et al. (2016) <doi:10.1038/sdata.2016.44>]. Development was supported, in part, by the Stanford Wu Tsai Human Performance Alliance, Stanford Ric Weiland Graduate Fellowship, Stanford Center for Mind, Brain, Computation and Technology, NIH National Institute on Aging Grants (R01-AG065255, R01-AG079345), NSF GRFP (DGE-2146755), McKnight Brain Research Foundation Clinical Translational Research Scholarship in Cognitive Aging and Age-Related Memory Loss, American Brain Foundation, and the American Academy of Neurology.

Shawn Schwartz

eyeris

Flexible, Extensible, & Reproducible Pupillometry Preprocessing

plot_gaze_heatmap function

<dl><dt>eyeris</dt>
<dd>An object of class <code>eyeris</code> derived from <code>load_asc()</code></dd>
<dt>block</dt>
<dd>Block number to plot (default: 1)</dd>
<dt>screen_width</dt>
<dd>Screen width in pixels from eyeris$info$screen.x</dd>
<dt>screen_height</dt>
<dd>Screen height in pixels from eyeris$info$screen.y</dd>
<dt>n_bins</dt>
<dd>Number of bins for the heatmap grid (default: 50)</dd>
<dt>col_palette</dt>
<dd>Color palette for the heatmap (default: "viridis")</dd>
<dt>main</dt>
<dd>Title for the plot (default: "Fixation Heatmap")</dd>
<dt>xlab</dt>
<dd>X-axis label (default: "Screen X (pixels)")</dd>
<dt>ylab</dt>
<dd>Y-axis label (default: "Screen Y (pixels)")</dd>
<dt>sample_rate</dt>
<dd>Sample rate in Hz (optional)</dd>
<dt>eye_suffix</dt>
<dd>Eye suffix for binocular data (default: NULL)</dd></dl>

Arguments

Create gaze heatmap of eye coordinates — plot_gaze_heatmap

<dl>

<dt>eyeris</dt>
<dd>An object of class <code>eyeris</code> derived from <code>load_asc()</code></dd>


<dt>block</dt>
<dd>Block number to plot (default: 1)</dd>


<dt>screen_width</dt>
<dd>Screen width in pixels from eyeris$info$screen.x</dd>


<dt>screen_height</dt>
<dd>Screen height in pixels from eyeris$info$screen.y</dd>


<dt>n_bins</dt>
<dd>Number of bins for the heatmap grid (default: 50)</dd>


<dt>col_palette</dt>
<dd>Color palette for the heatmap (default: "viridis")</dd>


<dt>main</dt>
<dd>Title for the plot (default: "Fixation Heatmap")</dd>


<dt>xlab</dt>
<dd>X-axis label (default: "Screen X (pixels)")</dd>


<dt>ylab</dt>
<dd>Y-axis label (default: "Screen Y (pixels)")</dd>


<dt>sample_rate</dt>
<dd>Sample rate in Hz (optional)</dd>


<dt>eye_suffix</dt>
<dd>Eye suffix for binocular data (default: NULL)</dd>

</dl>

plot_gaze_heatmap: Create gaze heatmap of eye coordinates

Description

Usage

Value

Arguments

Examples