mne.io.read_raw_eyelink#

mne.io.read_raw_eyelink(fname, preload=False, verbose=None, create_annotations=True, apply_offsets=False, find_overlaps=False, overlap_threshold=0.05, gap_description='bad_rec_gap')[source]#

Reader for an Eyelink .asc file.

Parameters:

fnamestr: Path to the eyelink file (.asc).
preloadbool or str (default False): Preload data into memory for data manipulation and faster indexing. If True, the data will be preloaded into memory (fast, requires large amount of memory). If preload is a string, preload is the file name of a memory-mapped file which is used to store the data on the hard drive (slower, requires less memory).
verbosebool | str | int | None: Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.
create_annotationsbool | list (default True): Whether to create mne.Annotations from occular events (blinks, fixations, saccades) and experiment messages. If a list, must contain one or more of [‘fixations’, ‘saccades’,’ blinks’, messages’]. If True, creates mne.Annotations for both occular events and experiment messages.
apply_offsetsbool (default False): Adjusts the onset time of the mne.Annotations created from Eyelink experiment messages, if offset values exist in self.dataframes[‘messages’].
find_overlapsbool (default False): Combine left and right eye mne.Annotations (blinks, fixations, saccades) if their start times and their stop times are both not separated by more than overlap_threshold.
overlap_thresholdfloat (default 0.05): Time in seconds. Threshold of allowable time-gap between the start and stop times of the left and right eyes. If gap is larger than threshold, the mne.Annotations will be kept separate (i.e. “blink_L”, “blink_R”). If the gap is smaller than the threshold, the mne.Annotations will be merged (i.e. “blink_both”).
gap_descriptionstr (default ‘bad_rec_gap’): If there are multiple recording blocks in the file, the description of the annotation that will span across the gap period between the blocks. Uses ‘bad_rec_gap’ by default so that these time periods will be considered bad by MNE and excluded from operations like epoching.

Returns: