mne-python icon indicating copy to clipboard operation
mne-python copied to clipboard

Feature request: Support for BUTTON events in Eyelink ASC file parser

Open WouterKroot opened this issue 7 months ago • 3 comments

Describe the new feature or enhancement

I’m currently using read_raw_eyelink() to load Eyelink ASC files, but I noticed that BUTTON events in the ASC files are not captured or annotated.

I checked the code and it seems BUTTON events aren’t supported yet.

Is there any plan to support BUTTON events? Or is there a recommended workaround to include BUTTON events as annotations?

Thanks a lot for the help and the great package!

Describe your proposed implementation

In the create_annotations in mne/io/eyelink/_utils.py add 'BUTTON' to handle:

raw = read_raw_eyelink(path, create_annotations=['blinks', 'messages', 'buttons'])

Describe possible alternatives

manually parse

Additional context

No response

WouterKroot avatar May 16 '25 13:05 WouterKroot

@WouterKroot would you be up for adding support for BUTTON events? And maybe the default create_annotations=True should include these events (would count as an enhancement I think). cc @scott-huberty

larsoner avatar May 16 '25 14:05 larsoner

Sure, I'll first look at the contribution guide.

WouterKroot avatar May 16 '25 14:05 WouterKroot

I sent in a pull request #13253, feel free to contact me if any further changes are necessary.

WouterKroot avatar May 19 '25 11:05 WouterKroot