deepof.visuals.plot_arena

deepof.visuals.plot_arena(coordinates: deepof_coordinates, center: str, color: str, ax: Any, key: str, roi_number: int | None = None)

Plot the arena in the given canvas.

Parameters:

• coordinates (coordinates) – deepof Coordinates object.

• center (str) – Name of the body part to which the positions will be centered. If false, the raw data is returned; if ‘arena’ (default), coordinates are centered in the pitch.

• color (str) – color of the displayed arena.

• ax (Any) – axes where to plot the arena.

• str (key) – key of the animal to plot with optional “all of them” (if key==”average”).

• int (roi_number) – number of a roi, if given