From 46049fad541e12eedf1d689ab52682bc9fd9a795 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Tue, 3 Jul 2018 12:22:55 +0200 Subject: [PATCH 1/2] Bump patch version --- hyperspy/Release.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/hyperspy/Release.py b/hyperspy/Release.py index b9d12f50cb..110a856837 100644 --- a/hyperspy/Release.py +++ b/hyperspy/Release.py @@ -25,7 +25,7 @@ # When running setup.py the ".dev" string will be replaced (if possible) # by the output of "git describe" if git is available or the git # hash if .git is present. -version = "1.3.1" +version = "1.3.2" description = "Multidimensional data analysis toolbox" license = 'GPL v3' From 977104a3f9a9e41291898fcf13ecf0d1e4b66daf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Tue, 3 Jul 2018 14:22:58 +0200 Subject: [PATCH 2/2] Update CHANGES.rst --- CHANGES.rst | 12 +- doc/api/hyperspy._components.rst | 96 ++++++++-------- doc/api/hyperspy._signals.rst | 60 +++++----- doc/api/hyperspy.datasets.rst | 8 +- doc/api/hyperspy.docstrings.rst | 20 +++- doc/api/hyperspy.drawing._markers.rst | 36 +++--- doc/api/hyperspy.drawing._widgets.rst | 36 +++--- doc/api/hyperspy.drawing.rst | 52 ++++----- doc/api/hyperspy.external.astroML.rst | 12 +- doc/api/hyperspy.external.mpfit.rst | 16 +-- doc/api/hyperspy.external.rst | 8 +- doc/api/hyperspy.io_plugins.rst | 72 ++++++------ doc/api/hyperspy.learn.rst | 24 ++-- doc/api/hyperspy.misc.eds.rst | 12 +- doc/api/hyperspy.misc.eels.rst | 28 ++--- doc/api/hyperspy.misc.holography.rst | 8 +- doc/api/hyperspy.misc.io.rst | 12 +- doc/api/hyperspy.misc.machine_learning.rst | 16 +-- doc/api/hyperspy.misc.rst | 72 ++++++------ doc/api/hyperspy.models.rst | 28 ++--- doc/api/hyperspy.rst | 92 +++++++-------- ...py.samfire_utils.goodness_of_fit_tests.rst | 16 +-- doc/api/hyperspy.samfire_utils.rst | 32 +++--- doc/api/hyperspy.samfire_utils.segmenters.rst | 8 +- doc/api/hyperspy.samfire_utils.weights.rst | 8 +- doc/api/hyperspy.tests.axes.rst | 12 +- doc/api/hyperspy.tests.component.rst | 16 +-- doc/api/hyperspy.tests.datasets.rst | 8 +- doc/api/hyperspy.tests.drawing.rst | 52 ++++++--- doc/api/hyperspy.tests.io.rst | 72 ++++++------ doc/api/hyperspy.tests.misc.rst | 32 +++--- doc/api/hyperspy.tests.model.rst | 64 +++++------ doc/api/hyperspy.tests.mva.rst | 24 ++-- doc/api/hyperspy.tests.rst | 16 +-- doc/api/hyperspy.tests.samfire.rst | 32 +++--- doc/api/hyperspy.tests.signal.rst | 108 ++++++++---------- doc/api/hyperspy.tests.utils.rst | 28 ++--- doc/api/hyperspy.utils.rst | 40 +++---- 38 files changed, 661 insertions(+), 627 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 686cba91f0..cd906595a4 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -8,6 +8,16 @@ We only cover here the main highlights, for a detailed list of all the changes see `the commits in the GITHUB milestones `_. +.. _changes_1.3.2: +v1.3.2 +++++++ + +This is a maintenance release. Follow the following links for details on all +the `bugs fixed +`_ +and `enhancements `_. + + .. _changes_1.3.1: v1.3.1 ++++++ @@ -15,7 +25,7 @@ v1.3.1 This is a maintenance release. Follow the following links for details on all the `bugs fixed `_ -and `enhancements `_. +and `enhancements `_. Starting with this version, the HyperSpy WinPython Bundle distribution is no longer released in sync with HyperSpy. For HyperSpy WinPython Bundle diff --git a/doc/api/hyperspy._components.rst b/doc/api/hyperspy._components.rst index c6097d35e6..e9d3b91f04 100644 --- a/doc/api/hyperspy._components.rst +++ b/doc/api/hyperspy._components.rst @@ -1,187 +1,187 @@ -hyperspy\.\_components package -============================== +hyperspy.\_components package +============================= Submodules ---------- -hyperspy\.\_components\.arctan module -------------------------------------- +hyperspy.\_components.arctan module +----------------------------------- .. automodule:: hyperspy._components.arctan :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.bleasdale module ----------------------------------------- +hyperspy.\_components.bleasdale module +-------------------------------------- .. automodule:: hyperspy._components.bleasdale :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.eels\_cl\_edge module ---------------------------------------------- +hyperspy.\_components.eels\_cl\_edge module +------------------------------------------- .. automodule:: hyperspy._components.eels_cl_edge :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.eels\_double\_power\_law module -------------------------------------------------------- +hyperspy.\_components.eels\_double\_power\_law module +----------------------------------------------------- .. automodule:: hyperspy._components.eels_double_power_law :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.eels\_vignetting module ------------------------------------------------ +hyperspy.\_components.eels\_vignetting module +--------------------------------------------- .. automodule:: hyperspy._components.eels_vignetting :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.error\_function module ----------------------------------------------- +hyperspy.\_components.error\_function module +-------------------------------------------- .. automodule:: hyperspy._components.error_function :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.exponential module ------------------------------------------- +hyperspy.\_components.exponential module +---------------------------------------- .. automodule:: hyperspy._components.exponential :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.expression module ------------------------------------------ +hyperspy.\_components.expression module +--------------------------------------- .. automodule:: hyperspy._components.expression :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.gaussian module ---------------------------------------- +hyperspy.\_components.gaussian module +------------------------------------- .. automodule:: hyperspy._components.gaussian :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.gaussian2d module ------------------------------------------ +hyperspy.\_components.gaussian2d module +--------------------------------------- .. automodule:: hyperspy._components.gaussian2d :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.gaussianhf module ------------------------------------------ +hyperspy.\_components.gaussianhf module +--------------------------------------- .. automodule:: hyperspy._components.gaussianhf :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.heaviside module ----------------------------------------- +hyperspy.\_components.heaviside module +-------------------------------------- .. automodule:: hyperspy._components.heaviside :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.logistic module ---------------------------------------- +hyperspy.\_components.logistic module +------------------------------------- .. automodule:: hyperspy._components.logistic :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.lorentzian module ------------------------------------------ +hyperspy.\_components.lorentzian module +--------------------------------------- .. automodule:: hyperspy._components.lorentzian :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.offset module -------------------------------------- +hyperspy.\_components.offset module +----------------------------------- .. automodule:: hyperspy._components.offset :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.pes\_core\_line\_shape module ------------------------------------------------------ +hyperspy.\_components.pes\_core\_line\_shape module +--------------------------------------------------- .. automodule:: hyperspy._components.pes_core_line_shape :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.pes\_see module ---------------------------------------- +hyperspy.\_components.pes\_see module +------------------------------------- .. automodule:: hyperspy._components.pes_see :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.polynomial module ------------------------------------------ +hyperspy.\_components.polynomial module +--------------------------------------- .. automodule:: hyperspy._components.polynomial :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.power\_law module ------------------------------------------ +hyperspy.\_components.power\_law module +--------------------------------------- .. automodule:: hyperspy._components.power_law :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.rc module ---------------------------------- +hyperspy.\_components.rc module +------------------------------- .. automodule:: hyperspy._components.rc :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.scalable\_fixed\_pattern module -------------------------------------------------------- +hyperspy.\_components.scalable\_fixed\_pattern module +----------------------------------------------------- .. automodule:: hyperspy._components.scalable_fixed_pattern :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.voigt module ------------------------------------- +hyperspy.\_components.voigt module +---------------------------------- .. automodule:: hyperspy._components.voigt :members: :undoc-members: :show-inheritance: -hyperspy\.\_components\.volume\_plasmon\_drude module ------------------------------------------------------ +hyperspy.\_components.volume\_plasmon\_drude module +--------------------------------------------------- .. automodule:: hyperspy._components.volume_plasmon_drude :members: diff --git a/doc/api/hyperspy._signals.rst b/doc/api/hyperspy._signals.rst index e15eba8643..fe1aca32b2 100644 --- a/doc/api/hyperspy._signals.rst +++ b/doc/api/hyperspy._signals.rst @@ -1,115 +1,115 @@ -hyperspy\.\_signals package -=========================== +hyperspy.\_signals package +========================== Submodules ---------- -hyperspy\.\_signals\.common\_signal1d module --------------------------------------------- +hyperspy.\_signals.common\_signal1d module +------------------------------------------ .. automodule:: hyperspy._signals.common_signal1d :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.common\_signal2d module --------------------------------------------- +hyperspy.\_signals.common\_signal2d module +------------------------------------------ .. automodule:: hyperspy._signals.common_signal2d :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.complex\_signal module -------------------------------------------- +hyperspy.\_signals.complex\_signal module +----------------------------------------- .. automodule:: hyperspy._signals.complex_signal :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.complex\_signal1d module ---------------------------------------------- +hyperspy.\_signals.complex\_signal1d module +------------------------------------------- .. automodule:: hyperspy._signals.complex_signal1d :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.complex\_signal2d module ---------------------------------------------- +hyperspy.\_signals.complex\_signal2d module +------------------------------------------- .. automodule:: hyperspy._signals.complex_signal2d :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.dielectric\_function module ------------------------------------------------- +hyperspy.\_signals.dielectric\_function module +---------------------------------------------- .. automodule:: hyperspy._signals.dielectric_function :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.eds module -------------------------------- +hyperspy.\_signals.eds module +----------------------------- .. automodule:: hyperspy._signals.eds :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.eds\_sem module ------------------------------------- +hyperspy.\_signals.eds\_sem module +---------------------------------- .. automodule:: hyperspy._signals.eds_sem :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.eds\_tem module ------------------------------------- +hyperspy.\_signals.eds\_tem module +---------------------------------- .. automodule:: hyperspy._signals.eds_tem :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.eels module --------------------------------- +hyperspy.\_signals.eels module +------------------------------ .. automodule:: hyperspy._signals.eels :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.hologram\_image module -------------------------------------------- +hyperspy.\_signals.hologram\_image module +----------------------------------------- .. automodule:: hyperspy._signals.hologram_image :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.lazy module --------------------------------- +hyperspy.\_signals.lazy module +------------------------------ .. automodule:: hyperspy._signals.lazy :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.signal1d module ------------------------------------- +hyperspy.\_signals.signal1d module +---------------------------------- .. automodule:: hyperspy._signals.signal1d :members: :undoc-members: :show-inheritance: -hyperspy\.\_signals\.signal2d module ------------------------------------- +hyperspy.\_signals.signal2d module +---------------------------------- .. automodule:: hyperspy._signals.signal2d :members: diff --git a/doc/api/hyperspy.datasets.rst b/doc/api/hyperspy.datasets.rst index 420d310dba..86e5207e22 100644 --- a/doc/api/hyperspy.datasets.rst +++ b/doc/api/hyperspy.datasets.rst @@ -1,11 +1,11 @@ -hyperspy\.datasets package -========================== +hyperspy.datasets package +========================= Submodules ---------- -hyperspy\.datasets\.example\_signals module -------------------------------------------- +hyperspy.datasets.example\_signals module +----------------------------------------- .. automodule:: hyperspy.datasets.example_signals :members: diff --git a/doc/api/hyperspy.docstrings.rst b/doc/api/hyperspy.docstrings.rst index 87b8577747..e2d8cf8f3e 100644 --- a/doc/api/hyperspy.docstrings.rst +++ b/doc/api/hyperspy.docstrings.rst @@ -1,25 +1,33 @@ -hyperspy\.docstrings package -============================ +hyperspy.docstrings package +=========================== Submodules ---------- -hyperspy\.docstrings\.plot module ---------------------------------- +hyperspy.docstrings.plot module +------------------------------- .. automodule:: hyperspy.docstrings.plot :members: :undoc-members: :show-inheritance: -hyperspy\.docstrings\.signal module ------------------------------------ +hyperspy.docstrings.signal module +--------------------------------- .. automodule:: hyperspy.docstrings.signal :members: :undoc-members: :show-inheritance: +hyperspy.docstrings.signal1d module +----------------------------------- + +.. automodule:: hyperspy.docstrings.signal1d + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/doc/api/hyperspy.drawing._markers.rst b/doc/api/hyperspy.drawing._markers.rst index 5c6549bad8..13580c14cf 100644 --- a/doc/api/hyperspy.drawing._markers.rst +++ b/doc/api/hyperspy.drawing._markers.rst @@ -1,67 +1,67 @@ -hyperspy\.drawing\.\_markers package -==================================== +hyperspy.drawing.\_markers package +================================== Submodules ---------- -hyperspy\.drawing\.\_markers\.horizontal\_line module ------------------------------------------------------ +hyperspy.drawing.\_markers.horizontal\_line module +-------------------------------------------------- .. automodule:: hyperspy.drawing._markers.horizontal_line :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_markers\.horizontal\_line\_segment module --------------------------------------------------------------- +hyperspy.drawing.\_markers.horizontal\_line\_segment module +----------------------------------------------------------- .. automodule:: hyperspy.drawing._markers.horizontal_line_segment :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_markers\.line\_segment module --------------------------------------------------- +hyperspy.drawing.\_markers.line\_segment module +----------------------------------------------- .. automodule:: hyperspy.drawing._markers.line_segment :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_markers\.point module ------------------------------------------- +hyperspy.drawing.\_markers.point module +--------------------------------------- .. automodule:: hyperspy.drawing._markers.point :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_markers\.rectangle module ----------------------------------------------- +hyperspy.drawing.\_markers.rectangle module +------------------------------------------- .. automodule:: hyperspy.drawing._markers.rectangle :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_markers\.text module ------------------------------------------ +hyperspy.drawing.\_markers.text module +-------------------------------------- .. automodule:: hyperspy.drawing._markers.text :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_markers\.vertical\_line module ---------------------------------------------------- +hyperspy.drawing.\_markers.vertical\_line module +------------------------------------------------ .. automodule:: hyperspy.drawing._markers.vertical_line :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_markers\.vertical\_line\_segment module ------------------------------------------------------------- +hyperspy.drawing.\_markers.vertical\_line\_segment module +--------------------------------------------------------- .. automodule:: hyperspy.drawing._markers.vertical_line_segment :members: diff --git a/doc/api/hyperspy.drawing._widgets.rst b/doc/api/hyperspy.drawing._widgets.rst index 7a096de27c..0856c349bb 100644 --- a/doc/api/hyperspy.drawing._widgets.rst +++ b/doc/api/hyperspy.drawing._widgets.rst @@ -1,67 +1,67 @@ -hyperspy\.drawing\.\_widgets package -==================================== +hyperspy.drawing.\_widgets package +================================== Submodules ---------- -hyperspy\.drawing\.\_widgets\.circle module -------------------------------------------- +hyperspy.drawing.\_widgets.circle module +---------------------------------------- .. automodule:: hyperspy.drawing._widgets.circle :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_widgets\.horizontal\_line module ------------------------------------------------------ +hyperspy.drawing.\_widgets.horizontal\_line module +-------------------------------------------------- .. automodule:: hyperspy.drawing._widgets.horizontal_line :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_widgets\.label module ------------------------------------------- +hyperspy.drawing.\_widgets.label module +--------------------------------------- .. automodule:: hyperspy.drawing._widgets.label :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_widgets\.line2d module -------------------------------------------- +hyperspy.drawing.\_widgets.line2d module +---------------------------------------- .. automodule:: hyperspy.drawing._widgets.line2d :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_widgets\.range module ------------------------------------------- +hyperspy.drawing.\_widgets.range module +--------------------------------------- .. automodule:: hyperspy.drawing._widgets.range :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_widgets\.rectangles module ------------------------------------------------ +hyperspy.drawing.\_widgets.rectangles module +-------------------------------------------- .. automodule:: hyperspy.drawing._widgets.rectangles :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_widgets\.scalebar module ---------------------------------------------- +hyperspy.drawing.\_widgets.scalebar module +------------------------------------------ .. automodule:: hyperspy.drawing._widgets.scalebar :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.\_widgets\.vertical\_line module ---------------------------------------------------- +hyperspy.drawing.\_widgets.vertical\_line module +------------------------------------------------ .. automodule:: hyperspy.drawing._widgets.vertical_line :members: diff --git a/doc/api/hyperspy.drawing.rst b/doc/api/hyperspy.drawing.rst index 0f1cba2cf6..1549573f96 100644 --- a/doc/api/hyperspy.drawing.rst +++ b/doc/api/hyperspy.drawing.rst @@ -1,5 +1,5 @@ -hyperspy\.drawing package -========================= +hyperspy.drawing package +======================== Subpackages ----------- @@ -12,96 +12,96 @@ Subpackages Submodules ---------- -hyperspy\.drawing\.figure module --------------------------------- +hyperspy.drawing.figure module +------------------------------ .. automodule:: hyperspy.drawing.figure :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.image module -------------------------------- +hyperspy.drawing.image module +----------------------------- .. automodule:: hyperspy.drawing.image :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.marker module --------------------------------- +hyperspy.drawing.marker module +------------------------------ .. automodule:: hyperspy.drawing.marker :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.mpl\_he module ---------------------------------- +hyperspy.drawing.mpl\_he module +------------------------------- .. automodule:: hyperspy.drawing.mpl_he :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.mpl\_hie module ----------------------------------- +hyperspy.drawing.mpl\_hie module +-------------------------------- .. automodule:: hyperspy.drawing.mpl_hie :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.mpl\_hse module ----------------------------------- +hyperspy.drawing.mpl\_hse module +-------------------------------- .. automodule:: hyperspy.drawing.mpl_hse :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.signal module --------------------------------- +hyperspy.drawing.signal module +------------------------------ .. automodule:: hyperspy.drawing.signal :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.signal1d module ----------------------------------- +hyperspy.drawing.signal1d module +-------------------------------- .. automodule:: hyperspy.drawing.signal1d :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.tiles module -------------------------------- +hyperspy.drawing.tiles module +----------------------------- .. automodule:: hyperspy.drawing.tiles :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.utils module -------------------------------- +hyperspy.drawing.utils module +----------------------------- .. automodule:: hyperspy.drawing.utils :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.widget module --------------------------------- +hyperspy.drawing.widget module +------------------------------ .. automodule:: hyperspy.drawing.widget :members: :undoc-members: :show-inheritance: -hyperspy\.drawing\.widgets module ---------------------------------- +hyperspy.drawing.widgets module +------------------------------- .. automodule:: hyperspy.drawing.widgets :members: diff --git a/doc/api/hyperspy.external.astroML.rst b/doc/api/hyperspy.external.astroML.rst index 8ee8c7ebb5..18bbdc523b 100644 --- a/doc/api/hyperspy.external.astroML.rst +++ b/doc/api/hyperspy.external.astroML.rst @@ -1,19 +1,19 @@ -hyperspy\.external\.astroML package -=================================== +hyperspy.external.astroML package +================================= Submodules ---------- -hyperspy\.external\.astroML\.bayesian\_blocks module ----------------------------------------------------- +hyperspy.external.astroML.bayesian\_blocks module +------------------------------------------------- .. automodule:: hyperspy.external.astroML.bayesian_blocks :members: :undoc-members: :show-inheritance: -hyperspy\.external\.astroML\.histtools module ---------------------------------------------- +hyperspy.external.astroML.histtools module +------------------------------------------ .. automodule:: hyperspy.external.astroML.histtools :members: diff --git a/doc/api/hyperspy.external.mpfit.rst b/doc/api/hyperspy.external.mpfit.rst index e319806e0f..90c8abcf3d 100644 --- a/doc/api/hyperspy.external.mpfit.rst +++ b/doc/api/hyperspy.external.mpfit.rst @@ -1,27 +1,27 @@ -hyperspy\.external\.mpfit package -================================= +hyperspy.external.mpfit package +=============================== Submodules ---------- -hyperspy\.external\.mpfit\.mpfit module ---------------------------------------- +hyperspy.external.mpfit.mpfit module +------------------------------------ .. automodule:: hyperspy.external.mpfit.mpfit :members: :undoc-members: :show-inheritance: -hyperspy\.external\.mpfit\.mpfitexpr module -------------------------------------------- +hyperspy.external.mpfit.mpfitexpr module +---------------------------------------- .. automodule:: hyperspy.external.mpfit.mpfitexpr :members: :undoc-members: :show-inheritance: -hyperspy\.external\.mpfit\.test\_mpfit module ---------------------------------------------- +hyperspy.external.mpfit.test\_mpfit module +------------------------------------------ .. automodule:: hyperspy.external.mpfit.test_mpfit :members: diff --git a/doc/api/hyperspy.external.rst b/doc/api/hyperspy.external.rst index 3f1508080b..0cd44aea9f 100644 --- a/doc/api/hyperspy.external.rst +++ b/doc/api/hyperspy.external.rst @@ -1,5 +1,5 @@ -hyperspy\.external package -========================== +hyperspy.external package +========================= Subpackages ----------- @@ -12,8 +12,8 @@ Subpackages Submodules ---------- -hyperspy\.external\.progressbar module --------------------------------------- +hyperspy.external.progressbar module +------------------------------------ .. automodule:: hyperspy.external.progressbar :members: diff --git a/doc/api/hyperspy.io_plugins.rst b/doc/api/hyperspy.io_plugins.rst index eb9864e422..608fe4377c 100644 --- a/doc/api/hyperspy.io_plugins.rst +++ b/doc/api/hyperspy.io_plugins.rst @@ -1,139 +1,139 @@ -hyperspy\.io\_plugins package -============================= +hyperspy.io\_plugins package +============================ Submodules ---------- -hyperspy\.io\_plugins\.bcf module ---------------------------------- +hyperspy.io\_plugins.bcf module +------------------------------- .. automodule:: hyperspy.io_plugins.bcf :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.blockfile module ---------------------------------------- +hyperspy.io\_plugins.blockfile module +------------------------------------- .. automodule:: hyperspy.io_plugins.blockfile :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.dens module ----------------------------------- +hyperspy.io\_plugins.dens module +-------------------------------- .. automodule:: hyperspy.io_plugins.dens :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.digital\_micrograph module -------------------------------------------------- +hyperspy.io\_plugins.digital\_micrograph module +----------------------------------------------- .. automodule:: hyperspy.io_plugins.digital_micrograph :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.edax module ----------------------------------- +hyperspy.io\_plugins.edax module +-------------------------------- .. automodule:: hyperspy.io_plugins.edax :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.emd module ---------------------------------- +hyperspy.io\_plugins.emd module +------------------------------- .. automodule:: hyperspy.io_plugins.emd :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.fei module ---------------------------------- +hyperspy.io\_plugins.fei module +------------------------------- .. automodule:: hyperspy.io_plugins.fei :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.hspy module ----------------------------------- +hyperspy.io\_plugins.hspy module +-------------------------------- .. automodule:: hyperspy.io_plugins.hspy :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.image module ------------------------------------ +hyperspy.io\_plugins.image module +--------------------------------- .. automodule:: hyperspy.io_plugins.image :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.mrc module ---------------------------------- +hyperspy.io\_plugins.mrc module +------------------------------- .. automodule:: hyperspy.io_plugins.mrc :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.msa module ---------------------------------- +hyperspy.io\_plugins.msa module +------------------------------- .. automodule:: hyperspy.io_plugins.msa :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.netcdf module ------------------------------------- +hyperspy.io\_plugins.netcdf module +---------------------------------- .. automodule:: hyperspy.io_plugins.netcdf :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.protochips module ----------------------------------------- +hyperspy.io\_plugins.protochips module +-------------------------------------- .. automodule:: hyperspy.io_plugins.protochips :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.ripple module ------------------------------------- +hyperspy.io\_plugins.ripple module +---------------------------------- .. automodule:: hyperspy.io_plugins.ripple :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.semper\_unf module ------------------------------------------ +hyperspy.io\_plugins.semper\_unf module +--------------------------------------- .. automodule:: hyperspy.io_plugins.semper_unf :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.tiff module ----------------------------------- +hyperspy.io\_plugins.tiff module +-------------------------------- .. automodule:: hyperspy.io_plugins.tiff :members: :undoc-members: :show-inheritance: -hyperspy\.io\_plugins\.unbcf\_fast module ------------------------------------------ +hyperspy.io\_plugins.unbcf\_fast module +--------------------------------------- .. automodule:: hyperspy.io_plugins.unbcf_fast :members: diff --git a/doc/api/hyperspy.learn.rst b/doc/api/hyperspy.learn.rst index 4e35f10a6d..41199f7663 100644 --- a/doc/api/hyperspy.learn.rst +++ b/doc/api/hyperspy.learn.rst @@ -1,43 +1,43 @@ -hyperspy\.learn package -======================= +hyperspy.learn package +====================== Submodules ---------- -hyperspy\.learn\.mlpca module ------------------------------ +hyperspy.learn.mlpca module +--------------------------- .. automodule:: hyperspy.learn.mlpca :members: :undoc-members: :show-inheritance: -hyperspy\.learn\.mva module ---------------------------- +hyperspy.learn.mva module +------------------------- .. automodule:: hyperspy.learn.mva :members: :undoc-members: :show-inheritance: -hyperspy\.learn\.onmf module ----------------------------- +hyperspy.learn.onmf module +-------------------------- .. automodule:: hyperspy.learn.onmf :members: :undoc-members: :show-inheritance: -hyperspy\.learn\.rpca module ----------------------------- +hyperspy.learn.rpca module +-------------------------- .. automodule:: hyperspy.learn.rpca :members: :undoc-members: :show-inheritance: -hyperspy\.learn\.svd\_pca module --------------------------------- +hyperspy.learn.svd\_pca module +------------------------------ .. automodule:: hyperspy.learn.svd_pca :members: diff --git a/doc/api/hyperspy.misc.eds.rst b/doc/api/hyperspy.misc.eds.rst index a03988231a..b4329eb20b 100644 --- a/doc/api/hyperspy.misc.eds.rst +++ b/doc/api/hyperspy.misc.eds.rst @@ -1,19 +1,19 @@ -hyperspy\.misc\.eds package -=========================== +hyperspy.misc.eds package +========================= Submodules ---------- -hyperspy\.misc\.eds\.ffast\_mac module --------------------------------------- +hyperspy.misc.eds.ffast\_mac module +----------------------------------- .. automodule:: hyperspy.misc.eds.ffast_mac :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.eds\.utils module ---------------------------------- +hyperspy.misc.eds.utils module +------------------------------ .. automodule:: hyperspy.misc.eds.utils :members: diff --git a/doc/api/hyperspy.misc.eels.rst b/doc/api/hyperspy.misc.eels.rst index c54169c3d3..ae428b2c3b 100644 --- a/doc/api/hyperspy.misc.eels.rst +++ b/doc/api/hyperspy.misc.eels.rst @@ -1,51 +1,51 @@ -hyperspy\.misc\.eels package -============================ +hyperspy.misc.eels package +========================== Submodules ---------- -hyperspy\.misc\.eels\.base\_gos module --------------------------------------- +hyperspy.misc.eels.base\_gos module +----------------------------------- .. automodule:: hyperspy.misc.eels.base_gos :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.eels\.eelsdb module ------------------------------------ +hyperspy.misc.eels.eelsdb module +-------------------------------- .. automodule:: hyperspy.misc.eels.eelsdb :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.eels\.effective\_angle module ---------------------------------------------- +hyperspy.misc.eels.effective\_angle module +------------------------------------------ .. automodule:: hyperspy.misc.eels.effective_angle :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.eels\.hartree\_slater\_gos module -------------------------------------------------- +hyperspy.misc.eels.hartree\_slater\_gos module +---------------------------------------------- .. automodule:: hyperspy.misc.eels.hartree_slater_gos :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.eels\.hydrogenic\_gos module --------------------------------------------- +hyperspy.misc.eels.hydrogenic\_gos module +----------------------------------------- .. automodule:: hyperspy.misc.eels.hydrogenic_gos :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.eels\.tools module ----------------------------------- +hyperspy.misc.eels.tools module +------------------------------- .. automodule:: hyperspy.misc.eels.tools :members: diff --git a/doc/api/hyperspy.misc.holography.rst b/doc/api/hyperspy.misc.holography.rst index b7d75af806..3aaee10114 100644 --- a/doc/api/hyperspy.misc.holography.rst +++ b/doc/api/hyperspy.misc.holography.rst @@ -1,11 +1,11 @@ -hyperspy\.misc\.holography package -================================== +hyperspy.misc.holography package +================================ Submodules ---------- -hyperspy\.misc\.holography\.reconstruct module ----------------------------------------------- +hyperspy.misc.holography.reconstruct module +------------------------------------------- .. automodule:: hyperspy.misc.holography.reconstruct :members: diff --git a/doc/api/hyperspy.misc.io.rst b/doc/api/hyperspy.misc.io.rst index c368b511d0..0bd0fc63a7 100644 --- a/doc/api/hyperspy.misc.io.rst +++ b/doc/api/hyperspy.misc.io.rst @@ -1,19 +1,19 @@ -hyperspy\.misc\.io package -========================== +hyperspy.misc.io package +======================== Submodules ---------- -hyperspy\.misc\.io\.tools module --------------------------------- +hyperspy.misc.io.tools module +----------------------------- .. automodule:: hyperspy.misc.io.tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.io\.utils\_readfile module ------------------------------------------- +hyperspy.misc.io.utils\_readfile module +--------------------------------------- .. automodule:: hyperspy.misc.io.utils_readfile :members: diff --git a/doc/api/hyperspy.misc.machine_learning.rst b/doc/api/hyperspy.misc.machine_learning.rst index d7846761db..7560c72d16 100644 --- a/doc/api/hyperspy.misc.machine_learning.rst +++ b/doc/api/hyperspy.misc.machine_learning.rst @@ -1,27 +1,27 @@ -hyperspy\.misc\.machine\_learning package -========================================= +hyperspy.misc.machine\_learning package +======================================= Submodules ---------- -hyperspy\.misc\.machine\_learning\.import\_sklearn module ---------------------------------------------------------- +hyperspy.misc.machine\_learning.import\_sklearn module +------------------------------------------------------ .. automodule:: hyperspy.misc.machine_learning.import_sklearn :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.machine\_learning\.orthomax module --------------------------------------------------- +hyperspy.misc.machine\_learning.orthomax module +----------------------------------------------- .. automodule:: hyperspy.misc.machine_learning.orthomax :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.machine\_learning\.tools module ------------------------------------------------ +hyperspy.misc.machine\_learning.tools module +-------------------------------------------- .. automodule:: hyperspy.misc.machine_learning.tools :members: diff --git a/doc/api/hyperspy.misc.rst b/doc/api/hyperspy.misc.rst index 3360d10d17..495c3a4da3 100644 --- a/doc/api/hyperspy.misc.rst +++ b/doc/api/hyperspy.misc.rst @@ -1,5 +1,5 @@ -hyperspy\.misc package -====================== +hyperspy.misc package +===================== Subpackages ----------- @@ -15,136 +15,136 @@ Subpackages Submodules ---------- -hyperspy\.misc\.array\_tools module ------------------------------------ +hyperspy.misc.array\_tools module +--------------------------------- .. automodule:: hyperspy.misc.array_tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.config\_dir module ----------------------------------- +hyperspy.misc.config\_dir module +-------------------------------- .. automodule:: hyperspy.misc.config_dir :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.date\_time\_tools module ----------------------------------------- +hyperspy.misc.date\_time\_tools module +-------------------------------------- .. automodule:: hyperspy.misc.date_time_tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.elements module -------------------------------- +hyperspy.misc.elements module +----------------------------- .. automodule:: hyperspy.misc.elements :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.example\_signals\_loading module ------------------------------------------------- +hyperspy.misc.example\_signals\_loading module +---------------------------------------------- .. automodule:: hyperspy.misc.example_signals_loading :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.export\_dictionary module ------------------------------------------ +hyperspy.misc.export\_dictionary module +--------------------------------------- .. automodule:: hyperspy.misc.export_dictionary :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.ipython\_tools module -------------------------------------- +hyperspy.misc.ipython\_tools module +----------------------------------- .. automodule:: hyperspy.misc.ipython_tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.material module -------------------------------- +hyperspy.misc.material module +----------------------------- .. automodule:: hyperspy.misc.material :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.math\_tools module ----------------------------------- +hyperspy.misc.math\_tools module +-------------------------------- .. automodule:: hyperspy.misc.math_tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.physical\_constants module ------------------------------------------- +hyperspy.misc.physical\_constants module +---------------------------------------- .. automodule:: hyperspy.misc.physical_constants :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.physics\_tools module -------------------------------------- +hyperspy.misc.physics\_tools module +----------------------------------- .. automodule:: hyperspy.misc.physics_tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.rgb\_tools module ---------------------------------- +hyperspy.misc.rgb\_tools module +------------------------------- .. automodule:: hyperspy.misc.rgb_tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.signal\_tools module ------------------------------------- +hyperspy.misc.signal\_tools module +---------------------------------- .. automodule:: hyperspy.misc.signal_tools :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.slicing module ------------------------------- +hyperspy.misc.slicing module +---------------------------- .. automodule:: hyperspy.misc.slicing :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.test\_utils module ----------------------------------- +hyperspy.misc.test\_utils module +-------------------------------- .. automodule:: hyperspy.misc.test_utils :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.tv\_denoise module ----------------------------------- +hyperspy.misc.tv\_denoise module +-------------------------------- .. automodule:: hyperspy.misc.tv_denoise :members: :undoc-members: :show-inheritance: -hyperspy\.misc\.utils module ----------------------------- +hyperspy.misc.utils module +-------------------------- .. automodule:: hyperspy.misc.utils :members: diff --git a/doc/api/hyperspy.models.rst b/doc/api/hyperspy.models.rst index 1d26905f46..250634da22 100644 --- a/doc/api/hyperspy.models.rst +++ b/doc/api/hyperspy.models.rst @@ -1,51 +1,51 @@ -hyperspy\.models package -======================== +hyperspy.models package +======================= Submodules ---------- -hyperspy\.models\.edsmodel module ---------------------------------- +hyperspy.models.edsmodel module +------------------------------- .. automodule:: hyperspy.models.edsmodel :members: :undoc-members: :show-inheritance: -hyperspy\.models\.edssemmodel module ------------------------------------- +hyperspy.models.edssemmodel module +---------------------------------- .. automodule:: hyperspy.models.edssemmodel :members: :undoc-members: :show-inheritance: -hyperspy\.models\.edstemmodel module ------------------------------------- +hyperspy.models.edstemmodel module +---------------------------------- .. automodule:: hyperspy.models.edstemmodel :members: :undoc-members: :show-inheritance: -hyperspy\.models\.eelsmodel module ----------------------------------- +hyperspy.models.eelsmodel module +-------------------------------- .. automodule:: hyperspy.models.eelsmodel :members: :undoc-members: :show-inheritance: -hyperspy\.models\.model1d module --------------------------------- +hyperspy.models.model1d module +------------------------------ .. automodule:: hyperspy.models.model1d :members: :undoc-members: :show-inheritance: -hyperspy\.models\.model2d module --------------------------------- +hyperspy.models.model2d module +------------------------------ .. automodule:: hyperspy.models.model2d :members: diff --git a/doc/api/hyperspy.rst b/doc/api/hyperspy.rst index 2cd0f9b1d0..251db25e2e 100644 --- a/doc/api/hyperspy.rst +++ b/doc/api/hyperspy.rst @@ -23,184 +23,184 @@ Subpackages Submodules ---------- -hyperspy\.Release module ------------------------- +hyperspy.Release module +----------------------- .. automodule:: hyperspy.Release :members: :undoc-members: :show-inheritance: -hyperspy\.\_lazy\_signals module --------------------------------- +hyperspy.\_lazy\_signals module +------------------------------- .. automodule:: hyperspy._lazy_signals :members: :undoc-members: :show-inheritance: -hyperspy\.api module --------------------- +hyperspy.api module +------------------- .. automodule:: hyperspy.api :members: :undoc-members: :show-inheritance: -hyperspy\.api\_nogui module ---------------------------- +hyperspy.api\_nogui module +-------------------------- .. automodule:: hyperspy.api_nogui :members: :undoc-members: :show-inheritance: -hyperspy\.axes module ---------------------- +hyperspy.axes module +-------------------- .. automodule:: hyperspy.axes :members: :undoc-members: :show-inheritance: -hyperspy\.component module --------------------------- +hyperspy.component module +------------------------- .. automodule:: hyperspy.component :members: :undoc-members: :show-inheritance: -hyperspy\.components1d module ------------------------------ +hyperspy.components1d module +---------------------------- .. automodule:: hyperspy.components1d :members: :undoc-members: :show-inheritance: -hyperspy\.components2d module ------------------------------ +hyperspy.components2d module +---------------------------- .. automodule:: hyperspy.components2d :members: :undoc-members: :show-inheritance: -hyperspy\.conftest module -------------------------- +hyperspy.conftest module +------------------------ .. automodule:: hyperspy.conftest :members: :undoc-members: :show-inheritance: -hyperspy\.decorators module ---------------------------- +hyperspy.decorators module +-------------------------- .. automodule:: hyperspy.decorators :members: :undoc-members: :show-inheritance: -hyperspy\.defaults\_parser module ---------------------------------- +hyperspy.defaults\_parser module +-------------------------------- .. automodule:: hyperspy.defaults_parser :members: :undoc-members: :show-inheritance: -hyperspy\.events module ------------------------ +hyperspy.events module +---------------------- .. automodule:: hyperspy.events :members: :undoc-members: :show-inheritance: -hyperspy\.exceptions module ---------------------------- +hyperspy.exceptions module +-------------------------- .. automodule:: hyperspy.exceptions :members: :undoc-members: :show-inheritance: -hyperspy\.interactive module ----------------------------- +hyperspy.interactive module +--------------------------- .. automodule:: hyperspy.interactive :members: :undoc-members: :show-inheritance: -hyperspy\.io module -------------------- +hyperspy.io module +------------------ .. automodule:: hyperspy.io :members: :undoc-members: :show-inheritance: -hyperspy\.logger module ------------------------ +hyperspy.logger module +---------------------- .. automodule:: hyperspy.logger :members: :undoc-members: :show-inheritance: -hyperspy\.model module ----------------------- +hyperspy.model module +--------------------- .. automodule:: hyperspy.model :members: :undoc-members: :show-inheritance: -hyperspy\.roi module --------------------- +hyperspy.roi module +------------------- .. automodule:: hyperspy.roi :members: :undoc-members: :show-inheritance: -hyperspy\.samfire module ------------------------- +hyperspy.samfire module +----------------------- .. automodule:: hyperspy.samfire :members: :undoc-members: :show-inheritance: -hyperspy\.signal module ------------------------ +hyperspy.signal module +---------------------- .. automodule:: hyperspy.signal :members: :undoc-members: :show-inheritance: -hyperspy\.signal\_tools module ------------------------------- +hyperspy.signal\_tools module +----------------------------- .. automodule:: hyperspy.signal_tools :members: :undoc-members: :show-inheritance: -hyperspy\.signals module ------------------------- +hyperspy.signals module +----------------------- .. automodule:: hyperspy.signals :members: :undoc-members: :show-inheritance: -hyperspy\.ui\_registry module ------------------------------ +hyperspy.ui\_registry module +---------------------------- .. automodule:: hyperspy.ui_registry :members: diff --git a/doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst b/doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst index e48249719b..ec1c265553 100644 --- a/doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst +++ b/doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst @@ -1,27 +1,27 @@ -hyperspy\.samfire\_utils\.goodness\_of\_fit\_tests package -========================================================== +hyperspy.samfire\_utils.goodness\_of\_fit\_tests package +======================================================== Submodules ---------- -hyperspy\.samfire\_utils\.goodness\_of\_fit\_tests\.information\_theory module ------------------------------------------------------------------------------- +hyperspy.samfire\_utils.goodness\_of\_fit\_tests.information\_theory module +--------------------------------------------------------------------------- .. automodule:: hyperspy.samfire_utils.goodness_of_fit_tests.information_theory :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.goodness\_of\_fit\_tests\.red\_chisq module ---------------------------------------------------------------------- +hyperspy.samfire\_utils.goodness\_of\_fit\_tests.red\_chisq module +------------------------------------------------------------------ .. automodule:: hyperspy.samfire_utils.goodness_of_fit_tests.red_chisq :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.goodness\_of\_fit\_tests\.test\_general module ------------------------------------------------------------------------- +hyperspy.samfire\_utils.goodness\_of\_fit\_tests.test\_general module +--------------------------------------------------------------------- .. automodule:: hyperspy.samfire_utils.goodness_of_fit_tests.test_general :members: diff --git a/doc/api/hyperspy.samfire_utils.rst b/doc/api/hyperspy.samfire_utils.rst index 69a25b767b..75a9a7091d 100644 --- a/doc/api/hyperspy.samfire_utils.rst +++ b/doc/api/hyperspy.samfire_utils.rst @@ -1,5 +1,5 @@ -hyperspy\.samfire\_utils package -================================ +hyperspy.samfire\_utils package +=============================== Subpackages ----------- @@ -13,56 +13,56 @@ Subpackages Submodules ---------- -hyperspy\.samfire\_utils\.fit\_tests module -------------------------------------------- +hyperspy.samfire\_utils.fit\_tests module +----------------------------------------- .. automodule:: hyperspy.samfire_utils.fit_tests :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.global\_strategies module ---------------------------------------------------- +hyperspy.samfire\_utils.global\_strategies module +------------------------------------------------- .. automodule:: hyperspy.samfire_utils.global_strategies :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.local\_strategies module --------------------------------------------------- +hyperspy.samfire\_utils.local\_strategies module +------------------------------------------------ .. automodule:: hyperspy.samfire_utils.local_strategies :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.samfire\_kernel module ------------------------------------------------- +hyperspy.samfire\_utils.samfire\_kernel module +---------------------------------------------- .. automodule:: hyperspy.samfire_utils.samfire_kernel :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.samfire\_pool module ----------------------------------------------- +hyperspy.samfire\_utils.samfire\_pool module +-------------------------------------------- .. automodule:: hyperspy.samfire_utils.samfire_pool :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.samfire\_worker module ------------------------------------------------- +hyperspy.samfire\_utils.samfire\_worker module +---------------------------------------------- .. automodule:: hyperspy.samfire_utils.samfire_worker :members: :undoc-members: :show-inheritance: -hyperspy\.samfire\_utils\.strategy module ------------------------------------------ +hyperspy.samfire\_utils.strategy module +--------------------------------------- .. automodule:: hyperspy.samfire_utils.strategy :members: diff --git a/doc/api/hyperspy.samfire_utils.segmenters.rst b/doc/api/hyperspy.samfire_utils.segmenters.rst index 6d9a7409e0..256982e28f 100644 --- a/doc/api/hyperspy.samfire_utils.segmenters.rst +++ b/doc/api/hyperspy.samfire_utils.segmenters.rst @@ -1,11 +1,11 @@ -hyperspy\.samfire\_utils\.segmenters package -============================================ +hyperspy.samfire\_utils.segmenters package +========================================== Submodules ---------- -hyperspy\.samfire\_utils\.segmenters\.histogram module ------------------------------------------------------- +hyperspy.samfire\_utils.segmenters.histogram module +--------------------------------------------------- .. automodule:: hyperspy.samfire_utils.segmenters.histogram :members: diff --git a/doc/api/hyperspy.samfire_utils.weights.rst b/doc/api/hyperspy.samfire_utils.weights.rst index da803d8dd2..75963d9d86 100644 --- a/doc/api/hyperspy.samfire_utils.weights.rst +++ b/doc/api/hyperspy.samfire_utils.weights.rst @@ -1,11 +1,11 @@ -hyperspy\.samfire\_utils\.weights package -========================================= +hyperspy.samfire\_utils.weights package +======================================= Submodules ---------- -hyperspy\.samfire\_utils\.weights\.red\_chisq module ----------------------------------------------------- +hyperspy.samfire\_utils.weights.red\_chisq module +------------------------------------------------- .. automodule:: hyperspy.samfire_utils.weights.red_chisq :members: diff --git a/doc/api/hyperspy.tests.axes.rst b/doc/api/hyperspy.tests.axes.rst index e161fbfd75..4014e89c4f 100644 --- a/doc/api/hyperspy.tests.axes.rst +++ b/doc/api/hyperspy.tests.axes.rst @@ -1,19 +1,19 @@ -hyperspy\.tests\.axes package -============================= +hyperspy.tests.axes package +=========================== Submodules ---------- -hyperspy\.tests\.axes\.test\_axes\_manager module -------------------------------------------------- +hyperspy.tests.axes.test\_axes\_manager module +---------------------------------------------- .. automodule:: hyperspy.tests.axes.test_axes_manager :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.axes\.test\_data\_axis module ----------------------------------------------- +hyperspy.tests.axes.test\_data\_axis module +------------------------------------------- .. automodule:: hyperspy.tests.axes.test_data_axis :members: diff --git a/doc/api/hyperspy.tests.component.rst b/doc/api/hyperspy.tests.component.rst index ee965f3d28..0704370663 100644 --- a/doc/api/hyperspy.tests.component.rst +++ b/doc/api/hyperspy.tests.component.rst @@ -1,27 +1,27 @@ -hyperspy\.tests\.component package -================================== +hyperspy.tests.component package +================================ Submodules ---------- -hyperspy\.tests\.component\.test\_component\_active\_array module ------------------------------------------------------------------ +hyperspy.tests.component.test\_component\_active\_array module +-------------------------------------------------------------- .. automodule:: hyperspy.tests.component.test_component_active_array :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.component\.test\_component\_set\_parameters module -------------------------------------------------------------------- +hyperspy.tests.component.test\_component\_set\_parameters module +---------------------------------------------------------------- .. automodule:: hyperspy.tests.component.test_component_set_parameters :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.component\.test\_gaussianhf module ---------------------------------------------------- +hyperspy.tests.component.test\_gaussianhf module +------------------------------------------------ .. automodule:: hyperspy.tests.component.test_gaussianhf :members: diff --git a/doc/api/hyperspy.tests.datasets.rst b/doc/api/hyperspy.tests.datasets.rst index db08253d48..f08f9306b3 100644 --- a/doc/api/hyperspy.tests.datasets.rst +++ b/doc/api/hyperspy.tests.datasets.rst @@ -1,11 +1,11 @@ -hyperspy\.tests\.datasets package -================================= +hyperspy.tests.datasets package +=============================== Submodules ---------- -hyperspy\.tests\.datasets\.test\_eelsdb module ----------------------------------------------- +hyperspy.tests.datasets.test\_eelsdb module +------------------------------------------- .. automodule:: hyperspy.tests.datasets.test_eelsdb :members: diff --git a/doc/api/hyperspy.tests.drawing.rst b/doc/api/hyperspy.tests.drawing.rst index 1204def46e..cfa1e6de8c 100644 --- a/doc/api/hyperspy.tests.drawing.rst +++ b/doc/api/hyperspy.tests.drawing.rst @@ -1,67 +1,83 @@ -hyperspy\.tests\.drawing package -================================ +hyperspy.tests.drawing package +============================== Submodules ---------- -hyperspy\.tests\.drawing\.test\_figure\_title module ----------------------------------------------------- +hyperspy.tests.drawing.test\_figure\_title module +------------------------------------------------- .. automodule:: hyperspy.tests.drawing.test_figure_title :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.drawing\.test\_mpl\_testing\_setup module ----------------------------------------------------------- +hyperspy.tests.drawing.test\_mpl\_testing\_setup module +------------------------------------------------------- .. automodule:: hyperspy.tests.drawing.test_mpl_testing_setup :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.drawing\.test\_plot\_markers module ----------------------------------------------------- +hyperspy.tests.drawing.test\_plot\_markers module +------------------------------------------------- .. automodule:: hyperspy.tests.drawing.test_plot_markers :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.drawing\.test\_plot\_mva module ------------------------------------------------- +hyperspy.tests.drawing.test\_plot\_model module +----------------------------------------------- + +.. automodule:: hyperspy.tests.drawing.test_plot_model + :members: + :undoc-members: + :show-inheritance: + +hyperspy.tests.drawing.test\_plot\_mva module +--------------------------------------------- .. automodule:: hyperspy.tests.drawing.test_plot_mva :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.drawing\.test\_plot\_signal module ---------------------------------------------------- +hyperspy.tests.drawing.test\_plot\_signal module +------------------------------------------------ .. automodule:: hyperspy.tests.drawing.test_plot_signal :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.drawing\.test\_plot\_signal1d module ------------------------------------------------------ +hyperspy.tests.drawing.test\_plot\_signal1d module +-------------------------------------------------- .. automodule:: hyperspy.tests.drawing.test_plot_signal1d :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.drawing\.test\_plot\_signal2d module ------------------------------------------------------ +hyperspy.tests.drawing.test\_plot\_signal2d module +-------------------------------------------------- .. automodule:: hyperspy.tests.drawing.test_plot_signal2d :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.drawing\.test\_utils module --------------------------------------------- +hyperspy.tests.drawing.test\_plot\_widgets module +------------------------------------------------- + +.. automodule:: hyperspy.tests.drawing.test_plot_widgets + :members: + :undoc-members: + :show-inheritance: + +hyperspy.tests.drawing.test\_utils module +----------------------------------------- .. automodule:: hyperspy.tests.drawing.test_utils :members: diff --git a/doc/api/hyperspy.tests.io.rst b/doc/api/hyperspy.tests.io.rst index 57e3da708c..74bf7f0a95 100644 --- a/doc/api/hyperspy.tests.io.rst +++ b/doc/api/hyperspy.tests.io.rst @@ -1,123 +1,131 @@ -hyperspy\.tests\.io package -=========================== +hyperspy.tests.io package +========================= Submodules ---------- -hyperspy\.tests\.io\.generate\_dm\_testing\_files module --------------------------------------------------------- +hyperspy.tests.io.generate\_dm\_testing\_files module +----------------------------------------------------- .. automodule:: hyperspy.tests.io.generate_dm_testing_files :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_bcf module -------------------------------------- +hyperspy.tests.io.test\_bcf module +---------------------------------- .. automodule:: hyperspy.tests.io.test_bcf :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_blockfile module -------------------------------------------- +hyperspy.tests.io.test\_blockfile module +---------------------------------------- .. automodule:: hyperspy.tests.io.test_blockfile :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_dens module --------------------------------------- +hyperspy.tests.io.test\_dens module +----------------------------------- .. automodule:: hyperspy.tests.io.test_dens :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_dm3 module -------------------------------------- +hyperspy.tests.io.test\_dm3 module +---------------------------------- .. automodule:: hyperspy.tests.io.test_dm3 :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_dm\_stackbuilder\_plugin module ----------------------------------------------------------- +hyperspy.tests.io.test\_dm\_stackbuilder\_plugin module +------------------------------------------------------- .. automodule:: hyperspy.tests.io.test_dm_stackbuilder_plugin :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_edax module --------------------------------------- +hyperspy.tests.io.test\_edax module +----------------------------------- .. automodule:: hyperspy.tests.io.test_edax :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_emd module -------------------------------------- +hyperspy.tests.io.test\_emd module +---------------------------------- .. automodule:: hyperspy.tests.io.test_emd :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_fei module -------------------------------------- +hyperspy.tests.io.test\_fei module +---------------------------------- .. automodule:: hyperspy.tests.io.test_fei :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_hdf5 module --------------------------------------- +hyperspy.tests.io.test\_hdf5 module +----------------------------------- .. automodule:: hyperspy.tests.io.test_hdf5 :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_msa module -------------------------------------- +hyperspy.tests.io.test\_io module +--------------------------------- + +.. automodule:: hyperspy.tests.io.test_io + :members: + :undoc-members: + :show-inheritance: + +hyperspy.tests.io.test\_msa module +---------------------------------- .. automodule:: hyperspy.tests.io.test_msa :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_protochips module --------------------------------------------- +hyperspy.tests.io.test\_protochips module +----------------------------------------- .. automodule:: hyperspy.tests.io.test_protochips :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_ripple module ----------------------------------------- +hyperspy.tests.io.test\_ripple module +------------------------------------- .. automodule:: hyperspy.tests.io.test_ripple :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_semper\_unf module ---------------------------------------------- +hyperspy.tests.io.test\_semper\_unf module +------------------------------------------ .. automodule:: hyperspy.tests.io.test_semper_unf :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.io\.test\_tiff module --------------------------------------- +hyperspy.tests.io.test\_tiff module +----------------------------------- .. automodule:: hyperspy.tests.io.test_tiff :members: diff --git a/doc/api/hyperspy.tests.misc.rst b/doc/api/hyperspy.tests.misc.rst index 184ac01539..1a9d8d9a6b 100644 --- a/doc/api/hyperspy.tests.misc.rst +++ b/doc/api/hyperspy.tests.misc.rst @@ -1,59 +1,59 @@ -hyperspy\.tests\.misc package -============================= +hyperspy.tests.misc package +=========================== Submodules ---------- -hyperspy\.tests\.misc\.test\_arraytools module ----------------------------------------------- +hyperspy.tests.misc.test\_arraytools module +------------------------------------------- .. automodule:: hyperspy.tests.misc.test_arraytools :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.misc\.test\_date\_time\_tools module ------------------------------------------------------ +hyperspy.tests.misc.test\_date\_time\_tools module +-------------------------------------------------- .. automodule:: hyperspy.tests.misc.test_date_time_tools :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.misc\.test\_image\_tools module ------------------------------------------------- +hyperspy.tests.misc.test\_image\_tools module +--------------------------------------------- .. automodule:: hyperspy.tests.misc.test_image_tools :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.misc\.test\_math\_tools module ------------------------------------------------ +hyperspy.tests.misc.test\_math\_tools module +-------------------------------------------- .. automodule:: hyperspy.tests.misc.test_math_tools :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.misc\.test\_rgbtools module --------------------------------------------- +hyperspy.tests.misc.test\_rgbtools module +----------------------------------------- .. automodule:: hyperspy.tests.misc.test_rgbtools :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.misc\.test\_test\_utils module ------------------------------------------------ +hyperspy.tests.misc.test\_test\_utils module +-------------------------------------------- .. automodule:: hyperspy.tests.misc.test_test_utils :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.misc\.test\_utils module ------------------------------------------ +hyperspy.tests.misc.test\_utils module +-------------------------------------- .. automodule:: hyperspy.tests.misc.test_utils :members: diff --git a/doc/api/hyperspy.tests.model.rst b/doc/api/hyperspy.tests.model.rst index f7b8b03924..022d10e83b 100644 --- a/doc/api/hyperspy.tests.model.rst +++ b/doc/api/hyperspy.tests.model.rst @@ -1,123 +1,123 @@ -hyperspy\.tests\.model package -============================== +hyperspy.tests.model package +============================ Submodules ---------- -hyperspy\.tests\.model\.test\_chi\_squared module -------------------------------------------------- +hyperspy.tests.model.test\_chi\_squared module +---------------------------------------------- .. automodule:: hyperspy.tests.model.test_chi_squared :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_component module ----------------------------------------------- +hyperspy.tests.model.test\_component module +------------------------------------------- .. automodule:: hyperspy.tests.model.test_component :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_components module ------------------------------------------------ +hyperspy.tests.model.test\_components module +-------------------------------------------- .. automodule:: hyperspy.tests.model.test_components :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_components2D module -------------------------------------------------- +hyperspy.tests.model.test\_components2D module +---------------------------------------------- .. automodule:: hyperspy.tests.model.test_components2D :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_edsmodel module ---------------------------------------------- +hyperspy.tests.model.test\_edsmodel module +------------------------------------------ .. automodule:: hyperspy.tests.model.test_edsmodel :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_eelsmodel module ----------------------------------------------- +hyperspy.tests.model.test\_eelsmodel module +------------------------------------------- .. automodule:: hyperspy.tests.model.test_eelsmodel :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_fancy\_indexing module ----------------------------------------------------- +hyperspy.tests.model.test\_fancy\_indexing module +------------------------------------------------- .. automodule:: hyperspy.tests.model.test_fancy_indexing :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_fit\_component module ---------------------------------------------------- +hyperspy.tests.model.test\_fit\_component module +------------------------------------------------ .. automodule:: hyperspy.tests.model.test_fit_component :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_model module ------------------------------------------- +hyperspy.tests.model.test\_model module +--------------------------------------- .. automodule:: hyperspy.tests.model.test_model :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_model\_as\_dictionary module ----------------------------------------------------------- +hyperspy.tests.model.test\_model\_as\_dictionary module +------------------------------------------------------- .. automodule:: hyperspy.tests.model.test_model_as_dictionary :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_model\_selection\_criteria module ---------------------------------------------------------------- +hyperspy.tests.model.test\_model\_selection\_criteria module +------------------------------------------------------------ .. automodule:: hyperspy.tests.model.test_model_selection_criteria :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_model\_storing module ---------------------------------------------------- +hyperspy.tests.model.test\_model\_storing module +------------------------------------------------ .. automodule:: hyperspy.tests.model.test_model_storing :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_parameter module ----------------------------------------------- +hyperspy.tests.model.test\_parameter module +------------------------------------------- .. automodule:: hyperspy.tests.model.test_parameter :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_set\_parameter\_state module ----------------------------------------------------------- +hyperspy.tests.model.test\_set\_parameter\_state module +------------------------------------------------------- .. automodule:: hyperspy.tests.model.test_set_parameter_state :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.model\.test\_set\_parameter\_value module ----------------------------------------------------------- +hyperspy.tests.model.test\_set\_parameter\_value module +------------------------------------------------------- .. automodule:: hyperspy.tests.model.test_set_parameter_value :members: diff --git a/doc/api/hyperspy.tests.mva.rst b/doc/api/hyperspy.tests.mva.rst index 74428172a4..10836ab6db 100644 --- a/doc/api/hyperspy.tests.mva.rst +++ b/doc/api/hyperspy.tests.mva.rst @@ -1,43 +1,43 @@ -hyperspy\.tests\.mva package -============================ +hyperspy.tests.mva package +========================== Submodules ---------- -hyperspy\.tests\.mva\.test\_bss module --------------------------------------- +hyperspy.tests.mva.test\_bss module +----------------------------------- .. automodule:: hyperspy.tests.mva.test_bss :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.mva\.test\_decomposition module ------------------------------------------------- +hyperspy.tests.mva.test\_decomposition module +--------------------------------------------- .. automodule:: hyperspy.tests.mva.test_decomposition :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.mva\.test\_export module ------------------------------------------ +hyperspy.tests.mva.test\_export module +-------------------------------------- .. automodule:: hyperspy.tests.mva.test_export :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.mva\.test\_onmf module ---------------------------------------- +hyperspy.tests.mva.test\_onmf module +------------------------------------ .. automodule:: hyperspy.tests.mva.test_onmf :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.mva\.test\_rpca module ---------------------------------------- +hyperspy.tests.mva.test\_rpca module +------------------------------------ .. automodule:: hyperspy.tests.mva.test_rpca :members: diff --git a/doc/api/hyperspy.tests.rst b/doc/api/hyperspy.tests.rst index 9158cc6d1f..fc5dbb6f19 100644 --- a/doc/api/hyperspy.tests.rst +++ b/doc/api/hyperspy.tests.rst @@ -1,5 +1,5 @@ -hyperspy\.tests package -======================= +hyperspy.tests package +====================== Subpackages ----------- @@ -21,24 +21,24 @@ Subpackages Submodules ---------- -hyperspy\.tests\.test\_dictionary\_tree\_browser module -------------------------------------------------------- +hyperspy.tests.test\_dictionary\_tree\_browser module +----------------------------------------------------- .. automodule:: hyperspy.tests.test_dictionary_tree_browser :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.test\_events module ------------------------------------- +hyperspy.tests.test\_events module +---------------------------------- .. automodule:: hyperspy.tests.test_events :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.test\_interactive module ------------------------------------------ +hyperspy.tests.test\_interactive module +--------------------------------------- .. automodule:: hyperspy.tests.test_interactive :members: diff --git a/doc/api/hyperspy.tests.samfire.rst b/doc/api/hyperspy.tests.samfire.rst index 103be545c4..aad963ca3e 100644 --- a/doc/api/hyperspy.tests.samfire.rst +++ b/doc/api/hyperspy.tests.samfire.rst @@ -1,59 +1,59 @@ -hyperspy\.tests\.samfire package -================================ +hyperspy.tests.samfire package +============================== Submodules ---------- -hyperspy\.tests\.samfire\.test\_goodness\_of\_fit\_tests module ---------------------------------------------------------------- +hyperspy.tests.samfire.test\_goodness\_of\_fit\_tests module +------------------------------------------------------------ .. automodule:: hyperspy.tests.samfire.test_goodness_of_fit_tests :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.samfire\.test\_histogram\_segmenter module ------------------------------------------------------------ +hyperspy.tests.samfire.test\_histogram\_segmenter module +-------------------------------------------------------- .. automodule:: hyperspy.tests.samfire.test_histogram_segmenter :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.samfire\.test\_red\_chisq\_weight module ---------------------------------------------------------- +hyperspy.tests.samfire.test\_red\_chisq\_weight module +------------------------------------------------------ .. automodule:: hyperspy.tests.samfire.test_red_chisq_weight :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.samfire\.test\_samfire module ----------------------------------------------- +hyperspy.tests.samfire.test\_samfire module +------------------------------------------- .. automodule:: hyperspy.tests.samfire.test_samfire :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.samfire\.test\_strategy module ------------------------------------------------ +hyperspy.tests.samfire.test\_strategy module +-------------------------------------------- .. automodule:: hyperspy.tests.samfire.test_strategy :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.samfire\.test\_strategy\_list module ------------------------------------------------------ +hyperspy.tests.samfire.test\_strategy\_list module +-------------------------------------------------- .. automodule:: hyperspy.tests.samfire.test_strategy_list :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.samfire\.test\_utils module --------------------------------------------- +hyperspy.tests.samfire.test\_utils module +----------------------------------------- .. automodule:: hyperspy.tests.samfire.test_utils :members: diff --git a/doc/api/hyperspy.tests.signal.rst b/doc/api/hyperspy.tests.signal.rst index 95160e6486..b627ee4ace 100644 --- a/doc/api/hyperspy.tests.signal.rst +++ b/doc/api/hyperspy.tests.signal.rst @@ -1,203 +1,195 @@ -hyperspy\.tests\.signal package -=============================== +hyperspy.tests.signal package +============================= Submodules ---------- -hyperspy\.tests\.signal\.test\_1D\_tools module ------------------------------------------------ +hyperspy.tests.signal.test\_1D\_tools module +-------------------------------------------- .. automodule:: hyperspy.tests.signal.test_1D_tools :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_2D\_tools module ------------------------------------------------ +hyperspy.tests.signal.test\_2D\_tools module +-------------------------------------------- .. automodule:: hyperspy.tests.signal.test_2D_tools :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_assign\_subclass module ------------------------------------------------------- +hyperspy.tests.signal.test\_assign\_subclass module +--------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_assign_subclass :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_binned module --------------------------------------------- +hyperspy.tests.signal.test\_binned module +----------------------------------------- .. automodule:: hyperspy.tests.signal.test_binned :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_complex\_signal module ------------------------------------------------------ +hyperspy.tests.signal.test\_complex\_signal module +-------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_complex_signal :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_complex\_signal2d module -------------------------------------------------------- +hyperspy.tests.signal.test\_complex\_signal2d module +---------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_complex_signal2d :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_eds\_sem module ----------------------------------------------- +hyperspy.tests.signal.test\_eds\_sem module +------------------------------------------- .. automodule:: hyperspy.tests.signal.test_eds_sem :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_eds\_tem module ----------------------------------------------- +hyperspy.tests.signal.test\_eds\_tem module +------------------------------------------- .. automodule:: hyperspy.tests.signal.test_eds_tem :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_eels module ------------------------------------------- +hyperspy.tests.signal.test\_eels module +--------------------------------------- .. automodule:: hyperspy.tests.signal.test_eels :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_fancy\_indexing module ------------------------------------------------------ +hyperspy.tests.signal.test\_fancy\_indexing module +-------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_fancy_indexing :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_find\_peaks1D\_ohaver module ------------------------------------------------------------ +hyperspy.tests.signal.test\_find\_peaks1D\_ohaver module +-------------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_find_peaks1D_ohaver :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_folding module ---------------------------------------------- +hyperspy.tests.signal.test\_folding module +------------------------------------------ .. automodule:: hyperspy.tests.signal.test_folding :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_hologram\_image module ------------------------------------------------------ +hyperspy.tests.signal.test\_hologram\_image module +-------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_hologram_image :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_image module -------------------------------------------- +hyperspy.tests.signal.test\_image module +---------------------------------------- .. automodule:: hyperspy.tests.signal.test_image :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_inheritance module -------------------------------------------------- +hyperspy.tests.signal.test\_inheritance module +---------------------------------------------- .. automodule:: hyperspy.tests.signal.test_inheritance :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_integrate\_in\_range module ----------------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_integrate_in_range - :members: - :undoc-members: - :show-inheritance: - -hyperspy\.tests\.signal\.test\_kramers\_kronig\_transform module ----------------------------------------------------------------- +hyperspy.tests.signal.test\_kramers\_kronig\_transform module +------------------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_kramers_kronig_transform :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_lazy module ------------------------------------------- +hyperspy.tests.signal.test\_lazy module +--------------------------------------- .. automodule:: hyperspy.tests.signal.test_lazy :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_map\_method module -------------------------------------------------- +hyperspy.tests.signal.test\_map\_method module +---------------------------------------------- .. automodule:: hyperspy.tests.signal.test_map_method :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_remove\_background module --------------------------------------------------------- +hyperspy.tests.signal.test\_remove\_background module +----------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_remove_background :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_rgb module ------------------------------------------ +hyperspy.tests.signal.test\_rgb module +-------------------------------------- .. automodule:: hyperspy.tests.signal.test_rgb :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_signal\_operators module -------------------------------------------------------- +hyperspy.tests.signal.test\_signal\_operators module +---------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_signal_operators :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_signal\_subclass\_conversion module ------------------------------------------------------------------- +hyperspy.tests.signal.test\_signal\_subclass\_conversion module +--------------------------------------------------------------- .. automodule:: hyperspy.tests.signal.test_signal_subclass_conversion :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_spectrum module ----------------------------------------------- +hyperspy.tests.signal.test\_spectrum module +------------------------------------------- .. automodule:: hyperspy.tests.signal.test_spectrum :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.signal\.test\_tools module -------------------------------------------- +hyperspy.tests.signal.test\_tools module +---------------------------------------- .. automodule:: hyperspy.tests.signal.test_tools :members: diff --git a/doc/api/hyperspy.tests.utils.rst b/doc/api/hyperspy.tests.utils.rst index aea70335e9..c6fd7c38e1 100644 --- a/doc/api/hyperspy.tests.utils.rst +++ b/doc/api/hyperspy.tests.utils.rst @@ -1,51 +1,51 @@ -hyperspy\.tests\.utils package -============================== +hyperspy.tests.utils package +============================ Submodules ---------- -hyperspy\.tests\.utils\.test\_attrsetter module ------------------------------------------------ +hyperspy.tests.utils.test\_attrsetter module +-------------------------------------------- .. automodule:: hyperspy.tests.utils.test_attrsetter :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.utils\.test\_eds module ----------------------------------------- +hyperspy.tests.utils.test\_eds module +------------------------------------- .. automodule:: hyperspy.tests.utils.test_eds :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.utils\.test\_material module ---------------------------------------------- +hyperspy.tests.utils.test\_material module +------------------------------------------ .. automodule:: hyperspy.tests.utils.test_material :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.utils\.test\_roi module ----------------------------------------- +hyperspy.tests.utils.test\_roi module +------------------------------------- .. automodule:: hyperspy.tests.utils.test_roi :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.utils\.test\_slugify module --------------------------------------------- +hyperspy.tests.utils.test\_slugify module +----------------------------------------- .. automodule:: hyperspy.tests.utils.test_slugify :members: :undoc-members: :show-inheritance: -hyperspy\.tests\.utils\.test\_stack module ------------------------------------------- +hyperspy.tests.utils.test\_stack module +--------------------------------------- .. automodule:: hyperspy.tests.utils.test_stack :members: diff --git a/doc/api/hyperspy.utils.rst b/doc/api/hyperspy.utils.rst index 5f28c3d3bc..ce7886ed50 100644 --- a/doc/api/hyperspy.utils.rst +++ b/doc/api/hyperspy.utils.rst @@ -1,75 +1,75 @@ -hyperspy\.utils package -======================= +hyperspy.utils package +====================== Submodules ---------- -hyperspy\.utils\.eds module ---------------------------- +hyperspy.utils.eds module +------------------------- .. automodule:: hyperspy.utils.eds :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.markers module -------------------------------- +hyperspy.utils.markers module +----------------------------- .. automodule:: hyperspy.utils.markers :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.material module --------------------------------- +hyperspy.utils.material module +------------------------------ .. automodule:: hyperspy.utils.material :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.model module ------------------------------ +hyperspy.utils.model module +--------------------------- .. automodule:: hyperspy.utils.model :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.model\_selection module ----------------------------------------- +hyperspy.utils.model\_selection module +-------------------------------------- .. automodule:: hyperspy.utils.model_selection :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.parallel\_pool module --------------------------------------- +hyperspy.utils.parallel\_pool module +------------------------------------ .. automodule:: hyperspy.utils.parallel_pool :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.plot module ----------------------------- +hyperspy.utils.plot module +-------------------------- .. automodule:: hyperspy.utils.plot :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.roi module ---------------------------- +hyperspy.utils.roi module +------------------------- .. automodule:: hyperspy.utils.roi :members: :undoc-members: :show-inheritance: -hyperspy\.utils\.samfire module -------------------------------- +hyperspy.utils.samfire module +----------------------------- .. automodule:: hyperspy.utils.samfire :members: