.. _sphx_glr_auto_examples_Markers:

.. _gallery.markers:

Markers
=======

Gallery of examples on using HyperSpy markers.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="As for ragged signals, the number of markers at each position can vary and this is done by passing a ragged array to the constructor of the markers.">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_ragged_points_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/ragged_points`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ragged Points</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Arrow markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/arrows`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Arrow markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Vertical Line Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_vertical_lines_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/vertical_lines`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Vertical Line Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to draw circle with the color of the circle scaling with the radius of the circle">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_circles_color_radius_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/circles_color_radius`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Circle Markers with Radius Dependent Coloring</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Text Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_texts_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/texts`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Text Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Line  Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_lines_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/lines`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Line  Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Varying number of arrows per navigation position">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_ragged_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/arrows_ragged`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Varying number of arrows per navigation position</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Circle Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_circles_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/circles`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Circle Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Filled Circle Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_filled_circles_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/filled_circles`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Filled Circle Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how markers are rotated.">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_rotation_makers_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/rotation_makers`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Rotation of markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to add or remove marker from an existing collection. This is done by setting the parameters (offsets, sizes, etc.) of the collection.">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_add_remove_marker_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/add_remove_marker`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Add/Remove items from existing Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Polygon  Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_polygons_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/polygons`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Polygon  Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Ellipse markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_ellipses_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/ellipses`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Ellipse markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Square Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_squares_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/squares`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Square Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Star Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_stars_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/stars`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Star Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Rectangle Markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_rectangles_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/rectangles`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Rectangle Markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Arrow markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_navigation_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/arrows_navigation`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Arrow markers</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to create markers from a signal. This is useful for creating lazy markers from some operation such as peak finding on a signal. Here we show how to create markers from a simple map function which finds the maximum value and plots a marker at that position.">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_from_signal_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/from_signal`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Creating Markers from a signal</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to make images that overlay the main images.  These can be images overlaid using some king of transparency or make an inset image.  It can also be useful for something like making something like a circular color bar to show orientation.">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_making_inset_images_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/making_inset_images`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Making Inset Images</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to use both the offset_transform and ```transforms`` parameters for markers">

.. only:: html

  .. image:: /auto_examples/Markers/images/thumb/sphx_glr_transforms_and_units_thumb.png
    :alt:

  :doc:`/auto_examples/Markers/transforms_and_units`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Transforms and Units</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/Markers/ragged_points
   /auto_examples/Markers/arrows
   /auto_examples/Markers/vertical_lines
   /auto_examples/Markers/circles_color_radius
   /auto_examples/Markers/texts
   /auto_examples/Markers/lines
   /auto_examples/Markers/arrows_ragged
   /auto_examples/Markers/circles
   /auto_examples/Markers/filled_circles
   /auto_examples/Markers/rotation_makers
   /auto_examples/Markers/add_remove_marker
   /auto_examples/Markers/polygons
   /auto_examples/Markers/ellipses
   /auto_examples/Markers/squares
   /auto_examples/Markers/stars
   /auto_examples/Markers/rectangles
   /auto_examples/Markers/arrows_navigation
   /auto_examples/Markers/from_signal
   /auto_examples/Markers/making_inset_images
   /auto_examples/Markers/transforms_and_units