hyperspy.utils package

Submodules

• hyperspy.utils.eds module
• hyperspy.utils.markers module
• hyperspy.utils.material module
• hyperspy.utils.model module
• hyperspy.utils.model_selection module
  • AIC()
  • BIC()
• hyperspy.utils.parallel_pool module
  • ParallelPool
    • ParallelPool.pool
    • ParallelPool.ipython_kwargs
    • ParallelPool.timeout
    • ParallelPool.num_workers
    • ParallelPool.timestep
    • ParallelPool.has_pool
    • ParallelPool.is_ipyparallel
    • ParallelPool.is_multiprocessing
    • ParallelPool.setup()
    • ParallelPool.sleep()
• hyperspy.utils.peakfinders2D module
  • _fast_mean()
  • _fast_std()
  • clean_peaks()
  • find_local_max()
  • find_peaks_dog()
  • find_peaks_log()
  • find_peaks_max()
  • find_peaks_minmax()
  • find_peaks_stat()
  • find_peaks_xc()
  • find_peaks_zaefferer()
• hyperspy.utils.plot module
• hyperspy.utils.roi module
• hyperspy.utils.samfire module

Module contents

Functions that operate on Signal instances and other goodies.

stack

Stack Signal instances.

Subpackages:

material

Tools related to the material under study.

plot

Tools for plotting.

eds

Tools for energy-dispersive X-ray data analysis.

hyperspy.utils.print_known_signal_types()

Print all known signal_types

This includes signal_types from all installed packages that extend HyperSpy.

Examples

>>> hs.print_known_signal_types()
+--------------------+---------------------+--------------------+----------+
|    signal_type     |       aliases       |     class name     | package  |
+--------------------+---------------------+--------------------+----------+
| DielectricFunction | dielectric function | DielectricFunction | hyperspy |
|      EDS_SEM       |                     |   EDSSEMSpectrum   | hyperspy |
|      EDS_TEM       |                     |   EDSTEMSpectrum   | hyperspy |
|        EELS        |       TEM EELS      |    EELSSpectrum    | hyperspy |
|      hologram      |                     |   HologramImage    | hyperspy |
|      MySignal      |                     |      MySignal      | hspy_ext |
+--------------------+---------------------+--------------------+----------+