pupil_recording_interface.OpticalFlowReader.load_optical_flow

OpticalFlowReader.load_optical_flow(idx=None, return_timestamp=False)

Load a single optical flow frame.

Parameters

• idx (int or Timestamp, optional) – The index of the frame. If not specified, will load the next frame. If Timestamp, will load the frame with the closest timestamp.

• return_timestamp (bool, default False) – If True, also return the timestamp of the frame.

Returns

The loaded optical flow frame.

Return type

numpy.ndarray