idtrackerai.extra_tools.video_generator#

Warning

The code reference is a work in progress and may contain inconsistencies.

The video generator tool is used to generate videos from the tracking data generated by the idtracker.ai software, see Video Generators.

idtrackerai.extra_tools.video_generator.generate_trajectories_video(session: Session, trajectories_path: Path | str | None = None, draw_in_gray: bool = False, centroid_trace_length: int = 20, starting_frame: int = 0, ending_frame: int | None = None, no_labels: bool = False) → None[source]#

Generate general video, called by the command idtrackerai_video.

See also

Documentation for Video Generators

Parameters:

  • session (Session) – _description_

  • trajectories_path (Path | str | None, optional) – Path to the trajectories file. If None, the trajectories are loaded from the session folder, by default None.

  • draw_in_gray (bool, optional) – Flag to draw the video in grayscale, by default False.

  • centroid_trace_length (int, optional) – _description_, by default 20

  • starting_frame (int, optional) – Starting frame for the generated video, by default 0.

  • ending_frame (int | None, optional) – Ending frame for the generated video. If None, the video is generated until the end, by default None.

  • no_labels (bool, optional) – Flag to hide labels in the video, by default False.

idtrackerai.extra_tools.video_generator.generate_individual_video(session: Session, trajectories_path: Path | str | None = None, draw_in_gray: bool = False, starting_frame: int = 0, ending_frame: int | None = None, miniframe_size: float | None = None) → None[source]#

Generate individual video, called by the command idtrackerai_video.

See also

Documentation for Video Generators

Parameters:

  • session (Session) – Session instance to generate the videos from.

  • trajectories_path (Path | str | None, optional) – Path to the trajectories file. If None, the trajectories are loaded from the session folder, by default None.

  • draw_in_gray (bool, optional) – Flag to draw the video in grayscale, by default False.

  • starting_frame (int, optional) – Starting frame for the generated video, by default 0.

  • ending_frame (int | None, optional) – Ending frame for the generated video. If None, the video is generated until the end, by default None.

  • miniframe_size (float | None, optional) – Size, in pixels, of the individual square videos. If None, the size is adapted to fit the median body length, by default None.