deepof.annotation_utils.climb_arena

deepof.annotation_utils.climb_arena(arena_type: str, arena: array, pos_dict: DataFrame, rel_tol: float, id: str, mouse_len: 50, centered_data: bool = False, run_numba: bool = False) → array

Return True if the specified mouse is climbing the wall.

Parameters:

• arena_type (str) – arena type; must be one of [‘polygonal-manual’, ‘circular-autodetect’]

• arena (np.array) – contains arena location and shape details

• pos_dict (table_dict) – position over time for all videos in a project

• rel_tol (float) – relative tolerance (to mouse length) to report a hit

• id (str) – indicates the id + subcondition of the animal

• centered_data (bool) – indicates whether the input data is centered

• run_numba (bool) – Determines if numba versions of functions should be used (run faster but require initial compilation time on first run)

Returns:

boolean array. True if selected animal is climbing the walls of the arena

Return type:

climbing (np.array)