Reader classes

GazeReader

I/O functions

GazeReader.load_dataset	Load gaze data as an xarray Dataset.
GazeReader.write_netcdf	Export data to netCDF.

PupilReader

I/O functions

PupilReader.load_dataset	Load pupil data as an xarray Dataset.
PupilReader.write_netcdf	Export data to netCDF.

MarkerReader

I/O functions

MarkerReader.load_dataset	Load pupil data as an xarray Dataset.
MarkerReader.write_netcdf	Export data to netCDF.

MotionReader

I/O functions

MotionReader.load_dataset	Load motion data as an xarray Dataset.
MotionReader.write_netcdf	Export data to netCDF.

VideoReader

I/O functions

VideoReader.load_frame	Load a single processed video frame.
VideoReader.load_raw_frame	Load a single un-processed video frame.
VideoReader.read_frames	Generator for frames.
VideoReader.load_timestamps	Load the timestamps for the video file.
VideoReader.load_dataset	Load video data as an xarray Dataset
VideoReader.write_netcdf	Export data to netCDF.

Frame processing

VideoReader.convert_to_uint8	Convert a video frame to uint8 dtype.
VideoReader.convert_color	Convert color format of a video frame.
VideoReader.get_roi	Extract the ROI from a video frame.
VideoReader.undistort_frame	Un-distort a video frame.
VideoReader.subsample_frame	Sub-sample a video frame.
VideoReader.process_frame	Process a video frame.

OpticalFlowReader

See the parent VideoReader class for additional methods.

I/O functions

OpticalFlowReader.load_dataset	Load optical flow data as an xarray Dataset
OpticalFlowReader.write_netcdf	Export data to netCDF.
OpticalFlowReader.load_optical_flow	Load a single optical flow frame.
OpticalFlowReader.read_optical_flow	Generator for optical flow frames.

Optical flow calculation

OpticalFlowReader.calculate_optical_flow

Calculate dense optical flow between two frames.