movement.sample_data.fetch_dataset#

movement.sample_data.fetch_dataset(filename)[source]#

Load a sample dataset containing pose data.

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 pose 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.
Returns:: ds – Pose data contained in the fetched sample file.
Return type:: xarray.Dataset

Examples

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