API Reference

Top-level functions and classes

`get_test_recording`	Get a short test recording for demonstration.
`load_gaze`	Load gaze data as an xarray.Dataset.
`load_pupils`	Load pupil data as an xarray.Dataset.
`load_markers`	Load calibration marker data as an xarray.Dataset.
`load_motion`	Load pupil data as an xarray.Dataset.
`write_netcdf`	Export a recording in the netCDF format.
`load_info`	Load recording info.
`load_user_info`	Load user info.
`load_pldata`	Load data from a .pldata file as a list of dicts.
`save_pldata`	Save data from a list of dicts as a .pldata file.
`get_gaze_mappers`	Get available gaze mappers for a recording.
`load_object`	Load a msgpack object (intrinsics, calibration, etc.).
`save_object`	Save data as a msgpack object (intrinsics, calibration, etc.).

Merge detected pupils from both eyes, sorted by timestamp.

`GazeReader`	Reader for gaze data.
`MotionReader`	Reader for odometry data.
`VideoReader`	Reader for video data.
`OpticalFlowReader`	Reader for extracting optical flow from video data.

`VideoStream`	Video stream.
`MotionStream`	Motion data stream.
`StreamManager`	Manager for multiple streams.

`Pipeline`	Pipeline for different processing steps.
`VideoDisplay`	Display for video stream.
`VideoRecorder`	Recorder for a video stream.
`PupilDetector`	Pupil detector for eye video streams.
`GazeMapper`	Gaze mapper.
`CircleDetector`	Detector for circular calibration markers.
`Calibration`	Calibration.
`CircleGridDetector`	Detector for circle grids.
`CamParamEstimator`	Camera parameter estimator.
`MotionRecorder`	Recorder for a motion stream.
`VideoFileSyncer`	Syncer for VideoFileDevices.