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

.. only:: html

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

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

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

.. _sphx_glr_examples_plot_06_random_number_generator.py:


.. _random_number_generator_example:

Controlling Random Number Generation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The generation of random numbers is done through a :func:`numpy.random.Generator`.
The default is :func:`numpy.random.default_rng()`.

.. GENERATED FROM PYTHON SOURCE LINES 10-20

.. code-block:: Python


    import numpy as np
    import pyvista as pv
    from pyvista import examples

    import pyransame

    antarctica = examples.download_antarctica_velocity()
    antarctica.points /= 1000.0  # convert to kilometers








.. GENERATED FROM PYTHON SOURCE LINES 21-22

pyransame stores the generator being used at ``pyransame.rng``

.. GENERATED FROM PYTHON SOURCE LINES 22-25

.. code-block:: Python


    pyransame.rng





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

 .. code-block:: none


    Generator(PCG64) at 0x7F7B777C26C0



.. GENERATED FROM PYTHON SOURCE LINES 26-27

Setup common plotting routine for use later.

.. GENERATED FROM PYTHON SOURCE LINES 27-38

.. code-block:: Python



    def plot_points(points):
        pl = pv.Plotter()
        pl.add_mesh(antarctica, color="tan")
        spheres = points.glyph(geom=pv.Sphere(radius=50), scale=False, orient=False)
        pl.add_mesh(spheres, scalars="ssavelocity", clim=[0, 750])
        pl.view_xy()
        pl.show()









.. GENERATED FROM PYTHON SOURCE LINES 39-40

Sampling twice in succession will lead to different results.

.. GENERATED FROM PYTHON SOURCE LINES 40-44

.. code-block:: Python


    points = pyransame.random_surface_dataset(antarctica, 500)
    plot_points(points)








.. tab-set::



   .. tab-item:: Static Scene



            
     .. image-sg:: /examples/images/sphx_glr_plot_06_random_number_generator_001.png
        :alt: plot 06 random number generator
        :srcset: /examples/images/sphx_glr_plot_06_random_number_generator_001.png
        :class: sphx-glr-single-img
     


   .. tab-item:: Interactive Scene



       .. offlineviewer:: /home/runner/work/pyransame/pyransame/doc/examples/images/sphx_glr_plot_06_random_number_generator_001.vtksz






.. GENERATED FROM PYTHON SOURCE LINES 45-46

Second sampling with slightly different results

.. GENERATED FROM PYTHON SOURCE LINES 46-50

.. code-block:: Python


    points = pyransame.random_surface_dataset(antarctica, 500)
    plot_points(points)








.. tab-set::



   .. tab-item:: Static Scene



            
     .. image-sg:: /examples/images/sphx_glr_plot_06_random_number_generator_002.png
        :alt: plot 06 random number generator
        :srcset: /examples/images/sphx_glr_plot_06_random_number_generator_002.png
        :class: sphx-glr-single-img
     


   .. tab-item:: Interactive Scene



       .. offlineviewer:: /home/runner/work/pyransame/pyransame/doc/examples/images/sphx_glr_plot_06_random_number_generator_002.vtksz






.. GENERATED FROM PYTHON SOURCE LINES 51-53

This time, we will control the random number generation by using a seed to
ensure that the same result is obtained.

.. GENERATED FROM PYTHON SOURCE LINES 53-58

.. code-block:: Python


    pyransame.rng = np.random.default_rng(seed=42)
    points = pyransame.random_surface_dataset(antarctica, 500)
    plot_points(points)








.. tab-set::



   .. tab-item:: Static Scene



            
     .. image-sg:: /examples/images/sphx_glr_plot_06_random_number_generator_003.png
        :alt: plot 06 random number generator
        :srcset: /examples/images/sphx_glr_plot_06_random_number_generator_003.png
        :class: sphx-glr-single-img
     


   .. tab-item:: Interactive Scene



       .. offlineviewer:: /home/runner/work/pyransame/pyransame/doc/examples/images/sphx_glr_plot_06_random_number_generator_003.vtksz






.. GENERATED FROM PYTHON SOURCE LINES 59-60

Second sampling with identical results.

.. GENERATED FROM PYTHON SOURCE LINES 60-64

.. code-block:: Python


    pyransame.rng = np.random.default_rng(seed=42)
    points = pyransame.random_surface_dataset(antarctica, 500)
    plot_points(points)







.. tab-set::



   .. tab-item:: Static Scene



            
     .. image-sg:: /examples/images/sphx_glr_plot_06_random_number_generator_004.png
        :alt: plot 06 random number generator
        :srcset: /examples/images/sphx_glr_plot_06_random_number_generator_004.png
        :class: sphx-glr-single-img
     


   .. tab-item:: Interactive Scene



       .. offlineviewer:: /home/runner/work/pyransame/pyransame/doc/examples/images/sphx_glr_plot_06_random_number_generator_004.vtksz







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

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


.. _sphx_glr_download_examples_plot_06_random_number_generator.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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