.. _sphx_glr_auto_examples_region_of_interest:

Region of Interest
==================

Below is a gallery of examples on using regions of interest with HyperSpy signals.



.. raw:: html

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

.. thumbnail-parent-div-open

.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use a SpanROI interactively on a Signal1D.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_SpanROI_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/SpanROI`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">SpanROI on signal axis</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the plot_roi_map function to create interactive maps defined from ROIs in signal space.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_map_signal_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/map_signal`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create Map from ROI in signal space</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use a PolygonROI interactively on a Signal2D.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_PolygonROI_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/PolygonROI`

.. raw:: html

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


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use a RectangularROI to take the sum of an area of the navigation space.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_ROI_navigator_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/ROI_navigator`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Navigator ROI</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Use the plot_roi_map function to create interactive maps defined from a CircleROI in signal space.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_map_signal_circleROI_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/map_signal_circleROI`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Create Map from CircleROI in signal space</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Get interactive fast Fourier transform (FFT) from a subset of a Signal2D using RectangularROI.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_fast_fourier_transform_live_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/fast_fourier_transform_live`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Live FFT</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Combine several PolygonROI.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_combine_PolygonROI_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/combine_PolygonROI`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Combine PolygonROI</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="Interactively extract a line profile (with a certain width) from an image using :py~.api.roi.Line2DROI. Use plot_spectra to plot several line profiles on the same figure. Save a profile data as msa file.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_ExtractLineProfile_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/ExtractLineProfile`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Extract line profile from image interactively</div>
    </div>


.. raw:: html

    <div class="sphx-glr-thumbcontainer" tooltip="This example shows how to integrate a signal using an interactive ROI.">

.. only:: html

  .. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_SpanROI_interactive_sum_thumb.png
    :alt:

  :doc:`/auto_examples/region_of_interest/SpanROI_interactive_sum`

.. raw:: html

      <div class="sphx-glr-thumbnail-title">Interactive integration of one dimensional signal</div>
    </div>


.. thumbnail-parent-div-close

.. raw:: html

    </div>


.. toctree::
   :hidden:

   /auto_examples/region_of_interest/SpanROI
   /auto_examples/region_of_interest/map_signal
   /auto_examples/region_of_interest/PolygonROI
   /auto_examples/region_of_interest/ROI_navigator
   /auto_examples/region_of_interest/map_signal_circleROI
   /auto_examples/region_of_interest/fast_fourier_transform_live
   /auto_examples/region_of_interest/combine_PolygonROI
   /auto_examples/region_of_interest/ExtractLineProfile
   /auto_examples/region_of_interest/SpanROI_interactive_sum