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.
Usage
plot_gaze_heatmap(
eyeris,
block = 1,
screen_width = NULL,
screen_height = NULL,
n_bins = 50,
col_palette = "viridis",
main = "Gaze Heatmap",
xlab = "Screen X (pixels)",
ylab = "Screen Y (pixels)",
sample_rate = NULL,
eye_suffix = NULL
)Arguments
- eyeris
An object of class
eyerisderived fromload_asc()- block
Block number to plot (default: 1)
- screen_width
Screen width in pixels from
eyeris$info$screen.x- screen_height
Screen height in pixels from
eyeris$info$screen.y- n_bins
Number of bins for the heatmap grid (default: 50)
- col_palette
Color palette for the heatmap (default: "viridis")
- main
Title for the plot (default: "Fixation Heatmap")
- xlab
X-axis label (default: "Screen X (pixels)")
- ylab
Y-axis label (default: "Screen Y (pixels)")
- sample_rate
Sample rate in Hz (optional)
- eye_suffix
Eye suffix for binocular data (default: NULL)
Examples
demo_data <- eyelink_asc_demo_dataset()
eyeris_preproc <- glassbox(demo_data)
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::load_asc()
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::resample()
#> ℹ [2026-07-19 07:18:25] [INFO] Processing block: block_1
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::deblink() for block_1
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::detransient() for block_1
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::interpolate() for block_1
#> ! [2026-07-19 07:18:25] [WARN] Interpolation now leaves gaps longer than 250 ms
#> as `NA` instead of interpolating across them (following Kret & Sjak-Shie,
#> 2018). This is a change in default behavior from eyeris <= 3.2.0 and may affect
#> your results. To restore the previous behavior, set `interpolate =
#> list(max_gap_ms = Inf)` in `glassbox()` (or `max_gap_ms = Inf` in
#> `interpolate()`).
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::lpfilt() for block_1
#> ! [2026-07-19 07:18:25] [WARN] Skipping eyeris::downsample() for block_1
#> ! [2026-07-19 07:18:25] [WARN] Skipping eyeris::bin() for block_1
#> ! [2026-07-19 07:18:25] [WARN] Skipping eyeris::detrend() for block_1
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::zscore() for block_1
#> ℹ [2026-07-19 07:18:25] [INFO] Block processing summary:
#> ℹ [2026-07-19 07:18:25] [INFO] block_1: OK (steps: 6, latest:
#> pupil_raw_deblink_detransient_interpolate_lpfilt_z)
#> ✔ [2026-07-19 07:18:25] [OKAY] Running eyeris::summarize_confounds()
plot_gaze_heatmap(eyeris = eyeris_preproc, block = 1)
