deepof.visuals.annotate_video

deepof.visuals.annotate_video(coordinates: deepof_coordinates, tag_dict: DataFrame, vid_index: int, frame_limit: int = inf, debug: bool = False, params: dict = {}) → True

Render a version of the input video with all supervised taggings in place.

Parameters:

• coordinates (deepof.preprocessing.coordinates) – coordinates object containing the project information.

• debug (bool) – if True, several debugging attributes (such as used body parts and arena) are plotted in the output video.

• vid_index – for internal usage only; index of the video to tag in coordinates._videos.

• frame_limit (float) – limit the number of frames to output. Generates all annotated frames by default.

• params (dict) – dictionary to overwrite the default values of the hyperparameters of the functions that the supervised pose estimation utilizes.