deepof.visuals.plot_heatmaps

deepof.visuals.plot_heatmaps(coordinates: deepof_coordinates, bodyparts: list, center: str = 'arena', align: str | None = None, exp_condition: str | None = None, condition_value: str | None = None, display_arena: bool = True, xlim: float | None = None, ylim: float | None = None, save: bool = False, experiment_id: int = 'average', bin_size: int | None = None, bin_index: int | None = None, dpi: int = 100, ax: Any | None = None, show: bool = True, **kwargs) → figure

Plot heatmaps of the specified body parts (bodyparts) of the specified animal (i).

Parameters:

  • coordinates (coordinates) – deepof Coordinates object.

  • bodyparts (list) – list of body parts to plot.

  • 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.

  • align (str) – Selects the body part to which later processes will align the frames with (see preprocess in table_dict documentation).

  • exp_condition (str) – Experimental condition to plot base filters on.

  • condition_value (str) – Experimental condition value to plot. If available, it filters the experiments to keep only those whose condition value matches the given string in the provided exp_condition.

  • display_arena (bool) – whether to plot a dashed line with an overlying arena perimeter. Defaults to True.

  • xlim (float) – x-axis limits.

  • ylim (float) – y-axis limits.

  • save (str) – if provided, the figure is saved to the specified path.

  • experiment_id (str) – index of the animal to plot.

  • bin_size (int) – bin size for time filtering.

  • bin_index (int) – index of the bin of size bin_size to select along the time dimension.

  • dpi (int) – resolution of the figure.

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

  • show (bool) – whether to show the created figure. If False, returns al axes.

Returns:

figure with the specified characteristics

Return type:

heatmaps (plt.figure)