deepof.visuals.export_annotated_video

deepof.visuals.export_annotated_video(coordinates: deepof_coordinates, soft_counts: dict | None = None, breaks: dict | None = None, experiment_id: str | None = None, min_confidence: float = 0.75, min_bout_duration: int | None = None, frame_limit_per_video: int = inf, exp_conditions: dict = {}, cluster_names: dict = {})

Export annotated videos from both supervised and unsupervised pipelines.

Parameters:

• coordinates (coordinates) – coordinates object for the current project. Used to get video paths.

• soft_counts (dict) – dictionary with soft_counts per experiment.

• breaks (dict) – dictionary with break lengths for each video.r

• experiment_id (str) – if provided, data coming from a particular experiment is used. If not, all experiments are exported.

• min_confidence (float) – minimum confidence threshold for a frame to be considered part of a cluster.

• min_bout_duration (int) – Minimum number of frames to render a cluster assignment bout.

• frame_limit_per_video (int) – number of frames to render per video. If None, all frames are included for all videos.

• exp_conditions (dict) – if provided, data coming from a particular condition is used. If not, all conditions are exported. If a dictionary with more than one entry is provided, the intersection of all conditions (i.e. male, stressed) is used.

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