bencher.results.holoview_results.heatmap_result
===============================================

.. py:module:: bencher.results.holoview_results.heatmap_result


Classes
-------

.. autoapisummary::

   bencher.results.holoview_results.heatmap_result.HeatmapResult


Module Contents
---------------

.. py:class:: HeatmapResult(bench_cfg: bencher.bench_cfg.BenchCfg)

   Bases: :py:obj:`bencher.results.holoview_results.holoview_result.HoloviewResult`


   A class for creating heatmap visualizations from benchmark results.

   Heatmaps are effective for visualizing the relationship between two input variables
   and a result variable by using color intensity to represent the result values.
   This class provides methods for generating interactive heatmaps that can display
   additional information when hovering over or selecting points on the heatmap.


   .. py:method:: to_plot(**kwargs) -> panel.panel | None

      Generates a heatmap visualization. See ``to_heatmap`` for parameters.



   .. py:method:: to_heatmap(result_var: param.Parameter | None = None, tap_var=None, tap_container: panel.pane.panel = None, tap_container_direction: panel.Column | panel.Row | None = None, target_dimension=2, override: bool = True, use_tap: bool = _USE_TAP, **kwargs) -> panel.panel | None

      Generates a heatmap visualization from benchmark data.

      :param result_var: The result variable to plot.
      :type result_var: Parameter, optional
      :param tap_var: Variables to display when tapping on heatmap points.
      :param tap_container: Container to hold tapped information.
      :type tap_container: pn.pane.panel, optional
      :param tap_container_direction: Layout direction for tap
                                      containers.
      :type tap_container_direction: pn.Column | pn.Row, optional
      :param target_dimension: Target dimensionality. Defaults to 2.
      :type target_dimension: int, optional
      :param override: Whether to override filter restrictions. Defaults to True.
      :type override: bool, optional
      :param use_tap: Whether to enable tap functionality.
      :type use_tap: bool, optional
      :param \*\*kwargs: Additional keyword arguments passed to the plot rendering.

      :returns: A panel containing the heatmap, or filter match results.
      :rtype: pn.panel | None



   .. py:method:: _pick_xy_axes() -> tuple[str, str]

      Pick x/y axis names, preferring float vars then falling back to cat vars.



   .. py:method:: to_heatmap_ds(dataset: xarray.Dataset, result_var: param.Parameter, **kwargs) -> holoviews.HeatMap | holoviews.HoloMap | None

      Creates a basic heatmap from the provided dataset.

      When over_time is active with multiple time points, creates an hv.HoloMap
      with a slider.

      :param dataset: The dataset containing benchmark results.
      :type dataset: xr.Dataset
      :param result_var: The result variable to plot.
      :type result_var: Parameter
      :param \*\*kwargs: Additional keyword arguments passed to the heatmap options.

      :returns:

                A heatmap visualization, or None if
                    the dataset has fewer than 2 dimensions.
      :rtype: hv.HeatMap | hv.HoloMap | None



   .. py:method:: _to_heatmap_tap_ds(dataset: xarray.Dataset, result_var: param.Parameter, result_var_plots: list[param.Parameter] | None = None, container: panel.pane.panel = None, tap_container_direction: panel.Column | panel.Row | None = None, **kwargs) -> panel.Row

      Creates an interactive heatmap with tap functionality.

      :param dataset: The dataset containing benchmark results.
      :type dataset: xr.Dataset
      :param result_var: The primary result variable to plot.
      :type result_var: Parameter
      :param result_var_plots: Additional result variables
                               to display when a point is tapped.
      :type result_var_plots: list[Parameter], optional
      :param container: Container to display tapped information.
      :type container: pn.pane.panel, optional
      :param tap_container_direction: Layout direction for
                                      tap containers.
      :type tap_container_direction: pn.Column | pn.Row, optional
      :param \*\*kwargs: Additional keyword arguments passed to the heatmap options.

      :returns: A panel row containing the interactive heatmap and tap info.
      :rtype: pn.Row



   .. py:method:: to_heatmap_tap(result_var: param.Parameter, reduce: bencher.results.bench_result_base.ReduceType = ReduceType.AUTO, width=800, height=800, **kwargs)

      Creates a tappable heatmap that shows details when tapped.

      Uses ``hv.streams.Tap`` for static click coordinates rather than
      PointerXY hover tracking.

      :param result_var: The result variable to plot.
      :type result_var: Parameter
      :param reduce: How to reduce the data. Defaults to ReduceType.AUTO.
      :type reduce: ReduceType, optional
      :param width: Width of the plot in pixels. Defaults to 800.
      :type width: int, optional
      :param height: Height of the plot in pixels. Defaults to 800.
      :type height: int, optional
      :param \*\*kwargs: Additional keyword arguments.

      :returns: A layout containing the heatmap and a dynamically updated detail view.
      :rtype: hv.Layout