pupil_recording_interface.load_pupils

pupil_recording_interface.load_pupils(folder, source='recording', method='pye3d', cache=False)

Load pupil data as an xarray.Dataset.

Parameters

• folder (str or pathlib.Path) – Path to the recording folder.

• source (str, default "recording") – The source of the pupil data. Can be “recording” or “offline”.

• cache (bool, default False) – If True, cache the dataset as a netCDF file in the recording folder.

Returns

The pupil data as a dataset.

Return type

xarray.Dataset