deepof.annotation_utils.climb_wall

deepof.annotation_utils.climb_wall(arena_type: str, arena: array, pos_dict: DataFrame, tol: float, nose: str, centered_data: 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

• tol (float) – minimum tolerance to report a hit

• nose (str) – indicates the name of the body part representing the nose of the selected animal

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

Returns:

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

Return type:

climbing (np.array)