fetch_dataset#

movement.sample_data.fetch_dataset(filename, with_video=False)[source]#

Load a sample dataset.

The data are downloaded from the movement data repository to the user’s local machine upon first use and are stored in a local cache directory. This function returns the data as an xarray Dataset. If there are any associated frames or videos, these files are also downloaded and the paths are stored as dataset attributes.

Parameters:

filename (str) – Name of the file to fetch.
with_video (bool, optional) – Whether to download the associated video file (if available). If set to False, the “video” entry in the returned dictionary will be None. Defaults to False.

Returns:

ds – Data contained in the fetched sample file.

Return type:

xarray.Dataset

Examples

Fetch a sample dataset and get the paths to the associated frame and video files:

>>> from movement.sample_data import fetch_dataset
>>> ds = fetch_dataset(
    "DLC_single-mouse_EPM.predictions.h5", with_video=True
)
>>> frame_path = ds.video_path
>>> video_path = ds.frame_path