.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_gallery/image_volume/image_volume_render_modes.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download__gallery_image_volume_image_volume_render_modes.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__gallery_image_volume_image_volume_render_modes.py:


Volume modes
============

View a volume using different rendering modes.

.. GENERATED FROM PYTHON SOURCE LINES 7-86



.. image-sg:: /_gallery/image_volume/images/sphx_glr_image_volume_render_modes_001.webp
   :alt: image volume render modes
   :srcset: /_gallery/image_volume/images/sphx_glr_image_volume_render_modes_001.webp
   :class: sphx-glr-single-img


.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    /opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/pygfx/objects/_ruler.py:400: RuntimeWarning: divide by zero encountered in divide
      screen_full = (ndc_full[:, :2] / ndc_full[:, 3:4]) * half_canvas_size
    /opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/pygfx/objects/_ruler.py:400: RuntimeWarning: invalid value encountered in divide
      screen_full = (ndc_full[:, :2] / ndc_full[:, 3:4]) * half_canvas_size
    /opt/hostedtoolcache/Python/3.12.11/x64/lib/python3.12/site-packages/pygfx/objects/_ruler.py:412: RuntimeWarning: invalid value encountered in divide
      screen_sel = (ndc_sel[:, :2] / ndc_sel[:, 3:4]) * half_canvas_size
    /home/runner/work/fastplotlib/fastplotlib/fastplotlib/graphics/features/_base.py:18: UserWarning: casting float64 array to float32
      warn(f"casting {array.dtype} array to float32")







|

.. code-block:: Python


    # test_example = true

    import numpy as np
    import fastplotlib as fpl
    from fastplotlib.ui import EdgeWindow
    from fastplotlib.graphics.features import VOLUME_RENDER_MODES
    import imageio.v3 as iio
    from imgui_bundle import imgui

    voldata = iio.imread("imageio:stent.npz").astype(np.float32)

    figure = fpl.Figure(
        cameras="3d",
        controller_types="orbit",
        size=(700, 560)
    )

    figure[0, 0].add_image_volume(voldata, name="vol-img")

    # add an hlut tool
    hlut = fpl.HistogramLUTTool(voldata, figure[0, 0]["vol-img"])

    figure[0, 0].docks["right"].size = 80
    figure[0, 0].docks["right"].controller.enabled = False
    figure[0, 0].docks["right"].add_graphic(hlut)
    figure[0, 0].docks["right"].auto_scale(maintain_aspect=False)


    class GUI(EdgeWindow):
        def __init__(self, figure, title="Render options", location="right", size=300):
            super().__init__(figure, title=title, location=location, size=size)

            # reference to the graphic for convenience
            self.graphic: fpl.ImageVolumeGraphic = self._figure[0, 0]["vol-img"]

        def update(self):
            imgui.text("Switch render mode:")

            # add buttons to switch between modes
            for mode in VOLUME_RENDER_MODES.keys():
                if imgui.button(mode):
                    self.graphic.mode = mode

            # add sliders to change iso rendering properties
            if self.graphic.mode == "iso":
                _, self.graphic.threshold = imgui.slider_float(
                    "threshold", v=self.graphic.threshold, v_max=255, v_min=1,
                )
                _, self.graphic.step_size = imgui.slider_float(
                    "step_size", v=self.graphic.step_size, v_max=10.0, v_min=0.1,
                )
                _, self.graphic.substep_size = imgui.slider_float(
                    "substep_size", v=self.graphic.substep_size, v_max=10.0, v_min=0.1,
                )
                _, self.graphic.emissive = imgui.color_picker3("emissive color", col=self.graphic.emissive.rgb)

            if self.graphic.mode == "slice":
                imgui.text("Select plane defined by:\nax + by + cz + d = 0")
                _, a = imgui.slider_float("a", v=self.graphic.plane[0], v_min=-1, v_max=1.0)
                _, b = imgui.slider_float("b", v=self.graphic.plane[1], v_min=-1, v_max=1.0)
                _, c = imgui.slider_float("c", v=self.graphic.plane[2], v_min=-1, v_max=1.0)

                largest_dim = max(self.graphic.data.value.shape)
                _, d = imgui.slider_float("d", v=self.graphic.plane[3], v_min=0, v_max=largest_dim * 2)

                self.graphic.plane = (a, b, c, d)

    gui = GUI(figure=figure)
    figure.add_gui(gui)

    figure.show()


    # NOTE: fpl.loop.run() should not be used for interactive sessions
    # See the "JupyterLab and IPython" section in the user guide
    if __name__ == "__main__":
        print(__doc__)
        fpl.loop.run()


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.652 seconds)


.. _sphx_glr_download__gallery_image_volume_image_volume_render_modes.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: image_volume_render_modes.py <image_volume_render_modes.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: image_volume_render_modes.zip <image_volume_render_modes.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_