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

.. only:: html

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

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

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

.. _sphx_glr_examples_vectors_masking_vectors.py:


Diffraction Vectors to Mask
===========================

This example shows how to take a set of vectors and create a mask
from a set of circles around each vector. Multiplying by the original signal
will remove all the signal except for the circles around the vectors.

.. GENERATED FROM PYTHON SOURCE LINES 9-24

.. code-block:: Python


    import pyxem as pxm
    import hyperspy.api as hs

    s = pxm.data.tilt_boundary_data()
    s.calibration.center = None

    s.axes_manager[2].scale = 0.3
    temp = s.template_match_disk(disk_r=5, subtract_min=False)  # Just right
    vectors = temp.get_diffraction_vectors(threshold_abs=0.4, min_distance=5)

    mask = vectors.to_mask(disk_r=7)
    masked_s = s * mask
    masked_s.plot()




.. rst-class:: sphx-glr-horizontal


    *

      .. image-sg:: /examples/vectors/images/sphx_glr_masking_vectors_001.png
         :alt: masking vectors
         :srcset: /examples/vectors/images/sphx_glr_masking_vectors_001.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /examples/vectors/images/sphx_glr_masking_vectors_002.png
         :alt:  Signal
         :srcset: /examples/vectors/images/sphx_glr_masking_vectors_002.png
         :class: sphx-glr-multi-img


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

 .. code-block:: none


    [                                        ] | 0% Completed | 146.43 us
    [                                        ] | 0% Completed | 100.48 ms
    [                                        ] | 0% Completed | 200.87 ms
    [                                        ] | 0% Completed | 301.38 ms
    [########################################] | 100% Completed | 401.75 ms

    [                                        ] | 0% Completed | 146.35 us
    [                                        ] | 0% Completed | 100.45 ms
    [                                        ] | 0% Completed | 200.95 ms
    [                                        ] | 0% Completed | 301.29 ms
    [                                        ] | 0% Completed | 401.67 ms
    [########################################] | 100% Completed | 502.01 ms

    [                                        ] | 0% Completed | 145.54 us
    [########################################] | 100% Completed | 100.49 ms

    [                                        ] | 0% Completed | 155.20 us
    [                                        ] | 0% Completed | 100.55 ms
    [                                        ] | 0% Completed | 200.90 ms
    [                                        ] | 0% Completed | 301.30 ms
    [                                        ] | 0% Completed | 401.63 ms
    [                                        ] | 0% Completed | 502.05 ms
    [                                        ] | 0% Completed | 602.67 ms
    [                                        ] | 0% Completed | 703.16 ms
    [                                        ] | 0% Completed | 803.79 ms
    [########################################] | 100% Completed | 904.17 ms




.. GENERATED FROM PYTHON SOURCE LINES 25-28

Selecting One Position
----------------------
We can also just select one position and create a mask from that.

.. GENERATED FROM PYTHON SOURCE LINES 28-32

.. code-block:: Python


    masked_s = s * mask.inav[0, 0]
    masked_s.plot()




.. rst-class:: sphx-glr-horizontal


    *

      .. image-sg:: /examples/vectors/images/sphx_glr_masking_vectors_003.png
         :alt: masking vectors
         :srcset: /examples/vectors/images/sphx_glr_masking_vectors_003.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /examples/vectors/images/sphx_glr_masking_vectors_004.png
         :alt:  Signal
         :srcset: /examples/vectors/images/sphx_glr_masking_vectors_004.png
         :class: sphx-glr-multi-img





.. GENERATED FROM PYTHON SOURCE LINES 33-37

Removing Vectors
----------------
We can also remove the vectors from the signal by inverting the mask
and multiplying by the original signal.

.. GENERATED FROM PYTHON SOURCE LINES 37-43

.. code-block:: Python


    vectors_filtered = vectors.filter_magnitude(1, 15)
    mask = vectors_filtered.to_mask(disk_r=9)
    masked_s = s * ~mask
    masked_s.plot()




.. rst-class:: sphx-glr-horizontal


    *

      .. image-sg:: /examples/vectors/images/sphx_glr_masking_vectors_005.png
         :alt: masking vectors
         :srcset: /examples/vectors/images/sphx_glr_masking_vectors_005.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /examples/vectors/images/sphx_glr_masking_vectors_006.png
         :alt:  Signal
         :srcset: /examples/vectors/images/sphx_glr_masking_vectors_006.png
         :class: sphx-glr-multi-img


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

 .. code-block:: none


    [                                        ] | 0% Completed | 152.21 us
    [########################################] | 100% Completed | 100.53 ms

    [                                        ] | 0% Completed | 160.63 us
    [                                        ] | 0% Completed | 100.66 ms
    [                                        ] | 0% Completed | 201.12 ms
    [########################################] | 100% Completed | 301.48 ms




.. GENERATED FROM PYTHON SOURCE LINES 44-45

sphinx_gallery_thumbnail_number = 6


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

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


.. _sphx_glr_download_examples_vectors_masking_vectors.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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