diplomat.frontends.deeplabcut.label_videos_dlc.label_videos

diplomat.frontends.deeplabcut.label_videos_dlc.label_videos(config: Union[PathLike, str], videos: Union[List[Union[PathLike, str]], Union[PathLike, str]], body_parts_to_plot: Optional[List[str]] = None, shuffle: int = 1, training_set_index: int = 0, video_type: str = '', **kwargs) → None[source]

Create labeled videos using results generated by DIPLOMAT’s DEEPLABCUT frontend.

Parameters

  • config – The path to the DLC config.yaml. The visual settings from the DLC config are used.

  • videos – A single path or list of paths, to the location of the video files to annotate. Can also be a directory.

  • body_parts_to_plot – A list of strings, specifying which body parts to plot. Defaults to None, which plots points for all body parts.

  • shuffle – int, optional. An integer specifying the shuffle index of the training dataset used for training the network. The default is 1.

  • training_set_index – int, optional. Integer specifying which TrainingsetFraction to use. By default, the first (note that TrainingFraction is a list in config.yaml).

  • video_type – Optional string, the video extension to search for if the ‘videos’ argument is a directory to search inside (‘.avi’, ‘.mp4’, …).

  • kwargs –

    The following additional arguments are supported:

    • skeleton_color (Type: to_rgba, Default: black): Color of the skeleton.

    • pcutoff (Type: RangedFloat[min=0.0, max=1.0], Default: 0.1): The probability to cutoff results below.

    • dotsize (Type: int, Default: 4): The size of the dots.

    • alphavalue (Type: RangedFloat[min=0.0, max=1.0], Default: 0.7): The alpha value of the dots.

    • colormap (Type: to_colormap, Default: None): The colormap to use for tracked points in the video. Can be a matplotlib colormap or a list of matplotlib colors.

    • shape_list (Type: Optional[List[str]], Default: None): A list of shape names, shapes to use for drawing each individual’s dots.

    • line_thickness (Type: int, Default: 1): Thickness of lines drawn.

    • antialiasing (Type: bool, Default: True): Use antialiasing when drawing points.

    • draw_hidden_tracks (Type: bool, Default: True): Whether or not to draw locations under the pcutoff value.

    • output_codec (Type: cv2_fourcc_string, Default: mp4v): The codec to use for the labeled video…