PupEyes: Your Buddy for Pupil Size and Eye Movement Data Analysis

PupEyes is a Python package for preprocessing and visualizing eye movement data. It handles pupil size preprocessing and supports interactive visualization of pupil size and fixation data. It supports both Eyelink and Tobii data as well as any generic eye-tracking dataset that conforms to minimal formatting requirements.

Installation

pip install pupeyes

or install the latest development version from Github

pip install git+https://github.com/HanZhang-psych/pupeyes.git

Executable Notebooks

Try PupEyes in MyBinder!

You can also click the rocket button on the top bar of a page and launch an executable notebook for that specific page.

Higlights

Best practices

The pupil data preprocessing pipeline is desgined based on the best practices available.

Pandas integration

Raw data is cleaned and prepared as a pandas dataframe, allowing you to enjoy the vast data analysis and manipulation methods offered by the pandas ecosystem.

Interactive interface

Multiple interactive visualizations using Plotly Dash allow you understand your data better.

Pupil Viewer: Examining Pupil Preprocessing Steps

Fixation Viewer: Visualize Fixation Patterns

AOI Drawing Tool: Flexibly Define AOIs

Tutorials

• Reading Eyelink Data
• Pupil Preprocessing
• Statistical Analysis of Pupil Data
• Visualizing Fixation Patterns
• Drawing Areas of Interest
• Working with Tobii Data
  • Reading Tobii Data (from Titta)
  • Reading Tobii Data from Tobii Pro Lab
• Comparing Blink Detection by Eyelink vs. Algorithm by Hershman et al.
• API Reference

Issues?

If you encounter a problem while running the code, or have suggestions for improvement, please submit an issue here.