HyperSpy Logo
1.7.6

User Guide

  • Introduction
  • Changelog
  • Installing HyperSpy
  • Getting started
  • The Signal class
  • Axes handling
  • Interactive Operations and Region of Interest (ROI)
  • Signal1D Tools
  • Signal2D Tools
  • Data visualization
  • Machine learning
  • Model fitting
  • Electron Energy Loss Spectroscopy
  • Energy-Dispersive X-ray Spectrometry (EDS)
  • Dielectric function tools
  • Electron Holography
  • Loading and saving data
  • Events
  • Working with big data
  • Metadata structure
  • Bibliography

Developer Guide

  • Introduction
  • Using Git and GitHub
  • Running and writing tests
  • Writing documentation
  • Coding style
  • Tips for writing methods that work on lazy signals
  • Speeding up code
  • Writing packages that extend HyperSpy
  • Useful information

API References

  • hyperspy
    • hyperspy package
      • Subpackages
        • hyperspy._components package
        • hyperspy._signals package
        • hyperspy.datasets package
        • hyperspy.docstrings package
        • hyperspy.drawing package
        • hyperspy.io_plugins package
        • hyperspy.learn package
        • hyperspy.misc package
        • hyperspy.models package
        • hyperspy.samfire_utils package
        • hyperspy.utils package
      • Submodules
      • Module contents

Credits and citation

  • Credits
  • Citing HyperSpy
HyperSpy
  • hyperspy
  • hyperspy package
  • hyperspy.learn package
  • View page source

hyperspy.learn package

Submodules

  • hyperspy.learn.mlpca module
    • mlpca()
  • hyperspy.learn.mva module
    • LearningResults
      • LearningResults.crop_decomposition_dimension()
      • LearningResults.load()
      • LearningResults.save()
      • LearningResults.summary()
    • MVA
      • MVA._calculate_recmatrix()
      • MVA._cluster_analysis()
      • MVA._distances_within_cluster()
      • MVA._get_cluster_algorithm()
      • MVA._get_cluster_preprocessing_algorithm()
      • MVA._get_cluster_signal()
      • MVA._get_number_of_components_for_clustering()
      • MVA._scale_data_for_clustering()
      • MVA.blind_source_separation()
      • MVA.cluster_analysis()
      • MVA.decomposition()
      • MVA.estimate_elbow_position()
      • MVA.estimate_number_of_clusters()
      • MVA.get_bss_model()
      • MVA.get_decomposition_model()
      • MVA.get_explained_variance_ratio()
      • MVA.normalize_bss_components()
      • MVA.normalize_decomposition_components()
      • MVA.normalize_poissonian_noise()
      • MVA.plot_cluster_metric()
      • MVA.plot_cumulative_explained_variance_ratio()
      • MVA.plot_explained_variance_ratio()
      • MVA.reverse_bss_component()
      • MVA.reverse_decomposition_component()
      • MVA.undo_treatments()
    • _get_derivative()
    • _normalize_components()
  • hyperspy.learn.ornmf module
    • ORNMF
      • ORNMF.finish()
      • ORNMF.fit()
      • ORNMF.project()
    • _mrdivide()
    • _thresh()
    • ornmf()
  • hyperspy.learn.orthomax module
    • orthomax()
  • hyperspy.learn.rpca module
    • ORPCA
      • ORPCA._initialize_subspace()
      • ORPCA.finish()
      • ORPCA.fit()
      • ORPCA.project()
    • _soft_thresh()
    • orpca()
    • rpca_godec()
  • hyperspy.learn.svd_pca module
    • svd_flip_signs()
    • svd_pca()
    • svd_solve()
  • hyperspy.learn.whitening module
    • whiten_data()

Module contents

Previous Next

© Copyright 2011-2023, The HyperSpy development team.

Built with Sphinx using a theme provided by Read the Docs.