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

.. only:: html

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

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

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

.. _sphx_glr__gallery_validation_validate_volume.py:


Volume and Volume Slice Rendering
=================================

Render a volume and volume slices. You should see:

* On the left: a raycasted volume fit snugly inside a red box.
* On the right: three orthogonal slices inside - and through the middle of - a green box.
* The volume has its corners darker and its very center is brighter.

.. GENERATED FROM PYTHON SOURCE LINES 11-78



.. image-sg:: /_gallery/validation/images/sphx_glr_validate_volume_001.webp
   :alt: validate volume
   :srcset: /_gallery/validation/images/sphx_glr_validate_volume_001.webp
   :class: sphx-glr-single-img





.. code-block:: Python



    import numpy as np
    from rendercanvas.auto import RenderCanvas, loop
    import pygfx as gfx


    canvas = RenderCanvas()
    renderer = gfx.renderers.WgpuRenderer(canvas)

    # Prepare a very small data volume. The data is integer and not uint8,
    # so its not interpolated (a wgpu restriction). In this case this is intended.
    voldata = np.ones((3, 3, 3), np.int16) * 200
    voldata[1:-1, :, :] = 600
    voldata[:, 1:-1, :] = 600
    voldata[:, :, 1:-1] = 600
    voldata[1, 1, 1] = 800

    # Create a texture, (wrapped in a geometry) for it
    geo = gfx.Geometry(grid=gfx.Texture(voldata, dim=3))

    # Prepare two 3x3x3 boxes to indicate the proper position
    box1 = gfx.Mesh(
        gfx.box_geometry(3.1, 3.1, 3.1),
        gfx.MeshBasicMaterial(color=(1, 0, 0, 1), wireframe=True, wireframe_thickness=1),
    )
    box2 = gfx.Mesh(
        gfx.box_geometry(3.1, 3.1, 3.1),
        gfx.MeshBasicMaterial(color=(0, 1, 0, 1), wireframe=True, wireframe_thickness=1),
    )

    # In scene1 we show a raycasted volume
    scene1 = gfx.Scene()
    vol = gfx.Volume(geo, gfx.VolumeMipMaterial(clim=(0, 2000)))
    vol.local.position = (-1, -1, -1)
    scene1.add(vol, box1)

    # In scene2 we show volume slices
    scene2 = gfx.Scene()
    slice1 = gfx.Volume(geo, gfx.VolumeSliceMaterial(clim=(0, 1000), plane=(0, 0, 1, 0)))
    slice2 = gfx.Volume(geo, gfx.VolumeSliceMaterial(clim=(0, 1000), plane=(0, 1, 0, 0)))
    slice3 = gfx.Volume(geo, gfx.VolumeSliceMaterial(clim=(0, 1000), plane=(1, 0, 0, 0)))
    for slice in (slice1, slice2, slice3):
        slice.local.position = (-1, -1, -1)
    scene2.add(slice1, slice2, slice3, box2)

    # Prepare a camera so we can see the result in 3D
    camera = gfx.PerspectiveCamera(90, 16 / 9, depth_range=(0.1, 2000))
    camera.local.position = (3, 3, 1)
    camera.look_at((0, 1, 0))


    def animate():
        w, h = canvas.get_logical_size()
        renderer.render(
            scene1, camera, rect=(0.0 * w, 0.0 * h, 0.5 * w, 1.0 * h), flush=False
        )
        renderer.render(
            scene2, camera, rect=(0.5 * w, 0.0 * h, 0.5 * w, 1.0 * h), flush=False
        )
        renderer.flush()


    canvas.request_draw(animate)

    if __name__ == "__main__":
        loop.run()


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

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


.. _sphx_glr_download__gallery_validation_validate_volume.py:

.. only:: html

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

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: validate_volume.ipynb <validate_volume.ipynb>`

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

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

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

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


.. only:: html

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

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

.. only:: html

    Interactive example
    -------------------

    Try this example in your browser using Pyodide. Might not work with all examples and all devices. Check the output and your browser's console for details.

    .. raw:: html

        <iframe src="./../pyodide.html#validate_volume.py"></iframe>