:orphan:

.. _examples:

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

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

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

.. note::

    Making examples is a work in progress. The topics and examples, and thus the URLs to
    examples, might change between releases. The :doc:`/tutorials/index` represent a
    complete showcase of the existing functionality in kikuchipy.


.. raw:: html

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


.. raw:: html

    </div>

Pattern processing
==================

These examples cover processing of pattern intensities like binning and background
subtraction.


.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to bin EBSD patterns using downsample or HyperSpy&#x27;s rebin (see hyperspy:...">

.. only:: html

  .. image:: /examples/pattern_processing/images/thumb/sphx_glr_pattern_binning_thumb.png
    :alt:

  :ref:`sphx_glr_examples_pattern_processing_pattern_binning.py`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to remove the static background of an EBSD pattern using remove_static_b...">

.. only:: html

  .. image:: /examples/pattern_processing/images/thumb/sphx_glr_static_background_correction_thumb.png
    :alt:

  :ref:`sphx_glr_examples_pattern_processing_static_background_correction.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Static background correction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to remove the dynamic background of an EBSD pattern using remove_dynamic...">

.. only:: html

  .. image:: /examples/pattern_processing/images/thumb/sphx_glr_dynamic_background_correction_thumb.png
    :alt:

  :ref:`sphx_glr_examples_pattern_processing_dynamic_background_correction.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Dynamic background correction</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to average each pattern in a scan with its nearest neighbours using aver...">

.. only:: html

  .. image:: /examples/pattern_processing/images/thumb/sphx_glr_neighbour_pattern_averaging_thumb.png
    :alt:

  :ref:`sphx_glr_examples_pattern_processing_neighbour_pattern_averaging.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Neighbour pattern averaging</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to perform AHE on a simulated pattern and a master pattern. Two identica...">

.. only:: html

  .. image:: /examples/pattern_processing/images/thumb/sphx_glr_adaptive_histogram_equalization_thumb.png
    :alt:

  :ref:`sphx_glr_examples_pattern_processing_adaptive_histogram_equalization.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Adaptive histogram equalization</div>
    </div>


.. raw:: html

    </div>

Reference frames
================

These examples cover use of tools like the :class:`~kikuchipy.detectors.EBSDDetector`
for understanding reference frames relevant to EBSD.


.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to fit a plane to selected projection centers (PCs) using a projective t...">

.. only:: html

  .. image:: /examples/reference_frames/images/thumb/sphx_glr_fit_plane_to_selected_pc_thumb.png
    :alt:

  :ref:`sphx_glr_examples_reference_frames_fit_plane_to_selected_pc.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Fit a plane to selected projection centers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to (robustly) estimate the tilt about the detector X_d axis which brings...">

.. only:: html

  .. image:: /examples/reference_frames/images/thumb/sphx_glr_estimate_tilt_about_detector_xaxis_thumb.png
    :alt:

  :ref:`sphx_glr_examples_reference_frames_estimate_tilt_about_detector_xaxis.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Estimate tilt about the detector x axis</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to (robustly) estimate the tilts about the detector X_d and Z_d axes, wh...">

.. only:: html

  .. image:: /examples/reference_frames/images/thumb/sphx_glr_estimate_tilts_about_detector_xaxis_zaxis_thumb.png
    :alt:

  :ref:`sphx_glr_examples_reference_frames_estimate_tilts_about_detector_xaxis_zaxis.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Estimate tilts about the detector x and z axis</div>
    </div>


.. raw:: html

    </div>

Selecting data
==============

These examples cover selection of data via extraction a subset of the navigation and/or
signal axes.


.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows various ways to crop the navigation axes of an EBSD signal using HyperSpy&#x27;s ...">

.. only:: html

  .. image:: /examples/selecting_data/images/thumb/sphx_glr_crop_navigation_axes_thumb.png
    :alt:

  :ref:`sphx_glr_examples_selecting_data_crop_navigation_axes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Crop navigation axes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows various ways to crop the signal axes of an EBSD signal using HyperSpy&#x27;s isig...">

.. only:: html

  .. image:: /examples/selecting_data/images/thumb/sphx_glr_crop_signal_axes_thumb.png
    :alt:

  :ref:`sphx_glr_examples_selecting_data_crop_signal_axes.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Crop signal axes</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to extract EBSD patterns from positions in a grid evenly spaced in navig...">

.. only:: html

  .. image:: /examples/selecting_data/images/thumb/sphx_glr_extract_patterns_from_grid_thumb.png
    :alt:

  :ref:`sphx_glr_examples_selecting_data_extract_patterns_from_grid.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Extract patterns from a grid</div>
    </div>


.. raw:: html

    </div>

Visualization
=============

These examples cover visualization of Kikuchi patterns and derived maps.


.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows you how to plot a nice and clean image of an EBSD master pattern. More detai...">

.. only:: html

  .. image:: /examples/visualization/images/thumb/sphx_glr_plot_nice_master_pattern_image_thumb.png
    :alt:

  :ref:`sphx_glr_examples_visualization_plot_nice_master_pattern_image.py`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot nice master pattern image</div>
    </div>


.. raw:: html

    </div>


.. toctree::
   :hidden:
   :includehidden:


   /examples/pattern_processing/index.rst
   /examples/reference_frames/index.rst
   /examples/selecting_data/index.rst
   /examples/visualization/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>`_