to_lp_file#

movement.io.save_poses.to_lp_file(ds, file)[source]#

Save a movement dataset to a LightningPose file.

Parameters:

ds (Dataset) – movement dataset containing pose tracks, confidence scores, and associated metadata.
file (str | Path) – Path to the file to save the poses to. File extension must be .csv.

Return type:

None

Notes

LightningPose saves pose estimation outputs as .csv files, using the same format as single-animal DeepLabCut projects. Therefore, under the hood, this function calls movement.io.save_poses.to_dlc_file() with split_individuals=True. This setting means that each individual is saved to a separate file. If the dataset contains more than one individual, the individual’s name is appended to the file path, just before the file extension, i.e. “/path/to/filename_individual1.csv”. If it contains only one individual, the given file path is used as is.