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

.. only:: html

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

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

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

.. _sphx_glr_examples_pattern_processing_static_background_correction.py:


============================
Static background correction
============================

This example shows how to remove the static background of an EBSD pattern using
:meth:`~kikuchipy.signals.EBSD.remove_static_background`.

More details are given in the
:doc:`pattern processing tutorial </tutorials/pattern_processing>`.

.. GENERATED FROM PYTHON SOURCE LINES 32-33

Imports.

.. GENERATED FROM PYTHON SOURCE LINES 33-37

.. code-block:: Python

    import matplotlib.pyplot as plt

    import kikuchipy as kp








.. GENERATED FROM PYTHON SOURCE LINES 38-40

Load low resolution Ni patterns and check that the background pattern
is stored with the signal.

.. GENERATED FROM PYTHON SOURCE LINES 40-45

.. code-block:: Python

    s = kp.data.nickel_ebsd_small()
    print(s.static_background)

    s2 = s.remove_static_background(inplace=False)





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

 .. code-block:: none

    [[84 87 90 ... 27 29 30]
     [87 90 93 ... 27 28 30]
     [92 94 97 ... 39 28 29]
     ...
     [80 82 84 ... 36 30 26]
     [79 80 82 ... 28 26 26]
     [76 78 80 ... 26 26 25]]

      0%|          | 0/2 [00:00<?, ?it/s]
    100%|██████████| 2/2 [00:00<00:00, 2078.96it/s]




.. GENERATED FROM PYTHON SOURCE LINES 46-47

Plot pattern before and after correction and the intensity histograms.

.. GENERATED FROM PYTHON SOURCE LINES 47-55

.. code-block:: Python

    patterns = [s.inav[0, 0].data, s2.inav[0, 0].data]
    fig, axes = plt.subplots(2, 2, height_ratios=[3, 1.5], layout="tight")
    for ax, pattern, title in zip(axes[0], patterns, ["Raw", "Static"]):
        ax.imshow(pattern, cmap="gray")
        ax.set_title(title)
        ax.axis("off")
    for ax, pattern in zip(axes[1], patterns):
        ax.hist(pattern.ravel(), bins=100)



.. image-sg:: /examples/pattern_processing/images/sphx_glr_static_background_correction_001.png
   :alt: Raw, Static
   :srcset: /examples/pattern_processing/images/sphx_glr_static_background_correction_001.png
   :class: sphx-glr-single-img






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

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


.. _sphx_glr_download_examples_pattern_processing_static_background_correction.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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