Skip to main content

Lightweight Python wrapper around tobii-researcher

Project description

DeToX

DeToX (Developmental Tobii Experiment) is a user-friendly Python wrapper for the tobii-researcher library. It is designed to simplify the integration of Tobii eye-tracking hardware with PsychoPy, particularly for conducting developmental studies involving infants. By streamlining the process of data collection, DeToX aims to enhance the efficiency of developmental eye-tracking experiments.

Quick Install

pip install dvst-detox

or for the latest version:

pip install git+https://github.com/DevStart-Hub/DeToX.git

Coming soon to PyPI for even easier installation!

Why We Built DeToX

While the official Tobii SDK provides powerful features, we found it could be complex for routine research tasks. DeToX bridges this gap by offering a straightforward approach to eye-tracking data collection.

We don't aim to be the most feature-rich package - we built exactly what we needed for our infant-friendly studies: a simple, well-documented tool that just works

This project didn't start from scratch—it builds upon an existing repository that we have used in the past: psychopy_tobii_infant

While the eye-tracking landscape offers many tools—from PsychoPy's built-in Tobii integration to comprehensive packages like Titta—DeToX carves out its own niche through thoughtful simplicity. We've prioritized clarity and ease-of-use without sacrificing the flexibility researchers need. When your codebase is straightforward and well-documented, it becomes a platform for innovation rather than an obstacle to overcome.

Key Features

  • Simple Data Recording: Start and stop eye-tracking recordings with just one line of code. Collect gaze data, pupil measurements, and timestamped events automatically during your experiments.

  • HDF5 Data Storage: Save data in analysis-ready HDF5 format with events embedded directly in the gaze timeline for easy analysis, while preserving raw event data in a separate table for advanced processing. Includes comprehensive metadata like screen dimensions, framerate, and recording settings.

  • Infant-Friendly Calibration: Engage infants with animated calibration stimuli featuring zoom and trill effects. Use colorful, attention-getting images with optional sound feedback for better participant engagement.

  • Calibration Management: Save and load calibration files to reuse participant calibrations across multiple sessions.

  • Simulation Mode: Test your experiments using mouse input as a gaze proxy when hardware isn't available. Perfect for development, debugging, and pilot studies without requiring physical eye trackers.

  • Gaze-Contingent Support: Real-time gaze processing for interactive paradigms with configurable smoothing windows. Extract gaze positions using median, mean, or last-sample methods for different latency/accuracy trade-offs.

Learn More

We believe good software requires great documentation. Explore our comprehensive guides and examples:

📚 DeToX Documentation (coming soon)


Questions or found a bug? Let us know by creating an issue or starting a discussion here on GitHub!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dvst_detox-0.2.0.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dvst_detox-0.2.0-py3-none-any.whl (2.4 MB view details)

Uploaded Python 3

File details

Details for the file dvst_detox-0.2.0.tar.gz.

File metadata

  • Download URL: dvst_detox-0.2.0.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for dvst_detox-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b75dece5b7161d70f3c460a40d333cd1e0a5a8e85d2d05b7a9cb7f697823f0c4
MD5 3568aa5a1936a572637831c328bfb26a
BLAKE2b-256 52f0c08989f2686a09107213baf1c77126941f7766cba790bce69ebbdbf77222

See more details on using hashes here.

File details

Details for the file dvst_detox-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dvst_detox-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 2.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for dvst_detox-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e7cc47051965e1ac210d10b566ab24b0f8b25939a7dab63bf3f067e07038829e
MD5 36ce32aef65650f3ba2d048aa7689a91
BLAKE2b-256 004c0867b5183fff425518693cbe379cd0d3ee72734e88e347664b0d766fd28f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page