Skip to main content
Ctrl+K
HyperSpy API is changing 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
  • Base Classes

Base Classes#

API of classes, which are not part of the hyperspy.api namespace but are inherited in HyperSpy classes. The signal classes are not expected to be instantiated by users but their methods, which are used by other classes, are documented here.

  • Axes
    • AxesManager
    • BaseDataAxis
    • DataAxis
    • FunctionalDataAxis
    • UniformDataAxis
    • UnitConversion
  • Events
    • Event
    • EventSuppressor
    • Events
  • Machine Learning
    • LearningResults
    • mlpca()
    • ORNMF
    • ornmf()
    • orthomax()
    • ORPCA
    • orpca()
    • rpca_godec()
    • svd_flip_signs()
    • svd_pca()
    • svd_solve()
    • whiten_data()
  • Model
    • BaseModel
    • Model1D
    • Model2D
    • Component
    • Parameter
    • SamFire
  • Signal
    • ModelManager
    • Common Signals
    • Lazy Signals
  • ROI
    • BaseInteractiveROI
    • BaseROI

previous

Signal2D

next

Axes

Show Source

© Copyright 2011-2024, The HyperSpy development team.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.4.