get_available_datasets#

pypillometry.get_available_datasets()[source]#

Return available example datasets.

Returns a dict (name -> properties) that is displayed as a table.

Returns:
DatasetDict

dataset name -> its properties (source, file type, description, files); displayed as a table with the name, source, file type and description of each dataset

Examples

>>> datasets = get_available_datasets()
>>> datasets  # in Jupyter, this displays as a table
>>> "rlmw_002_short" in datasets  # but it is a normal dict
True
>>> datasets["rlmw_002"]["description"][:30]
'Binocular data from a 20-minut'