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

.. only:: html

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

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

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

.. _sphx_glr_tutorials_b_fundamentals_e05_3d_visualization.py:


3D Visualization: Interactive Model and Custom Plots
=======================================================

A tour of gempy_viewer's 3D plotting options

This tutorial builds a faulted graben model with topography, then goes through
``plot_3d``'s main options: the full model, the input data alone, the solid lithology
volume versus the layer-boundary surfaces, and a scalar field. It finishes by
overlaying custom 3D data (boreholes) on top of a ``plot_3d`` result.

.. GENERATED FROM PYTHON SOURCE LINES 14-22

.. code-block:: Python

    import numpy as np
    import pyvista as pv

    import gempy as gp
    import gempy_viewer as gpv

    np.random.seed(1234)








.. GENERATED FROM PYTHON SOURCE LINES 23-28

Model setup
-----------
This model is a graben: two parallel normal faults offsetting the same stack of
stratigraphic layers, producing a down-dropped block between them -- a distinctly
3D structure that's worth looking at from more than one angle.

.. GENERATED FROM PYTHON SOURCE LINES 30-57

.. code-block:: Python

    data_path = 'https://raw.githubusercontent.com/cgre-aachen/gempy_data/master/'
    path_to_data = data_path + "/data/input_data/lisa_models/"

    geo_model = gp.create_geomodel(
        project_name="Graben",
        extent=[0, 2000, 0, 2000, 0, 1600],
        resolution=[50, 50, 50],
        refinement=6,
        importer_helper=gp.data.ImporterHelper(
            path_to_orientations=path_to_data + "foliations7.csv",
            path_to_surface_points=path_to_data + "interfaces7.csv",
            hash_surface_points="8c72af50fc56389b620c6458a6af23915b121b5e655b3ce179a790636dc529a5",
            hash_orientations="87cf30b08b5be03b38c5e6d288fa7bb8855263704efb62c7c3cd77673eaae96d"
        )
    )

    gp.map_stack_to_surfaces(
        gempy_model=geo_model,
        mapping_object={
            "Fault_1"     : 'Fault_1',
            "Fault_2"     : 'Fault_2',
            "Strat_Series": ('Sandstone', 'Siltstone', 'Shale', 'Sandstone_2', 'Schist', 'Gneiss')
        }
    )

    gp.set_is_fault(geo_model, ['Fault_1', 'Fault_2'])





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

 .. code-block:: none

    Surface points hash:  8c72af50fc56389b620c6458a6af23915b121b5e655b3ce179a790636dc529a5
    Orientations hash:  87cf30b08b5be03b38c5e6d288fa7bb8855263704efb62c7c3cd77673eaae96d


