eyelinkRecording-class: Class 'eyelinkRecording'.

In eyelinkReader: Import Gaze Data for EyeLink Eye Tracker

Class eyelinkRecording.

Description

S3 class containing information imported from an edf-file.

Details

See methods(class = "eyelinkRecording") for an overview of available methods.

Slots

preamble

A preamble of the recording, see also read_preamble.

events

Events table which is a collection of all FEVENT imported from the EDF file. See description below.

samples

Samples table which is a collection of all FSAMPLE imported from the EDF file. See description below.

headers

Headers of the individual trials, see description below.

recordings

Individual recording start/end information, see description below.

display_coords

Recorded screen coordinates (if recorded), see extract_display_coords.

saccades

Saccades extracted from events, see description below and extract_saccades.

fixations

Fixations extracted from events, see description below and extract_fixations.

blinks

Blinks extracted from events, see description below and extract_blinks.

variables

Recorded variables extracted from events, see description below and extract_variables.

triggers

Events messages that adhere to a TRIGGER <label> format. This is a non-standard message that the package author uses to mark events like onsets or offsets, similar to how it is done in M/EEG. See description below and extract_triggers.

AOIs

Areas of interest events. See description below and extract_AOIs.

Events

Events table which is a collection of all FEVENT imported from the EDF file. Column descriptions were copied directly from the EDF access C API manual. Please refer to that manual for further details. Additional non-standard fields are marked in bold.

• trial Trial index, starts at 1.

• time Time of event.

• type Event type.

• read Flags which items were included.

• sttime Start time of the event.

• entime End time of the event.

• sttime_rel Start time of the event, relative to the start time of the trial.

• entime_rel End time of the event, relative to the start time of the trial.

• hstx, hsty Head reference starting points.

• gstx, gsty Gaze starting points.

• sta Pupil size at start.

• henx, heny Headref ending points.

• genx, geny Gaze ending points.

• ena Pupil size at end.

• havx, havy Headref averages.

• gavx, gavy Gaze averages.

• ava Average pupil size.

• avel Accumulated average velocity.

• pvel Accumulated peak velocity.

• svel Start velocity.

• evel End velocity.

• supd_x, supd_y Start units-per-degree.

• eupd_x, eupd_y End units-per-degree.

• eye Either 'LEFT' (0) or 'RIGHT' (1).

• status Error, warning flags.

• flags Flags to indicate contents.

• input Extra (input word).

• buttons Button state and changes.

• parsedby 7 bits of flags, PARSEDBY codes.

• message Any message string.

Samples

Samples table which is a collection of all FSAMPLE imported from the EDF file. Please note that read_edf parameters determines which fields are imported. Column descriptions were copied directly from the EDF access C API manual. Please refer to that manual for further details. Suffixes L and R denote left and right eye. Non-standard additional fields are marked in bold.

• trial Trial index, starts at 1.

• eye 'LEFT' (0), 'RIGHT' (1), or 'BINOCULAR' (2).

• time Time of sample.

• time_rel Time relative to the start of the trial.

• pxL, pxR, pyL, pyR Pupil coordinates.

• hxL, hxR, hyL, hyR Headref coordinates.

• paL, paR Pupil size or area.

• gxL, gxR, gyL, gyR Screen gaze coordinates.

• rx, ry Screen pixels per degree.

• gxvelL, gxvelR, gyvelL, gyvelR Gaze velocity.

• hxvelL, hxvelR, hyvelL, hyvelR Headref velocity.

• rxvelL, rxvelR, ryvelL, ryvelR Raw velocity.

• fgxvelL, fgxvelR, fgyvelL, fgyvelR Fast gaze velocity.

• fhxvelL, fhxvelR, fhyvelL, fhyvelR Fast headref velocity.

• frxvelL, frxvelR, fryvelL, fryvelR Fast raw velocity.

• hdata_1 -hdata_8 Head-tracker data (not pre-scaled). Each column correspond to a single element of the INT16 FSAMPLE::hdata[8].

• flags Flags to indicate contents.

• input Extra (input word).

• buttons Button state & changes.

• htype Head-tracker data type (0=none).

• errors Process error flags.

Headers

Trial headers table which is a collection of all TRIAL structures imported from the EDF file. Column descriptions were copied directly from the EDF access C API manual. Please refer to that manual for further details. All fields of the RECORDINGS structure are prefixed with rec_. Non-standard additional fields are marked in bold.

• trial Trial index.

• duration Duration of the trial.

• starttime Start time of the trial.

• endtime End time of the trial.

• rec_time Start time or end time.

• rec_sample rate Sample rate in Hz: 250, 500, 1000 or 2000.

