edf.events: Load Events

In jashubbard/edfR: Basic functions for importing SR-Research Eyelink EDF files

Load Events

Description

Loads the events of a SR EyeLink EDFfile.

Usage

edf.events(EDFfile, type, fields)

Arguments

EDFfile	a character string giving the name of the EDFfile to load.
type	a character string array giving the name of the event types to load.
fields	a character string array giving the names of the fields to load.

Details

type may be: "STARTBLINK", "STARTSACC", "STARTFIX", "STARTSAMPLES", "STARTEVENTS", "STARTPARSE", "ENDBLINK", "ENDSACC", "ENDFIX", "ENDSAMPLES", "ENDEVENTS", "ENDPARSE", "FIXUPDATE", "BREAKPARSE", "BUTTONEVENT", "INPUTEVENT", "MESSAGEEVENT", "SAMPLE_TYPE", "RECORDING_INFO" (default=ENDFIX.)

fields may be:

• "time": effective time of event

• "type": 1=STARTPARSE, 2=ENDPARSE, 3=STARTBLINK, 4=ENDBLINK, 5=STARTSACC, 6=ENDSACC, 7=STARTFIX, 8=ENDFIX, 17=STARTEVENTS, 18=ENDEVENTS, 24=MESSAGEEVENT, 25=BUTTONEVENT

• "read": flags which items were included

• "eye": 0=left, 1=right

• "sttime": start time of the event

• "entime": end time of the event

• "hstx", "hsty": headref starting points

• "gstx", "gsty": gaze starting points

• "sta"

• "henx", "heny": headref ending points

• "genx", "geny": gaze ending points

• "ena"

• "havx", "havy": headref averages

• "gavx", "gavy": gaze averages

• "ava"

• "avel": accumulated average velocity

• "pvel": accumulated peak velocity

• "svel", "evel": start, end velocity

• "supd_x", "eupd_x": start, end units-per-degree

• "supd_y", "eupd_y": start, end units-per-degree

• "status": error, warning flags

• "flags": error, warning flags

• "input"

• "buttons"

• "parsedby": 7 bits of flags: PARSEDBY codes

• default is c("sttime","entime","gavx","gavy")

Specification of the field values are copied from the EDF Access C API user manual.

Value

a dataframe containing the specified fields of the events of a given type.

Author(s)

Guenther, T. and von der Malsburg, T.

Examples

## Not run: 

#this returns the start, end, (average) x coordinates, and (average) y coordinates of fixations:
edf.events('example.EDF')

#this gets the relevant information for saccades
events <- edf.events("example.EDF",type='ENDSACC',
            fields=c('sttime','entime','gstx','gsty','genx','geny','avel','pvel'))


## End(Not run)

jashubbard/edfR documentation built on Aug. 4, 2022, 5:18 p.m.