Welcome to PyPlr’s documentation!

PyPlr is a Python library for researching the pupillary light reflex with the Pupil Core eye tracking platform. See also, PySilSub, a sister project offering Python support for the method of silent substitution.

PyPlr’s features include:

• User-friendly and feature-rich interfaces to:

  • Pupil Core (Pupil Labs GmbH, Berlin, Germany)

  • Spectra Tune Lab (STLAB: LEDMOTIVE Technologies, LLC, Barcelona, Spain) light engine

  • Ocean Optics (Ocean Insight Inc., Oxford, UK) spectrometers

• Flexible support for alternative stimulus delivery and measurement systems

• Scripting tools to facilitate stimulus design, optimisation and delivery, communication with respect to timing, and extraction, cleaning, and analysis of pupil data

Contents:

• Purpose
• Installation
  • Requirements
  • Virtual environments
  • Notes/Potential Issues
• Overview
  • PyPlr and Pupil Core
  • Spectra Tune Lab light source
  • Integrating sphere
  • Analysis of pupil data
• Example protocols
  • Simple PLR
  • PsychoPy PLR
  • Automated pupillometer with STLAB
  • PIPR with STLAB
  • Pupil Core camera synchronisation
• Example analyses
  • PIPR preprocessing pipeline
  • Pupil Core device timing
  • Matching spectra for a-opic irradiance with STLAB
  • Silent substitution with STLAB
• API documentation
  • pyplr.pupil
  • pyplr.stlab
  • pyplr.jeti
  • pyplr.oceanops
  • pyplr.calibrate
  • pyplr.CIE
  • pyplr.utils
  • pyplr.preproc
  • pyplr.plr
• Developers
  • Issues, bugs and feature requests
  • Contribute
• Acknowledgements
• Funding
• Citation

Tables and indices

---

• Index

• Module Index

• Search Page