:orphan:

.. _examples:

========
Examples
========

This page contains short examples demonstrating common tasks using orix. It is broken up
into sections covering specific topics.

For longer in-depth guides, see our :doc:`/tutorials/index`. For descriptions of the
functions, modules, and objects in orix, see the :doc:`/reference/index`.

.. note::

    Making examples is a work in progress. The :doc:`/tutorials/index` represent a
    complete showcase of the existing functionality in orix.


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

Crystal maps
============



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create an empty crystal map of a given shape. By empty, we mean that ...">

.. only:: html

  .. image:: /examples/crystal_maps/images/thumb/sphx_glr_create_empty_map_thumb.png
    :alt:

  :ref:`sphx_glr_examples_crystal_maps_create_empty_map.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create empty crystal map</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to select data in a CrystalMap, obtain a new map from parts of the data ...">

.. only:: html

  .. image:: /examples/crystal_maps/images/thumb/sphx_glr_select_modify_data_thumb.png
    :alt:

  :ref:`sphx_glr_examples_crystal_maps_select_modify_data.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Select and modify data</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Inverse pole figures
====================



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to plot an inverse pole density function (IPDF) rohrer2004distribution t...">

.. only:: html

  .. image:: /examples/inverse_pole_figures/images/thumb/sphx_glr_inverse_pole_density_function_thumb.png
    :alt:

  :ref:`sphx_glr_examples_inverse_pole_figures_inverse_pole_density_function.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Inverse pole density function</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Misorientations
===============


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use from_align_vectors to estimate a misorientation M from two...">

.. only:: html

  .. image:: /examples/misorientations/images/thumb/sphx_glr_misorientation_from_aligning_directions_thumb.png
    :alt:

  :ref:`sphx_glr_examples_misorientations_misorientation_from_aligning_directions.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Misorientation from aligning directions</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Orientations
============


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to use from_align_vectors to estimate an orientation O from two s...">

.. only:: html

  .. image:: /examples/orientations/images/thumb/sphx_glr_orientation_from_aligning_directions_thumb.png
    :alt:

  :ref:`sphx_glr_examples_orientations_orientation_from_aligning_directions.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Orientation from aligning directions</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Plotting
========



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to place different plots in the same figure using orix&#x27; various plot typ...">

.. only:: html

  .. image:: /examples/plotting/images/thumb/sphx_glr_subplots_thumb.png
    :alt:

  :ref:`sphx_glr_examples_plotting_subplots.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Subplots</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use matplotlib event connections &lt;matplotlib:users/explain/figure/eve...">

.. only:: html

  .. image:: /examples/plotting/images/thumb/sphx_glr_interactive_xmap_thumb.png
    :alt:

  :ref:`sphx_glr_examples_plotting_interactive_xmap.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Interactive crystal map plot</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Rotations
=========


.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to sample high-symmetry crystal directions \mathbf{t} = [u, v, w] (or zo...">

.. only:: html

  .. image:: /examples/rotations/images/thumb/sphx_glr_rotating_z_to_high_symmetry_directions_thumb.png
    :alt:

  :ref:`sphx_glr_examples_rotations_rotating_z_to_high_symmetry_directions.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Rotating z-vector to high-symmetry crystal directions</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to sample rotations \mathbf{R} that when rotating the vector \mathbf{v_z...">

.. only:: html

  .. image:: /examples/rotations/images/thumb/sphx_glr_rotations_mapping_fundamental_sector_thumb.png
    :alt:

  :ref:`sphx_glr_examples_rotations_rotations_mapping_fundamental_sector.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Rotations mapping the fundamental sector on S2</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example demonstrates how to combine two rotations R_1 and R_2, i.e. from right to left lik...">

.. only:: html

  .. image:: /examples/rotations/images/thumb/sphx_glr_combine_rotations_thumb.png
    :alt:

  :ref:`sphx_glr_examples_rotations_combine_rotations.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Combining rotations</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>

Stereographic projection
========================



.. raw:: html

    <div class="sphx-glr-thumbnails">

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to draw a Wulff net in the stereographic projection with great and small...">

.. only:: html

  .. image:: /examples/stereographic_projection/images/thumb/sphx_glr_wulff_net_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stereographic_projection_wulff_net.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Wulff net</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to draw proper symmetry operations s (no reflections or inversions).">

.. only:: html

  .. image:: /examples/stereographic_projection/images/thumb/sphx_glr_plot_symmetry_operations_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stereographic_projection_plot_symmetry_operations.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot symmetry operations</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to restrict the stereographic plot to the fundamental sector of one of t...">

.. only:: html

  .. image:: /examples/stereographic_projection/images/thumb/sphx_glr_restrict_to_fundamental_sector_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stereographic_projection_restrict_to_fundamental_sector.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Restrict to fundamental sector</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to add a region in the stereographic projection as a zoomed inset inside...">

.. only:: html

  .. image:: /examples/stereographic_projection/images/thumb/sphx_glr_zoom_inset_region_thumb.png
    :alt:

  :ref:`sphx_glr_examples_stereographic_projection_zoom_inset_region.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Zoom region inset</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /examples/crystal_maps/index.rst
   /examples/inverse_pole_figures/index.rst
   /examples/misorientations/index.rst
   /examples/orientations/index.rst
   /examples/plotting/index.rst
   /examples/rotations/index.rst
   /examples/stereographic_projection/index.rst


.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-gallery

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

      :download:`Download all examples in Python source code: examples_python.zip </examples/examples_python.zip>`

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

      :download:`Download all examples in Jupyter notebooks: examples_jupyter.zip </examples/examples_jupyter.zip>`


.. only:: html

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

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