API Reference
=============

This page contains the API reference for the ``pupeyes`` package.

Reading Eyelink Data
----------------------------

.. automodule:: pupeyes.data.eyelink
   :members:
   :undoc-members:
   :show-inheritance:

Reading Tobii Data (from Titta)
--------------------------------

.. automodule:: pupeyes.data.tobii_titta
   :members:
   :undoc-members:
   :show-inheritance:

Pupil Preprocessing
----------------------------

.. automodule:: pupeyes.pupil
   :members:
   :undoc-members:
   :show-inheritance:

Areas of Interest (AOI)
----------------------------

.. automodule:: pupeyes.aoi
   :members:
   :undoc-members:
   :show-inheritance:


Interactive Applications
----------------------------
Pupil Viewer
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.apps.pupil_viewer
   :members:
   :undoc-members:
   :show-inheritance: 

Fixation Viewer
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.apps.fixation_viewer
   :members:
   :undoc-members:
   :show-inheritance:

AOI Drawer
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.apps.aoi_drawer
   :members:
   :undoc-members:
   :show-inheritance:


Utilities
----------------------------
General Utilities
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.utils
   :members:
   :undoc-members:
   :show-inheritance:

Plotting Utilities
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.plot_utils
   :members:
   :undoc-members:
   :show-inheritance:


Miscellaneous
----------------------------

Saccade Functions
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.saccades
   :members:
   :undoc-members:
   :show-inheritance:

External Modules
----------------------------

EDF Reader
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.external.edfreader
   :members:
   :undoc-members:
   :show-inheritance:

Blink Detection
~~~~~~~~~~~~~~~~~~~~

.. automodule:: pupeyes.external.based_noise_blinks_detection
   :members:
   :undoc-members:
   :show-inheritance: