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

.. only:: html

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

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

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

.. _sphx_glr__gallery_misc_cursors.py:


Cursor tool
===========

Example with multiple subplots and an interactive cursor that marks the same position in each subplot.
Default crosshair mode.

.. GENERATED FROM PYTHON SOURCE LINES 8-48



.. image-sg:: /_gallery/misc/images/sphx_glr_cursors_001.webp
   :alt: cursors
   :srcset: /_gallery/misc/images/sphx_glr_cursors_001.webp
   :class: sphx-glr-single-img


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

 .. code-block:: none

    /home/runner/work/fastplotlib/fastplotlib/fastplotlib/graphics/features/_base.py:18: UserWarning: casting float64 array to float32
      warn(f"casting {array.dtype} array to float32")







|

.. code-block:: Python


    # test_example = False

    import numpy as np
    import fastplotlib as fpl
    import imageio.v3 as iio


    # get some data
    img1 = iio.imread("imageio:camera.png")
    img2 = iio.imread("imageio:wikkie.png")
    scatter_data = np.random.normal(loc=256, scale=(50), size=(500)).reshape(250, 2)
    line_data = np.random.rand(100, 2) * 512

    # create a figure
    figure = fpl.Figure(shape=(2, 2), size=(700, 750))

    # plot data
    figure[0, 0].add_image(img1, cmap="viridis")
    figure[0, 1].add_image(img2)
    figure[1, 0].add_scatter(scatter_data, sizes=5, colors="r")
    figure[1, 1].add_line(line_data, colors="r")

    # creator a cursor in crosshair mode
    cursor = fpl.Cursor(color="w")

    # add all subplots to the cursor
    for subplot in figure:
        cursor.add_subplot(subplot)

    # you can also set the cursor position programmatically
    cursor.position = (256, 256)

    figure.show()

    # NOTE: fpl.loop.run() should not be used for interactive sessions
    # See the "JupyterLab and IPython" section in the user guide
    if __name__ == "__main__":
        print(__doc__)
        fpl.loop.run()


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

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


.. _sphx_glr_download__gallery_misc_cursors.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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