.. 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 ` 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 | 178.08 us [ ] | 0% Completed | 107.99 ms [ ] | 0% Completed | 208.36 ms [ ] | 0% Completed | 308.98 ms [ ] | 0% Completed | 409.30 ms [########################################] | 100% Completed | 509.67 ms [ ] | 0% Completed | 152.92 us [ ] | 0% Completed | 106.92 ms [ ] | 0% Completed | 207.24 ms [ ] | 0% Completed | 307.54 ms [ ] | 0% Completed | 407.85 ms [ ] | 0% Completed | 508.12 ms [ ] | 0% Completed | 608.43 ms [ ] | 0% Completed | 708.71 ms [ ] | 0% Completed | 809.02 ms [########################################] | 100% Completed | 909.38 ms [ ] | 0% Completed | 153.76 us [########################################] | 100% Completed | 103.90 ms [ ] | 0% Completed | 129.75 us [ ] | 0% Completed | 113.65 ms [ ] | 0% Completed | 213.95 ms [ ] | 0% Completed | 314.28 ms [ ] | 0% Completed | 414.58 ms [ ] | 0% Completed | 514.87 ms [ ] | 0% Completed | 615.22 ms [ ] | 0% Completed | 715.66 ms [ ] | 0% Completed | 815.96 ms [ ] | 0% Completed | 916.40 ms [ ] | 0% Completed | 1.02 s [ ] | 0% Completed | 1.12 s [ ] | 0% Completed | 1.22 s [ ] | 0% Completed | 1.32 s [ ] | 0% Completed | 1.42 s [ ] | 0% Completed | 1.52 s [ ] | 0% Completed | 1.62 s [ ] | 0% Completed | 1.72 s [ ] | 0% Completed | 1.82 s [########################################] | 100% Completed | 1.92 s .. 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 | 171.33 us [########################################] | 100% Completed | 106.64 ms [ ] | 0% Completed | 133.18 us [ ] | 0% Completed | 107.69 ms [ ] | 0% Completed | 208.02 ms [ ] | 0% Completed | 308.32 ms [ ] | 0% Completed | 408.63 ms [########################################] | 100% Completed | 508.97 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 8.575 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 ` .. container:: sphx-glr-download sphx-glr-download-python :download:`Download Python source code: masking_vectors.py ` .. only:: html .. rst-class:: sphx-glr-signature `Gallery generated by Sphinx-Gallery `_