from_dlc_file#

movement.io.load_poses.from_dlc_file(file_path, fps=None)[source]#

Create a movement poses dataset from a DeepLabCut file.

Parameters:

  • file_path (pathlib.Path or str) – Path to the file containing the predicted poses, either in .h5 or .csv format.

  • fps (float, optional) – The number of frames per second in the video. If None (default), the time coordinates will be in frame numbers.

Returns:

movement dataset containing the pose tracks, confidence scores, and associated metadata.

Return type:

xarray.Dataset

See also

movement.io.load_poses.from_dlc_style_df

Examples

>>> from movement.io import load_poses
>>> ds = load_poses.from_dlc_file("path/to/file.h5", fps=30)