from_dlc_file

movement.io.load_poses.from_dlc_file(file, fps=None)

Create a movement poses dataset from a DeepLabCut file.

Parameters:

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

• fps (float | None) – 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:

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)

Notes

In movement, pose data can only be loaded if all individuals have the same set of keypoints (i.e., the same labeled body parts). While DeepLabCut supports assigning keypoints that are not shared across individuals (see the DeepLabCut documentation for multi-animal projects), this feature is not currently supported in movement.