.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">

            <table>
              <tr><td>Structural Groups:</td><td>
        <table style="border-left:1.2px solid black;>
          <tr><th colspan="2"><b>StructuralGroup:</b></th></tr>
          <tr><td>Name:</td><td>Fault_1</td></tr>
          <tr><td>Structural Relation:</td><td>StackRelationType.FAULT</td></tr>
          <tr><td>Elements:</td><td>
        <table width="50%" style="border-left:15px solid #527682;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Fault_1</td></tr>
        </table>
            </td></tr>
        </table>
            <br>
        <table style="border-left:1.2px solid black;>
          <tr><th colspan="2"><b>StructuralGroup:</b></th></tr>
          <tr><td>Name:</td><td>Fault_2</td></tr>
          <tr><td>Structural Relation:</td><td>StackRelationType.FAULT</td></tr>
          <tr><td>Elements:</td><td>
        <table width="50%" style="border-left:15px solid #527682;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Fault_2</td></tr>
        </table>
            </td></tr>
        </table>
            <br>
        <table style="border-left:1.2px solid black;>
          <tr><th colspan="2"><b>StructuralGroup:</b></th></tr>
          <tr><td>Name:</td><td>Strat_Series</td></tr>
          <tr><td>Structural Relation:</td><td>StackRelationType.ERODE</td></tr>
          <tr><td>Elements:</td><td>
        <table width="50%" style="border-left:15px solid #728f02;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Sandstone</td></tr>
        </table>
            <br>
        <table width="50%" style="border-left:15px solid #b271d0;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Siltstone</td></tr>
        </table>
            <br>
        <table width="50%" style="border-left:15px solid #5DA629;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Shale</td></tr>
        </table>
            <br>
        <table width="50%" style="border-left:15px solid #443988;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Sandstone_2</td></tr>
        </table>
            <br>
        <table width="50%" style="border-left:15px solid #ff3f20;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Schist</td></tr>
        </table>
            <br>
        <table width="50%" style="border-left:15px solid #ffbe00;">
          <tr><th colspan="2"><b>StructuralElement:</b></th></tr>
          <tr><td>Name:</td><td>Gneiss</td></tr>
        </table>
            </td></tr>
        </table>
            </td></tr>
              <tr><td>Fault Relations:</td><td><table style="border-collapse: collapse; table-layout: fixed;"><th></th><th style="transform: rotate(-35deg); height:150px; vertical-align: bottom; text-align: center;">Fault_1</th><th style="transform: rotate(-35deg); height:150px; vertical-align: bottom; text-align: center;">Fault_2</th><th style="transform: rotate(-35deg); height:150px; vertical-align: bottom; text-align: center;">Strat_Seri...</th><tr><th>Fault_1</th><td style="background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></td><td style="background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></td><td style="background-color: #527682; width: 20px; height: 20px; border: 1px solid black;"></td></tr><tr><th>Fault_2</th><td style="background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></td><td style="background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></td><td style="background-color: #527682; width: 20px; height: 20px; border: 1px solid black;"></td></tr><tr><th>Strat_Series</th><td style="background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></td><td style="background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></td><td style="background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></td></tr></table></td></tr>
              <tr><td></td><td>
            <table>
              <tr>
                <td><div style="display: inline-block; background-color: #527682; width: 20px; height: 20px; border: 1px solid black;"></div> True</td>
                <td><div style="display: inline-block; background-color: #FFB6C1; width: 20px; height: 20px; border: 1px solid black;"></div> False</td>
              </tr>
            </table>
            </td></tr>
            </table>
        
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 58-60

A random topography gives the 3D view a real surface to drape the geological map
over, and something for the boreholes to start from later on:

.. GENERATED FROM PYTHON SOURCE LINES 62-71

.. code-block:: Python

    gp.set_topography_from_random(
        grid=geo_model.grid,
        fractal_dimension=1.2,
        d_z=np.array([1000, 1600]),
        topography_resolution=np.array([50, 50])
    )

    gp.compute_model(geo_model)





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

 .. code-block:: none

    Active grids: GridTypes.DENSE|TOPOGRAPHY|NONE
    Setting Backend To: AvailableBackends.PYTORCH
    GPU enabled. Using device: cuda
    GPU device count: 1
    Current GPU device: 0
    Chunking done: 19 chunks
    Chunking done: 21 chunks
    Chunking done: 10 chunks


.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <b>Solutions:</b> 6 Octree Levels, 8 DualContouringMeshes
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 72-78

Plotting the model
--------------------
``plot_3d`` opens a real interactive 3D view -- rotate, zoom, and pan it like any
other PyVista plot. With no other arguments it shows the lithology volume, the
layer-boundary surfaces, the input data, and -- since this model now has a
topography -- the geological map draped over it:

.. GENERATED FROM PYTHON SOURCE LINES 80-82

.. code-block:: Python

    gpv.plot_3d(geo_model)




.. image-sg:: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_001.png
   :alt: e05 3d visualization
   :srcset: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_001.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7f3eea0b3770>



.. GENERATED FROM PYTHON SOURCE LINES 83-88

Data only
~~~~~~~~~
Set ``show_lith=False`` and ``show_boundaries=False`` to see just the input data:
surface points as spheres and orientations as arrows, both colored per structural
element, with no surfaces or topography in the way:

.. GENERATED FROM PYTHON SOURCE LINES 90-92

.. code-block:: Python

    gpv.plot_3d(geo_model, show_lith=False, show_boundaries=False, show_data=True, show_topography=False)




.. image-sg:: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_002.png
   :alt: e05 3d visualization
   :srcset: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_002.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7f3eea0b2350>



.. GENERATED FROM PYTHON SOURCE LINES 93-98

