API#

This is the API documentation for the eyelinkio package, grouped thematically by functionality. we use snake_case for function names and CamelCase for class names.

Reading EDF files#

Functions for reading Eyelink EDF Files.

eyelinkio.edf.read_edf.read_edf(fname)#

Read an EyeLink EDF file.

Parameters:
fnamepath-like

The name of the EDF file.

Returns:
edfEDF

An instance of EDF: The EyeLink data represented in Python.

EDF class#

class eyelinkio.EDF(fname)#

Represent EyeLink EDF files in Python.

This class is a subclass of dict, and so can be indexed like a dictionary. To see the available keys, use the keys() method.

Parameters:
fnamestr

The name of the EDF file.

Methods

to_mne()

Create an MNE Raw object from the EDF object.

to_pandas()

Convert an EDF file to a pandas DataFrame.
to_mne()#

Create an MNE Raw object from the EDF object.

Returns:
rawRawEyelink

An instance of Raw.

calibrationslist of Calibration

A list of Calibration objects.

to_pandas()#

Convert an EDF file to a pandas DataFrame.

Returns:
df_samplesdict of DataFrame

A dictionary of DataFrame’s, containing the samples, blinks, saccades, fixations, messages, and calibrations.