hyperspy package
Subpackages
- hyperspy._components package
- Submodules
- hyperspy._components.arctan module
- hyperspy._components.bleasdale module
- hyperspy._components.doniach module
- hyperspy._components.eels_arctan module
- hyperspy._components.eels_cl_edge module
- hyperspy._components.eels_double_power_law module
- hyperspy._components.eels_vignetting module
- hyperspy._components.error_function module
- hyperspy._components.exponential module
- hyperspy._components.expression module
- hyperspy._components.gaussian module
- hyperspy._components.gaussian2d module
- hyperspy._components.gaussianhf module
- hyperspy._components.heaviside module
- hyperspy._components.logistic module
- hyperspy._components.lorentzian module
- hyperspy._components.offset module
- hyperspy._components.pes_core_line_shape module
- hyperspy._components.pes_see module
- hyperspy._components.pes_voigt module
- hyperspy._components.polynomial module
- hyperspy._components.polynomial_deprecated module
- hyperspy._components.power_law module
- hyperspy._components.rc module
- hyperspy._components.scalable_fixed_pattern module
- hyperspy._components.skew_normal module
- hyperspy._components.split_voigt module
- hyperspy._components.voigt module
- hyperspy._components.volume_plasmon_drude module
- Module contents
- Submodules
- hyperspy._signals package
- Submodules
- hyperspy._signals.common_signal1d module
- hyperspy._signals.common_signal2d module
- hyperspy._signals.complex_signal module
- hyperspy._signals.complex_signal1d module
- hyperspy._signals.complex_signal2d module
- hyperspy._signals.dielectric_function module
- hyperspy._signals.eds module
- hyperspy._signals.eds_sem module
- hyperspy._signals.eds_tem module
- hyperspy._signals.eels module
- hyperspy._signals.hologram_image module
- hyperspy._signals.lazy module
- hyperspy._signals.signal1d module
- hyperspy._signals.signal2d module
- Module contents
- Submodules
- hyperspy.datasets package
- hyperspy.docstrings package
- hyperspy.drawing package
- Subpackages
- Submodules
- hyperspy.drawing.figure module
- hyperspy.drawing.image module
- hyperspy.drawing.marker module
- hyperspy.drawing.mpl_he module
- hyperspy.drawing.mpl_hie module
- hyperspy.drawing.mpl_hse module
- hyperspy.drawing.signal module
- hyperspy.drawing.signal1d module
- hyperspy.drawing.tiles module
- hyperspy.drawing.utils module
- hyperspy.drawing.widget module
- hyperspy.drawing.widgets module
- Module contents
- hyperspy.io_plugins package
- Submodules
- hyperspy.io_plugins._hierarchical module
- hyperspy.io_plugins.blockfile module
- hyperspy.io_plugins.bruker module
- hyperspy.io_plugins.dens module
- hyperspy.io_plugins.digital_micrograph module
- hyperspy.io_plugins.edax module
- hyperspy.io_plugins.emd module
- hyperspy.io_plugins.empad module
- hyperspy.io_plugins.fei module
- hyperspy.io_plugins.hspy module
- hyperspy.io_plugins.image module
- hyperspy.io_plugins.impulse module
- hyperspy.io_plugins.jeol module
- hyperspy.io_plugins.mrc module
- hyperspy.io_plugins.mrcz module
- hyperspy.io_plugins.msa module
- hyperspy.io_plugins.netcdf module
- hyperspy.io_plugins.nexus module
- hyperspy.io_plugins.phenom module
- hyperspy.io_plugins.protochips module
- hyperspy.io_plugins.ripple module
- hyperspy.io_plugins.semper_unf module
- hyperspy.io_plugins.sur module
- hyperspy.io_plugins.tiff module
- hyperspy.io_plugins.tvips module
- hyperspy.io_plugins.usid_hdf5 module
- hyperspy.io_plugins.zspy module
- Module contents
- Submodules
- hyperspy.learn package
- hyperspy.misc package
- Subpackages
- Submodules
- hyperspy.misc.array_tools module
- hyperspy.misc.axis_tools module
- hyperspy.misc.config_dir module
- hyperspy.misc.date_time_tools module
- hyperspy.misc.elements module
- hyperspy.misc.example_signals_loading module
- hyperspy.misc.export_dictionary module
- hyperspy.misc.hist_tools module
- hyperspy.misc.ipython_tools module
- hyperspy.misc.label_position module
- hyperspy.misc.lowess_smooth module
- hyperspy.misc.material module
- hyperspy.misc.math_tools module
- hyperspy.misc.model_tools module
- hyperspy.misc.physics_tools module
- hyperspy.misc.rgb_tools module
- hyperspy.misc.signal_tools module
- hyperspy.misc.slicing module
- hyperspy.misc.test_utils module
- hyperspy.misc.tv_denoise module
- hyperspy.misc.utils module
- Module contents
- hyperspy.models package
- hyperspy.samfire_utils package
- Subpackages
- Submodules
- hyperspy.samfire_utils.fit_tests module
- hyperspy.samfire_utils.global_strategies module
- hyperspy.samfire_utils.local_strategies module
- hyperspy.samfire_utils.samfire_kernel module
- hyperspy.samfire_utils.samfire_pool module
- hyperspy.samfire_utils.samfire_worker module
- hyperspy.samfire_utils.strategy module
- Module contents
- 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
- hyperspy.utils.parallel_pool module
- hyperspy.utils.peakfinders2D module
- hyperspy.utils.plot module
- hyperspy.utils.roi module
- hyperspy.utils.samfire module
- Module contents
- Submodules
Submodules
- hyperspy.Release module
- hyperspy._lazy_signals module
- hyperspy.api module
- hyperspy.api_nogui module
- hyperspy.axes module
- hyperspy.component module
- hyperspy.components1d module
- hyperspy.components2d module
- hyperspy.conftest module
- hyperspy.decorators module
- hyperspy.defaults_parser module
- hyperspy.events module
- hyperspy.exceptions module
- hyperspy.extensions module
- hyperspy.interactive module
- hyperspy.io module
- hyperspy.logger module
- hyperspy.model module
- hyperspy.roi module
- hyperspy.samfire module
- hyperspy.signal module
- hyperspy.signal_tools module
- hyperspy.signals module
- hyperspy.ui_registry module
Module contents
HyperSpy: a multi-dimensional data analysis package for Python
Documentation is available in the docstrings and online at http://hyperspy.org/hyperspy-doc/current/index.html.
All public packages, functions and classes are in api
. All
other packages and modules are for internal consumption and should not be
needed for data analysis.
When starting HyperSpy using the hyperspy
script (e.g. by executing
hyperspy
in a console, using the context menu entries or using the links in
the Start Menu
, the api
package is imported in the user
namespace as hs
, i.e. by executing the following:
>>> import hyperspy.api as hs
(Note that code snippets are indicated by three greater-than signs)
We recommend to import the HyperSpy API as above also when doing it manually.
The docstring examples assume that hyperspy.api
has been imported as hs
,
numpy
as np
and matplotlib.pyplot
as plt
.
More details in the api
docstring.