bencher.results.volume_result
=============================

.. py:module:: bencher.results.volume_result


Classes
-------

.. autoapisummary::

   bencher.results.volume_result.VolumeResult


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

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

   Bases: :py:obj:`bencher.results.bench_result_base.BenchResultBase`


   .. py:method:: to_plot(result_var: param.Parameter | None = None, override: bool = True, **kwargs: Any) -> panel.panel | None

      Generates a 3d volume plot from benchmark data.

      :param result_var: The result variable to plot. If None, uses the default.
      :type result_var: Parameter | None
      :param override: Whether to override filter restrictions. Defaults to True.
      :type override: bool
      :param \*\*kwargs: Additional keyword arguments passed to the plot rendering.
      :type \*\*kwargs: Any

      :returns: A panel containing the volume plot if data is appropriate,
                otherwise returns filter match results.
      :rtype: pn.panel | None



   .. py:method:: to_volume(result_var: param.Parameter | None = None, override: bool = True, target_dimension: int = 3, **kwargs)

      Generates a 3D volume plot from benchmark data.

      This method applies filters to ensure the data is appropriate for a volume plot
      and then passes the filtered data to to_volume_ds for rendering.

      :param result_var: The result variable to plot. If None, uses the default.
      :type result_var: Parameter, optional
      :param override: Whether to override filter restrictions. Defaults to True.
      :type override: bool, optional
      :param target_dimension: The target dimensionality for data filtering. Defaults to 3.
      :type target_dimension: int, optional
      :param \*\*kwargs: Additional keyword arguments passed to the plot rendering.

      :returns:

                A panel containing the volume plot if data is appropriate,
                                        otherwise returns filter match results.
      :rtype: pn.pane.Plotly | None



   .. py:method:: to_volume_ds(dataset: xarray.Dataset, result_var: param.Parameter, width=600, height=600) -> panel.pane.Plotly | None

      Given a benchCfg generate a 3D surface plot
      :returns: A 3d volume plot as a holoview in a pane
      :rtype: pn.pane.Plotly