deepof.arena_utils.arena_parameter_extraction

deepof.arena_utils.arena_parameter_extraction(frame: ndarray, arena_type: str) → array

Return x,y position of the center, the lengths of the major and minor axes, and the angle of the recognised arena.

Parameters:

• frame (np.ndarray) – numpy.ndarray representing an individual frame of a video

• arena_type (str) – Type of arena to be used. Must be either “circular” or “polygonal”.

Returns:

center_coordinates (tuple): (x,y) coordinates of the center of the ellipse.

axes_length (tuple): (a,b) semi-major and semi-minor axes of the ellipse. ellipse_angle (float): Angle of the ellipse.

ELIF arena_type==”polygonal”

np.ndarray: (x,y) coordinates of all points of the polygon

Return type:

IF arena_type==”circular”