deepof.visuals.output_unsupervised_annotated_video

deepof.visuals.output_unsupervised_annotated_video(video_path: str, breaks: list, soft_counts: ndarray, frame_rate: int = 25, frame_limit: int = inf, window_length: int | None = None, cluster_names: dict = {}, out_path: str = '.')

Given a video, and soft_counts per frame, outputs a video with the frames annotated with the cluster they belong to.

Parameters:
  • video_path – full path to the video

  • breaks – dictionary with break lengths for each video

  • soft_counts – soft cluster assignments for a specific video

  • frame_rate – frame rate of the video

  • frame_limit – maximum number of frames to output.

  • window_length – window length used to compute the soft counts.

  • cluster_names – dictionary with user-defined names for each cluster (useful to output interpretation).

  • out_path – out_path: path to the output directory.