pupil_recording_interface.VideoReader.load_dataset

VideoReader.load_dataset(dropna=False, start=None, end=None)

Load video 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.

Returns

The video data as a dataset.

Return type

xarray.Dataset