Volume vs. surfaces
~~~~~~~~~~~~~~~~~~~~
``show_lith`` and ``show_boundaries`` control two independent representations of the
same model. ``show_lith`` renders the solid, semi-transparent lithology volume --
useful for seeing the layering through the outside of the block:

.. GENERATED FROM PYTHON SOURCE LINES 100-102

.. code-block:: Python

    gpv.plot_3d(geo_model, show_lith=True, show_boundaries=False, show_data=False, show_topography=False)




.. image-sg:: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_003.png
   :alt: e05 3d visualization
   :srcset: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_003.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7f3eea0b3770>



.. GENERATED FROM PYTHON SOURCE LINES 103-105

``show_boundaries`` instead renders just the layer-boundary surfaces on their own,
with nothing filling the space between them:

.. GENERATED FROM PYTHON SOURCE LINES 107-109

.. code-block:: Python

    gpv.plot_3d(geo_model, show_lith=False, show_boundaries=True, show_data=False, show_topography=False)




.. image-sg:: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_004.png
   :alt: e05 3d visualization
   :srcset: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_004.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7f3eea0b2350>



.. GENERATED FROM PYTHON SOURCE LINES 110-117

Scalar field
~~~~~~~~~~~~
As in the 2D tutorial, gempy solves one implicit scalar field per structural series.
In 3D it's addressed by name rather than index: ``active_scalar_field='sf_N'``, where
``N`` is the series' position in ``map_stack_to_surfaces`` (0-indexed). This model has
three series -- ``sf_0`` (``Fault_1``), ``sf_1`` (``Fault_2``), and ``sf_2``
(``Strat_Series``, the stratigraphic layers, the more interesting one to look at):

.. GENERATED FROM PYTHON SOURCE LINES 119-127

.. code-block:: Python

    gpv.plot_3d(
        geo_model,
        active_scalar_field='sf_2',
        show_scalar=True,
        show_lith=False,
        show_topography=False
    )




.. image-sg:: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_005.png
   :alt: e05 3d visualization
   :srcset: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_005.png
   :class: sphx-glr-single-img


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

 .. code-block:: none


    <gempy_viewer.modules.plot_3d.vista.GemPyToVista object at 0x7f3eea0b3770>



.. GENERATED FROM PYTHON SOURCE LINES 128-137

Overlaying custom data: boreholes in 3D
------------------------------------------
``plot_3d`` returns a ``GemPyToVista`` object exposing the underlying PyVista
``Plotter`` as ``.p`` -- once retrieved, adding custom 3D geometry on top is plain
PyVista, the same idea as overlaying a borehole on a 2D section. Passing ``show=False``
builds the plot without displaying it yet, so custom geometry can be added first; the
final ``.show()`` then opens the same real interactive view as every other plot in
this tutorial, boreholes included. Each borehole below is a vertical line from the
model's top down to its own depth, drawn as a tube with a sphere at the collar:

.. GENERATED FROM PYTHON SOURCE LINES 139-158

.. code-block:: Python

    p = gpv.plot_3d(geo_model, show=False)

    z_top = geo_model.grid.regular_grid.extent[5]
    boreholes = [
        {'name': 'Borehole A', 'xy': (600, 600), 'z_bottom': 400, 'color': 'black'},
        {'name': 'Borehole B', 'xy': (1000, 1000), 'z_bottom': 100, 'color': 'firebrick'},
        {'name': 'Borehole C', 'xy': (1400, 1400), 'z_bottom': 700, 'color': 'darkblue'},
    ]
    for bh in boreholes:
        x, y = bh['xy']
        collar = (x, y, z_top)
        bottom = (x, y, bh['z_bottom'])
        tube = pv.Line(collar, bottom).tube(radius=15)
        p.p.add_mesh(tube, color=bh['color'])
        p.p.add_mesh(pv.Sphere(radius=25, center=collar), color=bh['color'])

    p.p.show()

    # sphinx_gallery_thumbnail_number = -1



.. image-sg:: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_006.png
   :alt: e05 3d visualization
   :srcset: /tutorials/b_fundamentals/images/sphx_glr_e05_3d_visualization_006.png
   :class: sphx-glr-single-img






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

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


.. _sphx_glr_download_tutorials_b_fundamentals_e05_3d_visualization.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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