Welcome to the Tobii-Pytracker documentation

Tobii-Pytracker is a Python-based framework for Tobii eye tracker experiments and multimodal data collection.

Install

Tobii-Pytracker can be installed from either PyPI or directly from source code GitHub

To install form PyPI:

pip install tobii-pytracker

To install from source code:

git clone https://github.com/sbobek/tobii-pytracker
cd tobii-pytracker
pip install .
pip install "psychopy>=2024.1.4,<2025.1.0" --no-deps

To run it in headless mode, just recording all of the gaze data from Tobii eye tracker just run the following command in the environment where tobii-pytracker is installed. The –raw_data flag will save all of the raw data from the eye tracker, not only gaze and pupil size narrowed to defined area of interest:

tobii-pytracker --disable_psychopy --raw_data

Tutorials on data collection

• Configuration
  • Main Configuration file
  • Eyetracker configuration file
• Commandline Usage
  • Overview
  • Installation
  • Command-Line Usage
  • General Options
  • Boolean Flags
  • Other Options
  • Example Usage
  • File Output
  • Notes
• Basic Usage examples
  • Raw signal recording
  • Image Data Examples
  • Text Data Examples
  • Audio Data Examples
• Eyetracker emulation
  • Configuration
  • Data Collection
  • Mouse Control

Tutorials on data analysis

• Data loading and visualization
• Data analyzers
  • Available Analyzers
  • Using Analyzers

Reference

• API reference
  • Runtime Models
  • Analyzers
  • Datasets
• Extending Tobii-Pytracker

Development

• Troubleshooting
• Release notes
• Contributing guide