aeye-lab / pymovements

A python package for processing eye movement data
https://pymovements.readthedocs.io
MIT License
57 stars 11 forks source link

compute event properties during event detection #550

Open dkrako opened 9 months ago

dkrako commented 9 months ago

Description of the problem

Event properties must be computed explicitly after detecting the events.

dataset.detect('ivt')
dataset.compute_event_properties(properties=['location', 'dispersion'], name='ivt')
dataset.detect('microsaccades')
dataset.compute_event_properties(properties=['amplitude', 'peak_velocity'], name='saccade')

This is not user friendly.

Description of a solution

For some properties it might make sense to calculate them during event detection. This could be a code example:

dataset.detect('ivt', properties=['location', 'dispersion'])
dataset.detect('microsaccades', properties=['amplitude', 'peak_velocity'])

Minimum acceptance criteria

Specify what is necessary for the issue to be closed.