:orphan:

========
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 id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. thumbnail-parent-div-close

.. raw:: html

    </div>

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

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

.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

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

.. only:: html

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

  :doc:`/examples/pattern_processing/static_background_correction`

.. 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_background.">

.. only:: html

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

  :doc:`/examples/pattern_processing/dynamic_background_correction`

.. 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 bin EBSD patterns using downsample or HyperSpy&#x27;s rebin (see hyperspy:rebin-label for details).">

.. only:: html

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

  :doc:`/examples/pattern_processing/pattern_binning`

.. 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 average each pattern in a scan with its nearest neighbours using average_neighbour_patterns.">

.. only:: html

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

  :doc:`/examples/pattern_processing/neighbour_pattern_averaging`

.. 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 identical simulated patterns, but one projected from the master pattern after AHE has been applied to it, are compared. We&#x27;ll use kikuchipy.signals.EBSDMasterPattern.adaptive_histogram_equalization and the equivalent method for the EBSD class.">

.. only:: html

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

  :doc:`/examples/pattern_processing/adaptive_histogram_equalization`

.. raw:: html

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


.. thumbnail-parent-div-close

.. 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 id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. 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 a distribution of projection/pattern centers (PCs) with the EBSDDetector. See the detector class documentation for further details on the definition of the PC and gnomonic coordinates.">

.. only:: html

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

  :doc:`/examples/reference_frames/plot_distribution_of_projection_centers`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot distribution of projection centers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to plot the projection/pattern center (PC) on an EBSDDetector. See the detector class documentation for further details on the definition of the PC and gnomonic coordinates.">

.. only:: html

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

  :doc:`/examples/reference_frames/plot_projection_center_on_detector`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Plot projection center on the detector</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to crop an EBSDDetector.">

.. only:: html

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

  :doc:`/examples/reference_frames/crop_detector`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Crop an EBSD detector</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to convert between pixel and gnomonic detector coordinates.">

.. only:: html

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

  :doc:`/examples/reference_frames/convert_between_detector_coordinates`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Convert between detector coordinate formats</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to set up an interactive plot showing the side and top view of the microscope as well as the detector plane and the effects of changing detector-sample geometry parameters as well as the crystal orientation.">

.. only:: html

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

  :doc:`/examples/reference_frames/interactive_ebsd_detector_plotter`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Interactive EBSD detector plotter</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to transform column vectors given in the sample reference frame to the detector reference frame using sample_to_detector.">

.. only:: html

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

  :doc:`/examples/reference_frames/rotate_vectors_from_sample_to_detector`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Rotate vectors from sample to detector reference frame</div>
    </div>


.. raw:: html

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

.. only:: html

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

  :doc:`/examples/reference_frames/fit_plane_to_selected_pc`

.. 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 the sample plane normal into coincidence with the detector plane normal (but in the opposite direction) winkelmann2020refined.">

.. only:: html

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

  :doc:`/examples/reference_frames/estimate_tilt_about_detector_xaxis`

.. 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, which bring the sample plane normal into coincidence with the detector plane normal (but in the opposite direction) winkelmann2020refined.">

.. only:: html

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

  :doc:`/examples/reference_frames/estimate_tilts_about_detector_xaxis_zaxis`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to plot multiple views of the detector-sample geometry in a single figure using the EBSDDetector. Both a side view and top view are available.">

.. only:: html

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

  :doc:`/examples/reference_frames/plot_detector_sample_views`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Detector-sample geometry views</div>
    </div>


.. thumbnail-parent-div-close

.. 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 id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. 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 inav slicer and crop method (see hyperspy:signal.indexing for details).">

.. only:: html

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

  :doc:`/examples/selecting_data/crop_navigation_axes`

.. 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 slicer and the crop and crop_signal methods (see hyperspy:signal.indexing for details).">

.. only:: html

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

  :doc:`/examples/selecting_data/crop_signal_axes`

.. 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 navigation space.">

.. only:: html

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

  :doc:`/examples/selecting_data/extract_patterns_from_grid`

.. raw:: html

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


.. thumbnail-parent-div-close

.. raw:: html

    </div>

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

These examples cover visualization of Kikuchi patterns and derived maps.

.. raw:: html

  <div id='sg-tag-list' class='sphx-glr-tag-list'></div>


.. raw:: html

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

.. thumbnail-parent-div-open

.. 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 details are given in the visualization tutorial &lt;/tutorials/visualizing_patterns&gt;.">

.. only:: html

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

  :doc:`/examples/visualization/plot_nice_master_pattern_image`

.. raw:: html

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


.. thumbnail-parent-div-close

.. 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>`_