Reader classes
==============

.. currentmodule:: pupil_recording_interface

GazeReader
.............

I/O functions
~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    GazeReader.load_dataset
    GazeReader.write_netcdf


PupilReader
..............

I/O functions
~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    PupilReader.load_dataset
    PupilReader.write_netcdf


MarkerReader
..............

I/O functions
~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    MarkerReader.load_dataset
    MarkerReader.write_netcdf


MotionReader
..............

I/O functions
~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    MotionReader.load_dataset
    MotionReader.write_netcdf


VideoReader
............

I/O functions
~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    VideoReader.load_frame
    VideoReader.load_raw_frame
    VideoReader.read_frames
    VideoReader.load_timestamps
    VideoReader.load_dataset
    VideoReader.write_netcdf

Frame processing
~~~~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    VideoReader.convert_to_uint8
    VideoReader.convert_color
    VideoReader.get_roi
    VideoReader.undistort_frame
    VideoReader.subsample_frame
    VideoReader.process_frame


OpticalFlowReader
.................

See the parent `VideoReader`_ class for additional methods.

I/O functions
~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    OpticalFlowReader.load_dataset
    OpticalFlowReader.write_netcdf
    OpticalFlowReader.load_optical_flow
    OpticalFlowReader.read_optical_flow

Optical flow calculation
~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
    :nosignatures:
    :toctree: ../_generated

    OpticalFlowReader.calculate_optical_flow