• rec_eflags Extra information about events.

• rec_sflags Extra information about samples.

• rec_state 'START' (2) or 'END' (1).

• rec_record_type 'SAMPLES' (1), 'EVENTS' (2), or 'SAMPLES and EVENTS' (3).

• rec_pupil_type 'AREA' (0) or 'DIAMETER' (1).

• rec_recording_mode 'PUPIL' (0) or 'CR' (1).

• rec_filter_type 1, 2, or 3.

• rec_pos_type Should be 'GAZE' (0), 'HREF' (1) or 'RAW', but currently this column is kept as numeric, since observed values do not match the declared constants.

• rec_eye 'LEFT' (1), 'RIGHT' (2) or 'LEFT and RIGHT' (3).

Recordings

Recordings table which is a collection of all RECORDING structures imported from the EDF file. Column descriptions were copied directly from the EDF access C API manual. Please refer to that manual for further details. Non-standard additional fields are marked in bold.

• trial Trial index.

• time Start time or end time.

• sample rate Sample rate in Hz: 250, 500, 1000 or 2000.

• eflags Extra information about events.

• sflags Extra information about samples.

• state 'START' (2) or 'END' (1).

• record_type 'SAMPLES' (1), 'EVENTS' (2), or 'SAMPLES and EVENTS' (3).

• pupil_type 'AREA' (0) or 'DIAMETER' (1).

• recording_mode 'PUPIL' (0) or 'CR' (1).

• filter_type 1, 2, or 3.

• pos_type Should be 'GAZE' (0), 'HREF' (1) or 'RAW', but currently this column is kept as numeric, since observed values do not match the declared constants.

• eye 'LEFT' (1), 'RIGHT' (2) or 'LEFT and RIGHT' (3).

Saccades and Fixations

Saccades and fixations extracted from the events, tables have the same structure. Column descriptions were copied directly from the EDF access C API manual. Please refer to that manual for further details. Non-standard additional fields are marked in bold.

• trial Trial index.

• sttime Start time.

• entime End time.

• sttime_rel Start time, relative to the start time of the trial.

• entime_rel End time, relative to the start time of the trial.

• duration Duration.

• hstx, hsty Head reference starting points.

• gstx, gsty Gaze starting points.

• sta Pupil size at start.

• henx, heny Headref ending points.

• genx, geny Gaze ending points.

• ena Pupil size at end.

• havx, havy Headref averages.

• gavx, gavy Gaze averages.

• ava Average pupil size.

• avel Accumulated average velocity.

• pvel Accumulated peak velocity.

• svel Start velocity.

• evel End velocity.

• supd_x, supd_y Start units-per-degree.

• eupd_x, eupd_y End units-per-degree.

• eye Either 'LEFT' (1) or 'RIGHT' (2).

Blinks

Blinks extracted from the events table. Column descriptions were copied directly from the EDF access C API manual. Please refer to that manual for further details. Non-standard additional fields are marked in bold.

• trial Trial index.

• sttime Start time.

• entime End time.

• sttime_rel Start time, relative to the start time of the trial.

• entime_rel End time, relative to the start time of the trial.

• duration Duration.

• eye Either 'LEFT' (1) or 'RIGHT' (2).

Variables

User recorded variables extracted from message events with a 'TRIAL_VAR' prefix. Original format can be either 'TRIAL_VAR <name> <value>' or 'TRIAL_VAR <name>=<value>'. The <name> cannot contain spaces or '=' sign. White spaces are trimmed for both <name> and <value>.

• trial Trial index.

• sttime Start time.

• sttime_rel Start time, relative to the start time of the trial.

• variable Variable name, the <name> part of the event message.

• value Variable value, the <value> part of the event message.

Trigger events

Events messages that adhere to a TRIGGER <label> format. This is a non-standard message that the package author uses to mark events like onsets or offsets, similar to how it is done in M/EEG.

• trial Trial index.

• sttime Start time.

• sttime_rel Start time, relative to the start time of the trial.

• label label part of the message, can contain white spaces.

AOIs

Rectangular areas of interest (AOI), as defined by "!V IAREA RECTANGLE" command. Specifically, they are expected to be in format !V IAREA RECTANGLE <index> <left> <top> <right> <bottom> <label>. where <label> is a string label and all other variables are integer.

• trial Trial index.

• sttime Start time.

• sttime_rel Start time, relative to the start time of the trial.

• index AOI index.

• left, top, right, bottom AOI coordinates.

• label AOI label.

See Also

read_edf, extract_saccades, extract_fixations, extract_blinks, extract_triggers, extract_display_coords, extract_AOIs

eyelinkReader documentation built on April 4, 2025, 1:30 a.m.