pupil_recording_interface.OpticalFlowReader.load_dataset

OpticalFlowReader.load_dataset(dropna=False, start=None, end=None, iter_wrapper=<function _iter_wrapper>)

Load optical flow data as an xarray Dataset

Parameters

  • dropna (bool, default False) – If True, drop all frames containing NaN values. This can happen with ROI extraction when the ROI is (partially) outside of the frame.

  • start (int or Timestamp, optional) – If specified, load the dataset starting at this frame index or timestamp.

  • end (int or Timestamp, optional) – If specified, load the dataset until this frame index or timestamp.

  • iter_wrapper (callable, optional) – A wrapper around the optical flow generator. Works with tqdm as a progress bar.

Returns

The optical flow data as a dataset.

Return type

xarray.Dataset