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

.. only:: html

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

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

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

.. _sphx_glr_auto_examples_Markers_stars.py:


Star Markers
============

.. GENERATED FROM PYTHON SOURCE LINES 8-9

Create a signal

.. GENERATED FROM PYTHON SOURCE LINES 9-19

.. code-block:: Python


    import hyperspy.api as hs
    import matplotlib as mpl
    import numpy as np

    # Create a Signal2D with 2 navigation dimensions
    rng = np.random.default_rng(0)
    data = np.ones((25, 25, 100, 100))
    s = hs.signals.Signal2D(data)








.. GENERATED FROM PYTHON SOURCE LINES 20-22

This first example shows how to draw static stars markers using the matplotlib
StarPolygonCollection

.. GENERATED FROM PYTHON SOURCE LINES 22-35

.. code-block:: Python


    # Define the position of the boxes
    offsets = rng.random((10, 2)) * 100

    # every other star has a size of 50/100
    m = hs.plot.markers.Markers(collection=mpl.collections.StarPolygonCollection,
                                offsets=offsets,
                                numsides=5,
                                color="orange",
                                sizes=(50, 100))
    s.plot()
    s.add_marker(m)




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


    *

      .. image-sg:: /auto_examples/Markers/images/sphx_glr_stars_001.png
         :alt: stars
         :srcset: /auto_examples/Markers/images/sphx_glr_stars_001.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /auto_examples/Markers/images/sphx_glr_stars_002.png
         :alt:  Signal
         :srcset: /auto_examples/Markers/images/sphx_glr_stars_002.png
         :class: sphx-glr-multi-img





.. GENERATED FROM PYTHON SOURCE LINES 36-41

Dynamic Star Markers
######################

This second example shows how to draw dynamic stars markers, whose position
depends on the navigation coordinates

.. GENERATED FROM PYTHON SOURCE LINES 42-60

.. code-block:: Python


    # Create a Signal2D with 2 navigation dimensions
    s2 = hs.signals.Signal2D(data)

    # Create a ragged array of offsets
    offsets = np.empty(s.axes_manager.navigation_shape, dtype=object)
    for ind in np.ndindex(offsets.shape):
        offsets[ind] = rng.random((10, 2)) * 100

    m2 = hs.plot.markers.Markers(collection=mpl.collections.StarPolygonCollection,
                                offsets=offsets,
                                numsides=5,
                                color="blue",
                                sizes=(50, 100))

    s2.plot()
    s2.add_marker(m2)




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


    *

      .. image-sg:: /auto_examples/Markers/images/sphx_glr_stars_003.png
         :alt: stars
         :srcset: /auto_examples/Markers/images/sphx_glr_stars_003.png
         :class: sphx-glr-multi-img

    *

      .. image-sg:: /auto_examples/Markers/images/sphx_glr_stars_004.png
         :alt:  Signal
         :srcset: /auto_examples/Markers/images/sphx_glr_stars_004.png
         :class: sphx-glr-multi-img





.. GENERATED FROM PYTHON SOURCE LINES 61-62

sphinx_gallery_thumbnail_number = 2


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

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


.. _sphx_glr_download_auto_examples_Markers_stars.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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