API reference#

This is the complete list of classes and functions. Everything listed here is available directly from the package, e.g. pp.EyeData after import pypillometry as pp. For an introduction to how they fit together, see the User guide.

Data classes

EyeData and its generic methods, channels, mask layers and policies.

Data classes
Pupil methods

d.pupil: blinks, filters, merging the eyes, baseline and response models.

Pupil methods (d.pupil)
Gaze methods

d.gaze: off-screen samples and eye divergences.

Gaze methods (d.gaze)
Pipelines

Processing steps for d | pp.pupil.blinks_detect() | ....

Pipelines
Events and intervals

Events, Intervals and functions to combine them.

Events and intervals
Segmented data

Event-related segments for single participants and groups, with their pupil (seg.pupil) and gaze (seg.gaze) methods.

Segmented data
Plotting

d.plot: the plotting functions.

Plotting (d.plot)
Reading and writing data

Files, URLs, OSF, studies and example datasets.

Reading and writing data
Signal processing

Low-level functions on numpy arrays: filtering, blinks, baseline and response models, simulated data.

Signal processing
Geometry and gaze (experimental)

Experimental setup, calibration, foreshortening and regions of interest.

Geometry and gaze
Units

Times, distances and angles with units.

Units
Viewer, settings and logging

Interactive tools, package-wide settings and logging.

Viewer, settings and logging