:orphan:
.. _examples-index:
Gallery of Examples
===================
This gallery contains the commented code for short examples illustrating simple
tasks that can be performed with HyperSpy.
.. raw:: html
.. thumbnail-parent-div-open
.. thumbnail-parent-div-close
.. raw:: html
Markers
=======
Gallery of examples on using HyperSpy markers.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_ragged_points_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_ragged_points.py`
.. raw:: html
Ragged Points
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_arrows.py`
.. raw:: html
Arrow markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_vertical_lines_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_vertical_lines.py`
.. raw:: html
Vertical Line Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_circles_color_radius_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_circles_color_radius.py`
.. raw:: html
Circle Markers with Radius Dependent Coloring
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_texts_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_texts.py`
.. raw:: html
Text Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_lines_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_lines.py`
.. raw:: html
Line Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_ragged_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_arrows_ragged.py`
.. raw:: html
Varying number of arrows per navigation position
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_circles_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_circles.py`
.. raw:: html
Circle Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_filled_circles_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_filled_circles.py`
.. raw:: html
Filled Circle Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_rotation_makers_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_rotation_makers.py`
.. raw:: html
Rotation of markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_add_remove_marker_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_add_remove_marker.py`
.. raw:: html
Add/Remove items from existing Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_polygons_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_polygons.py`
.. raw:: html
Polygon Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_ellipses_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_ellipses.py`
.. raw:: html
Ellipse markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_squares_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_squares.py`
.. raw:: html
Square Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_stars_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_stars.py`
.. raw:: html
Star Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_rectangles_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_rectangles.py`
.. raw:: html
Rectangle Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_navigation_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_arrows_navigation.py`
.. raw:: html
Arrow markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_from_signal_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_from_signal.py`
.. raw:: html
Creating Markers from a signal
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_making_inset_images_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_making_inset_images.py`
.. raw:: html
Making Inset Images
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_transforms_and_units_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_Markers_transforms_and_units.py`
.. raw:: html
Transforms and Units
.. thumbnail-parent-div-close
.. raw:: html
Signal Creation
===============
Below is a gallery of examples on creating a signal and plotting.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/create_signal/images/thumb/sphx_glr_from_tabular_data_file_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_create_signal_from_tabular_data_file.py`
.. raw:: html
Creates a signal1D from a text file
.. raw:: html
.. only:: html
.. image:: /auto_examples/create_signal/images/thumb/sphx_glr_line_spectrum_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_create_signal_line_spectrum.py`
.. raw:: html
Creates a line spectrum
.. raw:: html
.. only:: html
.. image:: /auto_examples/create_signal/images/thumb/sphx_glr_from_tabular_data_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_create_signal_from_tabular_data.py`
.. raw:: html
Creates a signal1D from tabular data
.. raw:: html
.. only:: html
.. image:: /auto_examples/create_signal/images/thumb/sphx_glr_1D_image_stack_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_create_signal_1D_image_stack.py`
.. raw:: html
Creates a 3D image
.. raw:: html
.. only:: html
.. image:: /auto_examples/create_signal/images/thumb/sphx_glr_spectrum_image_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_create_signal_spectrum_image.py`
.. raw:: html
Creates a spectrum image
.. raw:: html
.. only:: html
.. image:: /auto_examples/create_signal/images/thumb/sphx_glr_2D_image_stack_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_create_signal_2D_image_stack.py`
.. raw:: html
Creates a 4D image
.. thumbnail-parent-div-close
.. raw:: html
Data Visualization
==================
This gallery shows how to plot data using the convenience functions
:func:`~.api.plot.plot_spectra`, :func:`~.api.plot.plot_images` and
:func:`~.api.plot.plot_signals`.
Unlike the :meth:`~.api.signals.BaseSignal.plot`, these functions
can plot multiple signal together and can be useful to compose figure
comparing signals, etc.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/data_visualization/images/thumb/sphx_glr_compose_figure_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_data_visualization_compose_figure.py`
.. raw:: html
Composing Figure
.. raw:: html
.. only:: html
.. image:: /auto_examples/data_visualization/images/thumb/sphx_glr_specifying_ax_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_data_visualization_specifying_ax.py`
.. raw:: html
Specifying Matplotlib Axis
.. thumbnail-parent-div-close
.. raw:: html
Loading, saving and exporting
=============================
Below is a gallery of examples on loading, saving and exporting data.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/io/images/thumb/sphx_glr_export_single_spectrum_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_io_export_single_spectrum.py`
.. raw:: html
Export single spectrum
.. raw:: html
.. only:: html
.. image:: /auto_examples/io/images/thumb/sphx_glr_convert_color_image_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_io_convert_color_image.py`
.. raw:: html
Adjust contrast and save RGB images
.. thumbnail-parent-div-close
.. raw:: html
Model fitting
=============
Below is a gallery of examples on model fitting.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/model_fitting/images/thumb/sphx_glr_plot_residual_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_model_fitting_plot_residual.py`
.. raw:: html
Plot Residual
.. raw:: html
.. only:: html
.. image:: /auto_examples/model_fitting/images/thumb/sphx_glr_simple_arctan_fit_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_model_fitting_simple_arctan_fit.py`
.. raw:: html
Simple arctan fit
.. thumbnail-parent-div-close
.. raw:: html
Making Custom Layouts for Plots
===============================
Below is a gallery of examples on making simple custom layouts for plotting data
using :class:`matplotlib.figure.SubFigure`.
.. Note::
Plotting data with subfigures is slower than using separates figures.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/plotting/images/thumb/sphx_glr_custom_figure_layout_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_plotting_custom_figure_layout.py`
.. raw:: html
Creating Custom Layouts
.. raw:: html
.. only:: html
.. image:: /auto_examples/plotting/images/thumb/sphx_glr_ROI_insets_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_plotting_ROI_insets.py`
.. raw:: html
ROI Insets
.. thumbnail-parent-div-close
.. raw:: html
Region of Interest
==================
Below is a gallery of examples on using regions of interest with HyperSpy signals.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_SpanROI_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_SpanROI.py`
.. raw:: html
SpanROI on signal axis
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_map_signal_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_map_signal.py`
.. raw:: html
Create Map from ROI in signal space
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_PolygonROI_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_PolygonROI.py`
.. raw:: html
PolygonROI
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_ROI_navigator_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_ROI_navigator.py`
.. raw:: html
Navigator ROI
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_map_signal_circleROI_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_map_signal_circleROI.py`
.. raw:: html
Create Map from CircleROI in signal space
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_fast_fourier_transform_live_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_fast_fourier_transform_live.py`
.. raw:: html
Live FFT
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_combine_PolygonROI_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_combine_PolygonROI.py`
.. raw:: html
Combine PolygonROI
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_ExtractLineProfile_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_ExtractLineProfile.py`
.. raw:: html
Extract line profile from image interactively
.. raw:: html
.. only:: html
.. image:: /auto_examples/region_of_interest/images/thumb/sphx_glr_SpanROI_interactive_sum_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_region_of_interest_SpanROI_interactive_sum.py`
.. raw:: html
Interactive integration of one dimensional signal
.. thumbnail-parent-div-close
.. raw:: html
Simple simulations
==================
Below is a gallery of examples on simulating signals which can be used to test
HyperSpy functionalities
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/simple_simulations/images/thumb/sphx_glr_two_gaussians_thumb.png
:alt:
:ref:`sphx_glr_auto_examples_simple_simulations_two_gaussians.py`
.. raw:: html
Simple simulation (2 Gaussians)
.. thumbnail-parent-div-close
.. raw:: html
.. toctree::
:hidden:
:includehidden:
/auto_examples/Markers/index.rst
/auto_examples/create_signal/index.rst
/auto_examples/data_visualization/index.rst
/auto_examples/io/index.rst
/auto_examples/model_fitting/index.rst
/auto_examples/plotting/index.rst
/auto_examples/region_of_interest/index.rst
/auto_examples/simple_simulations/index.rst
.. only:: html
.. container:: sphx-glr-footer sphx-glr-footer-gallery
.. container:: sphx-glr-download sphx-glr-download-python
:download:`Download all examples in Python source code: auto_examples_python.zip `
.. container:: sphx-glr-download sphx-glr-download-jupyter
:download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip `
.. only:: html
.. rst-class:: sphx-glr-signature
`Gallery generated by Sphinx-Gallery