.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/plotting/ROI_insets.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_plotting_ROI_insets.py>`
        to download the full example code.

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

.. _sphx_glr_auto_examples_plotting_ROI_insets.py:


==========
ROI Insets
==========

ROI's can be powerful tools to help visualize data.  In this case we will define ROI's in hyperspy, sum
the data within the ROI, and then plot the sum as a signal. Using the :class:`matplotlib.figure.SubFigure` class
we can create a custom layout to visualize and interact with the data.

.. Note::
    Plotting data with subfigures is slower than using separates figures.

We can connect these ROI's using the :func:`hyperspy.api.interactive` function which allows us to move the ROI's and see the sum of the underlying data.

.. GENERATED FROM PYTHON SOURCE LINES 15-86



.. image-sg:: /auto_examples/plotting/images/sphx_glr_ROI_insets_001.png
   :alt: ROI insets
   :srcset: /auto_examples/plotting/images/sphx_glr_ROI_insets_001.png
   :class: sphx-glr-single-img





.. code-block:: Python

    import matplotlib.pyplot as plt
    import hyperspy.api as hs
    import numpy as np

    rng = np.random.default_rng()

    fig = plt.figure(figsize=(5, 3))
    gs = fig.add_gridspec(6, 10)
    sub1 = fig.add_subfigure(gs[0:6, 0:6])
    sub2 = fig.add_subfigure(gs[0:2, 6:8])
    sub3 = fig.add_subfigure(gs[2:4, 7:9])
    sub4 = fig.add_subfigure(gs[4:6, 6:8])


    s = hs.signals.Signal2D(rng.random((10, 10, 30, 30)))
    r1 = hs.roi.RectangularROI(1, 1, 3, 3)
    r2 = hs.roi.RectangularROI(4, 4, 6, 6)
    r3 = hs.roi.RectangularROI(3, 7, 5, 9)

    navigator = s.sum(axis=(2, 3)).T  # create a navigator signal
    navigator.plot(fig=sub1, colorbar=False, axes_off=True, title="", plot_indices=False)


    s2 = r1.interactive(s, navigation_signal=navigator, color="red")
    s3 = r2.interactive(s, navigation_signal=navigator, color="g")
    s4 = r3.interactive(s, navigation_signal=navigator, color="y")

    s2_int = s2.sum()
    s3_int = s3.sum()
    s4_int = s4.sum()

    s2_int.plot(fig=sub2, colorbar=False, axes_off=True, title="", plot_indices=False)
    s3_int.plot(fig=sub3, colorbar=False, axes_off=True, title="", plot_indices=False)
    s4_int.plot(fig=sub4, colorbar=False, axes_off=True, title="", plot_indices=False)

    # Connect ROIS
    for s, s_int, roi in zip([s2, s3, s4], [s2_int, s3_int, s4_int],[r1,r2,r3]):
        hs.interactive(
            s.sum,
            event=roi.events.changed,
            recompute_out_event=None,
            out=s_int,
        )

    # Add Borders to the match the color of the ROI

    for signal,color, label  in zip([s2_int, s3_int, s4_int], ["r", "g", "y"], ["b.", "c.", "d."]):
        edge =  hs.plot.markers.Squares(
        offset_transform="axes",
        offsets=(0.5, 0.5),
        units="width",
        widths=1,
        color=color,
        linewidth=5,
        facecolor="none",
        )

        signal.add_marker(edge)

        label = hs.plot.markers.Texts(
        texts=(label,), offsets=[[0.85, 0.85]], offset_transform="axes", sizes=2, color="w"
        )
        signal.add_marker(label)

    # Label the big plot

    label = hs.plot.markers.Texts(
        texts=("a.",), offsets=[[0.9, 0.9]], offset_transform="axes", sizes=10, color="w"
        )
    navigator.add_marker(label)



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

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


.. _sphx_glr_download_auto_examples_plotting_ROI_insets.py:

.. only:: html

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

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

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

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

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

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

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


.. only:: html

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

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