hyperspy package¶
Subpackages¶
- hyperspy._components package
- Submodules
- hyperspy._components.arctan module
- hyperspy._components.bleasdale 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.polynomial module
- hyperspy._components.power_law module
- hyperspy._components.rc module
- hyperspy._components.scalable_fixed_pattern 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
- hyperspy.drawing._markers package
- Submodules
- hyperspy.drawing._markers.horizontal_line module
- hyperspy.drawing._markers.horizontal_line_segment module
- hyperspy.drawing._markers.line_segment module
- hyperspy.drawing._markers.point module
- hyperspy.drawing._markers.rectangle module
- hyperspy.drawing._markers.text module
- hyperspy.drawing._markers.vertical_line module
- hyperspy.drawing._markers.vertical_line_segment module
- Module contents
- Submodules
- hyperspy.drawing._widgets package
- Submodules
- hyperspy.drawing._widgets.circle module
- hyperspy.drawing._widgets.horizontal_line module
- hyperspy.drawing._widgets.label module
- hyperspy.drawing._widgets.line2d module
- hyperspy.drawing._widgets.range module
- hyperspy.drawing._widgets.rectangles module
- hyperspy.drawing._widgets.scalebar module
- hyperspy.drawing._widgets.vertical_line module
- Module contents
- Submodules
- hyperspy.drawing._markers package
- 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
- Subpackages
- hyperspy.external package
- hyperspy.io_plugins package
- Submodules
- 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.fei module
- hyperspy.io_plugins.hspy module
- hyperspy.io_plugins.image module
- hyperspy.io_plugins.mrc module
- hyperspy.io_plugins.mrcz module
- hyperspy.io_plugins.msa module
- hyperspy.io_plugins.netcdf module
- hyperspy.io_plugins.protochips module
- hyperspy.io_plugins.ripple module
- hyperspy.io_plugins.semper_unf module
- hyperspy.io_plugins.tiff module
- hyperspy.io_plugins.unbcf_fast module
- Module contents
- Submodules
- hyperspy.learn package
- hyperspy.misc package
- Subpackages
- Submodules
- hyperspy.misc.array_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.ipython_tools module
- hyperspy.misc.material module
- hyperspy.misc.math_tools module
- hyperspy.misc.physical_constants 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.tests package
- Subpackages
- hyperspy.tests.axes package
- hyperspy.tests.component package
- Submodules
- hyperspy.tests.component.test_component module
- hyperspy.tests.component.test_component_active_array module
- hyperspy.tests.component.test_component_set_parameters module
- hyperspy.tests.component.test_components module
- hyperspy.tests.component.test_components2D module
- hyperspy.tests.component.test_gaussianhf module
- Module contents
- Submodules
- hyperspy.tests.datasets package
- hyperspy.tests.drawing package
- Submodules
- hyperspy.tests.drawing.test_figure module
- hyperspy.tests.drawing.test_mpl_testing_setup module
- hyperspy.tests.drawing.test_plot_markers module
- hyperspy.tests.drawing.test_plot_model module
- hyperspy.tests.drawing.test_plot_model1d module
- hyperspy.tests.drawing.test_plot_mva module
- hyperspy.tests.drawing.test_plot_roi_widgets module
- hyperspy.tests.drawing.test_plot_signal module
- hyperspy.tests.drawing.test_plot_signal1d module
- hyperspy.tests.drawing.test_plot_signal2d module
- hyperspy.tests.drawing.test_plot_signal_tools module
- hyperspy.tests.drawing.test_plot_widgets module
- hyperspy.tests.drawing.test_utils module
- Module contents
- Submodules
- hyperspy.tests.io package
- Submodules
- hyperspy.tests.io.generate_dm_testing_files module
- hyperspy.tests.io.test_blockfile module
- hyperspy.tests.io.test_bruker module
- hyperspy.tests.io.test_dens module
- hyperspy.tests.io.test_dm3 module
- hyperspy.tests.io.test_dm_stackbuilder_plugin module
- hyperspy.tests.io.test_edax module
- hyperspy.tests.io.test_emd module
- hyperspy.tests.io.test_fei module
- hyperspy.tests.io.test_hdf5 module
- hyperspy.tests.io.test_image module
- hyperspy.tests.io.test_io module
- hyperspy.tests.io.test_mrcz module
- hyperspy.tests.io.test_msa module
- hyperspy.tests.io.test_protochips module
- hyperspy.tests.io.test_ripple module
- hyperspy.tests.io.test_semper_unf module
- hyperspy.tests.io.test_tiff module
- Module contents
- Submodules
- hyperspy.tests.misc package
- Submodules
- hyperspy.tests.misc.test_arraytools module
- hyperspy.tests.misc.test_date_time_tools module
- hyperspy.tests.misc.test_fei_stream_readers module
- hyperspy.tests.misc.test_image_tools module
- hyperspy.tests.misc.test_math_tools module
- hyperspy.tests.misc.test_rgbtools module
- hyperspy.tests.misc.test_test_utils module
- hyperspy.tests.misc.test_utils module
- Module contents
- Submodules
- hyperspy.tests.model package
- Submodules
- hyperspy.tests.model.test_chi_squared module
- hyperspy.tests.model.test_edsmodel module
- hyperspy.tests.model.test_eelsmodel module
- hyperspy.tests.model.test_fancy_indexing module
- hyperspy.tests.model.test_fit_component module
- hyperspy.tests.model.test_model module
- hyperspy.tests.model.test_model_as_dictionary module
- hyperspy.tests.model.test_model_selection_criteria module
- hyperspy.tests.model.test_model_storing module
- hyperspy.tests.model.test_parameter module
- hyperspy.tests.model.test_set_parameter_state module
- hyperspy.tests.model.test_set_parameter_value module
- Module contents
- Submodules
- hyperspy.tests.mva package
- hyperspy.tests.samfire package
- Submodules
- hyperspy.tests.samfire.test_goodness_of_fit_tests module
- hyperspy.tests.samfire.test_histogram_segmenter module
- hyperspy.tests.samfire.test_red_chisq_weight module
- hyperspy.tests.samfire.test_samfire module
- hyperspy.tests.samfire.test_strategy module
- hyperspy.tests.samfire.test_strategy_list module
- hyperspy.tests.samfire.test_utils module
- Module contents
- Submodules
- hyperspy.tests.signal package
- Submodules
- hyperspy.tests.signal.test_1D_tools module
- hyperspy.tests.signal.test_2D_tools module
- hyperspy.tests.signal.test_assign_subclass module
- hyperspy.tests.signal.test_binned module
- hyperspy.tests.signal.test_complex_signal module
- hyperspy.tests.signal.test_complex_signal2d module
- hyperspy.tests.signal.test_eds_sem module
- hyperspy.tests.signal.test_eds_tem module
- hyperspy.tests.signal.test_eels module
- hyperspy.tests.signal.test_fancy_indexing module
- hyperspy.tests.signal.test_find_peaks1D_ohaver module
- hyperspy.tests.signal.test_folding module
- hyperspy.tests.signal.test_fourier_transform module
- hyperspy.tests.signal.test_hologram_image module
- hyperspy.tests.signal.test_image module
- hyperspy.tests.signal.test_inheritance module
- hyperspy.tests.signal.test_kramers_kronig_transform module
- hyperspy.tests.signal.test_lazy module
- hyperspy.tests.signal.test_map_method module
- hyperspy.tests.signal.test_remove_background module
- hyperspy.tests.signal.test_rgb module
- hyperspy.tests.signal.test_signal_operators module
- hyperspy.tests.signal.test_signal_subclass_conversion module
- hyperspy.tests.signal.test_spectrum module
- hyperspy.tests.signal.test_tools module
- Module contents
- Submodules
- hyperspy.tests.utils package
- Submodules
- Module contents
- Subpackages
- hyperspy.utils package
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.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 has been imported as hs,
numpy as np and matplotlib.pyplot as plt.
More details in the api docstring.