esdalmaijer / PyGaze

an open-source, cross-platform toolbox for minimal-effort programming of eye tracking experiments
www.pygaze.org
GNU General Public License v3.0
671 stars 211 forks source link

wait_for_fixation_end() doesn't return what it is expected in libeyetribe.py (EDIT: Documentation issue) #116

Open kismari opened 6 years ago

kismari commented 6 years ago

Reading the documentation, this function must return "time, startpos, endpos" but, instead of that, it returns clock.get_time(), spos

esdalmaijer commented 6 years ago

Thanks for the report! That's actually an error in the documentation, sorry! The function should return ending time and position. The starting and ending position should be roughly the same, hence only one of them is returned. (In fact, the point of the detection is that the current gaze position hasn't drifted too far from the starting position.)

Note that these wait_for_* functions are to implement gaze contingent functionality, and thus they're not as precise as offline analyses would be. (Hence you only get the rough position of the fixation, and not the higher detail info on what happened during the fixation.)