deepof.visuals.heatmap

deepof.visuals.heatmap(dframe: DataFrame, bodyparts: List, xlim: tuple | None = None, ylim: tuple | None = None, title: str | None = None, mask: ndarray | None = None, save: str = False, dpi: int = 200, ax: Any | None = None, **kwargs) → figure

Return a heatmap of the movement of a specific bodypart in the arena.

If more than one bodypart is passed, it returns one subplot for each.

Parameters:

• dframe (pandas.DataFrame) – table_dict value with info to plot bodyparts (List): bodyparts to represent (at least 1)

• xlim (float) – limits of the x-axis

• ylim (float) – limits of the y-axis

• title (str) – title of the figure

• mask (np.ndarray) – mask to apply to the heatmap across time

• save (str) – if provided, saves the figure to the specified file.

• dpi (int) – dots per inch of the figure to create.

• ax (plt.AxesSubplot) – axes where to plot the current figure. If not provided, new figure will be created.

Returns:

figure with the specified characteristics

Return type:

heatmaps (plt.figure)