User guide#
The user guide explains the main ideas behind pypillometry. Each
page gives an overview of a topic and links to the
tutorials for worked examples and to the
API reference for all parameters.
If you have not used the package before, start with the Quickstart.
EyeData; channels; mask layers and policies; pipelines,
in-place operations and history.
Eyelink EDF and ASC files, your own arrays, example datasets and saved objects.
Give times, distances and angles with units: 3 * u.min,
"200 ms", 60 * u.cm.
Blinks, gaze artifacts, filtering, downsampling, scaling and combining the eyes.
Blinks, off-screen gaze, excluded periods and interpolation: where the reason for each bad sample is stored and what each method does with it.
Gaze coordinates, the screen and camera geometry, conversion to degrees, off-screen and divergent samples, gaze plots and regions.
Regions of the screen; where the gaze is around events, fixation curves, dwell time and first entry per trial.
A quality report with labeled measures (missing data, noise, blinks, calibration) and how the thresholds were chosen.
Select events, build time windows around them, cut the data into segments and compute event-related pupil dilations.
Time series, blinks, intervals, heatmaps and scanpaths.
A fast viewer for long recordings and a tool for tuning parameters while you watch the result.
Separate the signal into a slow baseline and event-related responses.
Load a whole study from a local folder or from OSF with a configuration file.
Package-wide defaults and how much the package tells you about what it does.