: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:
:doc:`/auto_examples/Markers/ragged_points`
.. raw:: html
Ragged Points
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_thumb.png
:alt:
:doc:`/auto_examples/Markers/arrows`
.. raw:: html
Arrow markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_vertical_lines_thumb.png
:alt:
:doc:`/auto_examples/Markers/vertical_lines`
.. raw:: html
Vertical Line Markers
.. raw:: html
.. 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
Circle Markers with Radius Dependent Coloring
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_texts_thumb.png
:alt:
:doc:`/auto_examples/Markers/texts`
.. raw:: html
Text Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_lines_thumb.png
:alt:
:doc:`/auto_examples/Markers/lines`
.. raw:: html
Line Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_ragged_thumb.png
:alt:
:doc:`/auto_examples/Markers/arrows_ragged`
.. 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:
:doc:`/auto_examples/Markers/circles`
.. raw:: html
Circle Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_filled_circles_thumb.png
:alt:
:doc:`/auto_examples/Markers/filled_circles`
.. raw:: html
Filled Circle Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_rotation_makers_thumb.png
:alt:
:doc:`/auto_examples/Markers/rotation_makers`
.. raw:: html
Rotation of markers
.. raw:: html
.. 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
Add/Remove items from existing Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_polygons_thumb.png
:alt:
:doc:`/auto_examples/Markers/polygons`
.. raw:: html
Polygon Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_ellipses_thumb.png
:alt:
:doc:`/auto_examples/Markers/ellipses`
.. raw:: html
Ellipse markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_squares_thumb.png
:alt:
:doc:`/auto_examples/Markers/squares`
.. raw:: html
Square Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_stars_thumb.png
:alt:
:doc:`/auto_examples/Markers/stars`
.. raw:: html
Star Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_rectangles_thumb.png
:alt:
:doc:`/auto_examples/Markers/rectangles`
.. raw:: html
Rectangle Markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_arrows_navigation_thumb.png
:alt:
:doc:`/auto_examples/Markers/arrows_navigation`
.. raw:: html
Arrow markers
.. raw:: html
.. only:: html
.. image:: /auto_examples/Markers/images/thumb/sphx_glr_from_signal_thumb.png
:alt:
:doc:`/auto_examples/Markers/from_signal`
.. 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:
:doc:`/auto_examples/Markers/making_inset_images`
.. raw:: html
Making Inset Images
.. raw:: html
.. 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
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:
:doc:`/auto_examples/create_signal/from_tabular_data_file`
.. 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:
:doc:`/auto_examples/create_signal/line_spectrum`
.. 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:
:doc:`/auto_examples/create_signal/from_tabular_data`
.. 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:
:doc:`/auto_examples/create_signal/1D_image_stack`
.. raw:: html
Creates a 3D image
.. raw:: html
.. only:: html
.. image:: /auto_examples/create_signal/images/thumb/sphx_glr_spectrum_image_thumb.png
:alt:
:doc:`/auto_examples/create_signal/spectrum_image`
.. 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:
:doc:`/auto_examples/create_signal/2D_image_stack`
.. 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:
:doc:`/auto_examples/data_visualization/compose_figure`
.. raw:: html
Composing Figure
.. raw:: html
.. only:: html
.. image:: /auto_examples/data_visualization/images/thumb/sphx_glr_specifying_ax_thumb.png
:alt:
:doc:`/auto_examples/data_visualization/specifying_ax`
.. raw:: html
Specifying Matplotlib Axis
.. raw:: html
.. only:: html
.. image:: /auto_examples/data_visualization/images/thumb/sphx_glr_signal_normalisation_thumb.png
:alt:
:doc:`/auto_examples/data_visualization/signal_normalisation`
.. raw:: html
Signal normalisation
.. thumbnail-parent-div-close
.. raw:: html
Extensions
==========
This gallery of examples is relevant to users interested in developping HyperSpy
extensions and illustrates some of the HyperSpy implementions and patterns.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/extensions/images/thumb/sphx_glr_model_convolution_steps_thumb.png
:alt:
:doc:`/auto_examples/extensions/model_convolution_steps`
.. raw:: html
Component convolution
.. raw:: html
.. only:: html
.. image:: /auto_examples/extensions/images/thumb/sphx_glr_model_convolution_thumb.png
:alt:
:doc:`/auto_examples/extensions/model_convolution`
.. raw:: html
Implementation of a model supporting convolution of components
.. 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:
:doc:`/auto_examples/io/export_single_spectrum`
.. raw:: html
Export single spectrum
.. raw:: html
.. only:: html
.. image:: /auto_examples/io/images/thumb/sphx_glr_convert_color_image_thumb.png
:alt:
:doc:`/auto_examples/io/convert_color_image`
.. 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:
:doc:`/auto_examples/model_fitting/plot_residual`
.. raw:: html
Plot Residual
.. raw:: html
.. only:: html
.. image:: /auto_examples/model_fitting/images/thumb/sphx_glr_simple_arctan_fit_thumb.png
:alt:
:doc:`/auto_examples/model_fitting/simple_arctan_fit`
.. 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:
:doc:`/auto_examples/plotting/custom_figure_layout`
.. raw:: html
Creating Custom Layouts
.. raw:: html
.. only:: html
.. image:: /auto_examples/plotting/images/thumb/sphx_glr_ROI_insets_thumb.png
:alt:
:doc:`/auto_examples/plotting/ROI_insets`
.. raw:: html
ROI Insets
.. thumbnail-parent-div-close
.. raw:: html
Processing
==========
Below is a gallery of examples on signal processing.
.. raw:: html
.. thumbnail-parent-div-open
.. raw:: html
.. only:: html
.. image:: /auto_examples/processing/images/thumb/sphx_glr_baseline_removal_thumb.png
:alt:
:doc:`/auto_examples/processing/baseline_removal`
.. raw:: html
Baseline Removal
.. 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:
:doc:`/auto_examples/region_of_interest/SpanROI`
.. 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:
:doc:`/auto_examples/region_of_interest/map_signal`
.. 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:
:doc:`/auto_examples/region_of_interest/PolygonROI`
.. raw:: html
PolygonROI
.. raw:: html
.. 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
Navigator ROI
.. raw:: html
.. 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
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:
:doc:`/auto_examples/region_of_interest/fast_fourier_transform_live`
.. raw:: html
Live FFT
.. raw:: html
.. 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
Combine PolygonROI
.. raw:: html
.. 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
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:
:doc:`/auto_examples/region_of_interest/SpanROI_interactive_sum`
.. 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:
:doc:`/auto_examples/simple_simulations/two_gaussians`
.. 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/extensions/index.rst
/auto_examples/io/index.rst
/auto_examples/model_fitting/index.rst
/auto_examples/plotting/index.rst
/auto_examples/processing/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