load_multiview_dataset

movement.io.load.load_multiview_dataset(file_dict, source_software, fps=None, **kwargs)

Load and merge data from multiple files representing different views.

Parameters:

• file_dict (dict[str, Path | str]) – A dict whose keys are the view names and values are the paths to load.

• source_software (Literal['DeepLabCut', 'SLEAP', 'LightningPose', 'Anipose', 'NWB', 'VIA-tracks']) – The source software of the file.

• fps (float | None) – The number of frames per second in the video. If None (default), the time coordinates will be in frame numbers. This argument is ignored when source_software is “NWB”, as the frame rate will be directly read or estimated from metadata in the NWB file.

• **kwargs – Additional keyword arguments to pass to the software-specific loading functions in modules listed under “See Also”.

Returns:

movement dataset containing data concatenated along a new view dimension.

Return type:

Dataset

Notes

The attributes of the resulting dataset will be taken from the first dataset specified in file_path_dict. This is the default behaviour of xarray.concat() used under the hood.

See also

movement.io.load_poses, movement.io.load_bboxes