:py:mod:`mipcandy.data.visualization`
=====================================

.. py:module:: mipcandy.data.visualization

.. autodoc2-docstring:: mipcandy.data.visualization
   :allowtitles:

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

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`visualize2d <mipcandy.data.visualization.visualize2d>`
     - .. autodoc2-docstring:: mipcandy.data.visualization.visualize2d
          :summary:
   * - :py:obj:`_visualize3d_with_pyvista <mipcandy.data.visualization._visualize3d_with_pyvista>`
     - .. autodoc2-docstring:: mipcandy.data.visualization._visualize3d_with_pyvista
          :summary:
   * - :py:obj:`visualize3d <mipcandy.data.visualization.visualize3d>`
     - .. autodoc2-docstring:: mipcandy.data.visualization.visualize3d
          :summary:
   * - :py:obj:`overlay <mipcandy.data.visualization.overlay>`
     - .. autodoc2-docstring:: mipcandy.data.visualization.overlay
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`__LABEL_COLORMAP <mipcandy.data.visualization.__LABEL_COLORMAP>`
     - .. autodoc2-docstring:: mipcandy.data.visualization.__LABEL_COLORMAP
          :summary:

API
~~~

.. py:function:: visualize2d(image: torch.Tensor, *, title: str | None = None, cmap: str | None = None, is_label: bool = False, blocking: bool = False, screenshot_as: str | os.PathLike[str] | None = None) -> None
   :canonical: mipcandy.data.visualization.visualize2d

   .. autodoc2-docstring:: mipcandy.data.visualization.visualize2d

.. py:function:: _visualize3d_with_pyvista(image: numpy.ndarray, title: str | None, cmap: str, screenshot_as: str | os.PathLike[str] | None) -> None
   :canonical: mipcandy.data.visualization._visualize3d_with_pyvista

   .. autodoc2-docstring:: mipcandy.data.visualization._visualize3d_with_pyvista

.. py:data:: __LABEL_COLORMAP
   :canonical: mipcandy.data.visualization.__LABEL_COLORMAP
   :type: list[str]
   :value: ['#ffffff', '#2e4057', '#7a0f1c', '#004f4f', '#9a7b00', '#2c2f38', '#5c136f', '#113f2e', '#8a3b12', ...

   .. autodoc2-docstring:: mipcandy.data.visualization.__LABEL_COLORMAP

.. py:function:: visualize3d(image: torch.Tensor, *, title: str | None = None, cmap: str | list[str] | None = None, max_volume: int = 1000000.0, is_label: bool = False, backend: typing.Literal[auto, matplotlib, pyvista] = 'auto', blocking: bool = False, screenshot_as: str | os.PathLike[str] | None = None) -> None
   :canonical: mipcandy.data.visualization.visualize3d

   .. autodoc2-docstring:: mipcandy.data.visualization.visualize3d

.. py:function:: overlay(image: torch.Tensor, label: torch.Tensor, *, max_label_opacity: float = 0.5, label_colorizer: mipcandy.common.ColorizeLabel | None = ColorizeLabel(batch=False)) -> torch.Tensor
   :canonical: mipcandy.data.visualization.overlay

   .. autodoc2-docstring:: mipcandy.data.visualization.overlay