deepof.utils.get_arenas

deepof.utils.get_arenas(coordinates: deepof_coordinates, tables: deepof_table_dict, arena: str, arena_dims: int, project_path: str, project_name: str, segmentation_model_path: str, videos: list | None = None, debug: bool = False, test: bool = False)

Extract arena parameters from a project or coordinates object.

Parameters:

• coordinates (coordinates) – Coordinates object.

• tables (table_dict) – TableDict object containing tracklets per animal.

• arena (str) – Arena type (must be either “polygonal-manual”, “circular-manual”, “polygonal-autodetect”, or “circular-autodetect”).

• arena_dims (int) – Arena dimensions.

• project_path (str) – Path to project.

• project_name (str) – Name of project.

• segmentation_model_path (str) – Path to segmentation model used for automatic arena detection.

• videos (list) – List of videos to extract arena parameters from. Defaults to None (all videos are used).

• debug (bool) – If True, a frame per video with the detected arena is saved. Defaults to False.

• test (bool) – If True, the function is run in test mode. Defaults to False.

Returns:

List of arena parameters.

Return type:

arena_params (list)