Skip to main content
Ctrl+K
HyperSpy API has changed in version 2.0, see the release notes!

HyperSpy

  • User Guide
  • Examples
  • Reference
  • Get Help
  • Release Notes
  • Contribute
  • Tutorial
  • GitHub
  • Gitter
  • HyperSpy
  • User Guide
  • Examples
  • Reference
  • Get Help
  • Release Notes
  • Contribute
  • Tutorial
  • GitHub
  • Gitter
  • HyperSpy

Section Navigation

Metadata

  • Metadata structure

API Reference

  • hyperspy.api
  • hyperspy.api.data
  • hyperspy.api.model
    • components1D
    • components2D
  • hyperspy.api.plot
    • hyperspy.api.plot.markers
  • hyperspy.api.roi
  • hyperspy.api.samfire
    • hyperspy.api.samfire.fit_tests
    • hyperspy.api.samfire.global_strategies
    • hyperspy.api.samfire.local_strategies
  • hyperspy.api.signals
    • BaseSignal
    • ComplexSignal
    • ComplexSignal1D
    • ComplexSignal2D
    • Signal1D
    • Signal2D
  • Base Classes
    • Axes
    • Events
    • Machine Learning
    • Model
      • BaseModel
      • Model1D
      • Model2D
      • Component
      • Parameter
      • SamFire
    • Signal
      • ModelManager
      • CommonSignal1D
      • CommonSignal2D
      • LazyComplexSignal
      • LazyComplexSignal1D
      • LazyComplexSignal2D
      • LazySignal
      • LazySignal1D
      • LazySignal2D
    • ROI
  • Utils
  • Reference

Reference#

Metadata

  • Metadata structure
    • General
    • Sample
    • Signal
    • _Internal_parameters
    • Functions to handle the metadata

API Reference

  • hyperspy.api
    • get_configuration_directory_path()
    • interactive()
    • load()
    • print_known_signal_types()
    • set_log_level()
    • stack()
    • transpose()
  • hyperspy.api.data
    • atomic_resolution_image()
    • luminescence_signal()
    • two_gaussians()
    • wave_image()
  • hyperspy.api.model
    • components1D
    • components2D
  • hyperspy.api.plot
    • hyperspy.api.plot.markers
    • plot_histograms()
    • plot_images()
    • plot_roi_map()
    • plot_signals()
    • plot_spectra()
  • hyperspy.api.roi
    • CircleROI
    • Line2DROI
    • Point1DROI
    • Point2DROI
    • PolygonROI
    • RectangularROI
    • SpanROI
    • combine_rois()
    • mask_from_rois()
  • hyperspy.api.samfire
    • hyperspy.api.samfire.fit_tests
    • hyperspy.api.samfire.global_strategies
    • hyperspy.api.samfire.local_strategies
    • SamfirePool
  • hyperspy.api.signals
  • Base Classes
    • Axes
    • Events
    • Machine Learning
    • Model
    • Signal
    • ROI
  • Utils
    • DictionaryTreeBrowser
    • TupleSA
    • export_to_dictionary()
    • peakfinders2D

previous

Simple simulation (2 Gaussians)

next

Metadata structure

This Page

  • Show Source

© Copyright 2011-2025, The HyperSpy development team.

Created using Sphinx 8.2.1.

Built with the PyData Sphinx Theme 0.16.1.