ep.eye_unify_gaze_events: Unify gaze events with raw data

In PennStateDEPENdLab/experiment.pipeline: Generates data markdown for NeuroMap Task

Unify gaze events with raw data

Description

When loaded into the environment, an .edf file will be parsed with fields corresponding to $raw, $sacc, $fix, and $blink. Saccades, fixations, and blinks are called "gaze events" in the ep.eye nomenclature and denote the presence of an event of significance within gaze data. This function unifies raw data with gaze events by generating unique gaze event numbers, merges them to raw data and validates that timestamps from raw and gaze event fields are in correspondence.

Usage

ep.eye_unify_gaze_events(
  ep.eye,
  gaze_events = c("sacc", "fix", "blink"),
  confirm_correspondence = FALSE
)

Arguments

ep.eye	An initialized ep.eye object
gaze_events	Character vector of gaze_events to unify with raw. Defaults to unifying sacc, fix, and blink but can be set to any subset of these.

Value

ep.eye ep.eye structure that has been tagged with gaze event numbers and validated for correspondence between raw and gaze event fields.

Author(s)

Nate Hall

PennStateDEPENdLab/experiment.pipeline documentation built on April 14, 2024, 9:37 p.m.