API Reference

This page contains the API reference for public objects and functions in tobii-pytracker.

Runtime Models

`tobii_pytracker.analyze.DataLoader`	Main analysis orchestrator.
`tobii_pytracker.analyze.HeatmapAnalyzer`	Generates gaze heatmaps and overlays them over screenshots.
`tobii_pytracker.analyze.FocusMapAnalyzer`	Focus Map Analyzer — shows areas NOT looked at (inverted heatmap).
`tobii_pytracker.analyze.FixationAnalyzer`	Detects and visualizes gaze fixations from time-series gaze data.
`tobii_pytracker.analyze.SaccadeAnalyzer`	Calculates saccade metrics (dx, dy, dt, amplitude, velocity, acceleration) from gaze data.
`tobii_pytracker.analyze.EntropyAnalyzer`	Computes gaze entropy and dispersion measures (Shannon entropy and Convex Hull area).
`tobii_pytracker.analyze.ClusterAnalyzer`	Performs clustering on gaze coordinates.
`tobii_pytracker.analyze.ScanpathsAnalyzer`	Analyzes sequential transitions between fixations.
`tobii_pytracker.analyze.VoiceTranscription`	Transcribes per-slide voice recordings using Whisper and aligns transcript segments with gaze samples based on shared experiment time.
`tobii_pytracker.analyze.BBoxTextAnalyzer`	Analyzes gaze attention to word-level text bounding boxes.
`tobii_pytracker.analyze.BBoxImagesAnalyzer`	Analyzes gaze attention to object bounding boxes in slide images.
`tobii_pytracker.analyze.BBoxTimeSeriesAnalyzer`	Analyzes gaze interaction with bounding boxes in time-series plots.

`tobii_pytracker.datasets.CustomDataset`
`tobii_pytracker.datasets.ImageDataset`	Image dataset that draws images and computes bounding boxes.
`tobii_pytracker.datasets.TextDataset`	Text dataset that draws text into a PsychoPy window and returns exact per-line and per-word bboxes in center-origin pixel coordinates. The draw_stimulus method draws text and returns: {"words": [{"word":str,"conf":1.0,"bbox":{cx,cy,w,h}}...], "lines": [{"text":str,"conf":1.0,"bbox":{...}}...]}.
`tobii_pytracker.datasets.TimeSeriesDataset`	Multi-channel time series dataset.