Skip to main content

analysis.videowriter

logger_config​

logger​

create_cluster_videos​

def create_cluster_videos(
        config: dict,
        path_to_file: str,
        session: str,
        n_clusters: int,
        flag: str,
        segmentation_algorithm: SegmentationAlgorithms,
        tqdm_logger_stream: Union[TqdmToLogger, None] = None) -> None

Generate cluster videos and save them to filesystem on project folder.

The session's source video is resolved from data/raw, whatever format it was loaded in. Clips are always written as H.264 MP4, since they are re-encoded montages rather than copies of the source.

Parameters

  • config (dict): Configuration parameters.
  • path_to_file (str): Path to the file.
  • session (str): Name of the session.
  • n_clusters (int): Number of clusters.
  • flag (str): Flag indicating the type of video (motif or community).
  • segmentation_algorithm (SegmentationAlgorithms): Which segmentation algorithm to use. Options are 'hmm' or 'kmeans'.
  • tqdm_logger_stream (TqdmToLogger, optional): Tqdm logger stream. Default is None.

Returns

  • None

motif_videos​

@save_state(model=MotifVideosFunctionSchema)
def motif_videos(config: dict, save_logs: bool = True) -> None

Generate motif videos and save them to filesystem. Fills in the values in the "motif_videos" key of the states.json file. Files are saved at:

  • project_name/
    • results/
      • session_name/
        • model_name/
          • segmentation_algorithm-n_clusters/
            • cluster_videos/
              • session_name-motif_0.mp4
              • session_name-motif_1.mp4
              • ...

Parameters

  • config (dict): Configuration parameters.
  • segmentation_algorithm (SegmentationAlgorithms): Which segmentation algorithm to use. Options are 'hmm' or 'kmeans'. If None, it will be taken from the config file.
  • save_logs (bool, optional): Save logs to filesystem. Default is True.

Returns

  • None

community_videos​

@save_state(model=CommunityVideosFunctionSchema)
def community_videos(config: dict, save_logs: bool = True) -> None

Generate community videos and save them to filesystem on project community_videos folder. Fills in the values in the "community_videos" key of the states.json file. Files are saved at:

  • project_name/
    • results/
      • session_name/
        • model_name/
          • segmentation_algorithm-n_clusters/
            • community_videos/
              • session_name-community_0.mp4
              • session_name-community_1.mp4
              • ...

Parameters

  • config (dict): Configuration parameters.
  • save_logs (bool, optional): Save logs to filesystem. Default is True.

Returns

  • None