From 4130ee64d5843e9caeb2085a304c1321444cecdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ha=CC=8Akon=20Wiik=20A=CC=8Anes?= Date: Sat, 9 Nov 2024 21:13:39 +0100 Subject: [PATCH] Update README with kikuchipy signals MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Håkon Wiik Ånes --- README.md | 86 ++++++++++++++++-------------- readme_source/1-readme_base.md | 2 +- readme_source/2-extension_table.md | 84 +++++++++++++++-------------- 3 files changed, 90 insertions(+), 82 deletions(-) diff --git a/README.md b/README.md index 25d10ce..2e5a758 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ and send us a pull request. | [holospy](https://github.com/hyperspy/holospy) | Electron holography | | [hyperspy-gui-ipywidgets](https://github.com/hyperspy/hyperspy_gui_ipywidgets) | ipywidgets widgets for HyperSpy | | [hyperspy-gui-traitsui](https://github.com/hyperspy/hyperspy_gui_traitsui) | traitsui widgets for HyperSpy | -| [kikuchipy](https://github.com/kikuchipy/kikuchipy) | Processing, simulating and indexing of electron backscatter diffraction patterns | +| [kikuchipy](https://github.com/pyxem/kikuchipy) | Processing, simulating and indexing of electron backscatter diffraction patterns | | [LumiSpy](https://github.com/lumispy/lumispy) | Analysis of luminescence spectroscopy data | | [pyxem](https://github.com/pyxem/pyxem) | Multi-dimensional diffraction microscopy | | [rosettasciio](https://github.com/hyperspy/rosettasciio) | Reading and writing of scientific data formats. | @@ -29,45 +29,49 @@ and send us a pull request. ## List of `signal_type` classes provided by the different HyperSpy extensions in alphabetical order -| signal_type | aliases | class name | package | -| :-------------------------: | :-----------------------------------------------------------------------: | :-------------------------: | :-----: | -| beam_shift | | BeamShift | pyxem | -| CL_SEM | CLSEM, cathodoluminescence SEM | CLSEMSpectrum | lumispy | -| CL_STEM | CLSTEM, cathodoluminescence STEM | CLSTEMSpectrum | lumispy | -| CL | CLSpectrum, cathodoluminescence | CLSpectrum | lumispy | -| correlation | | Correlation1D | pyxem | -| correlation | | Correlation2D | pyxem | -| dpc | | DPCSignal1D | pyxem | -| dpc | | DPCSignal2D | pyxem | -| DielectricFunction | dielectric function | DielectricFunction | exspy | -| diffraction | | Diffraction1D | pyxem | -| diffraction | | Diffraction2D | pyxem | -| diffraction_variance | | DiffractionVariance1D | pyxem | -| diffraction_variance | | DiffractionVariance2D | pyxem | -| diffraction_vectors | | DiffractionVectors | pyxem | -| diffraction_vectors | | DiffractionVectors1D | pyxem | -| diffraction_vectors | | DiffractionVectors2D | pyxem | -| tensor_field | | DisplacementGradientMap | pyxem | -| EDS_SEM | | EDSSEMSpectrum | exspy | -| EDS_TEM | | EDSTEMSpectrum | exspy | -| EELS | TEM EELS | EELSSpectrum | exspy | -| EL | ELSpectrum, electroluminescence | ELSpectrum | lumispy | -| electron_diffraction | | ElectronDiffraction1D | pyxem | -| electron_diffraction | | ElectronDiffraction2D | pyxem | -| hologram | | HologramImage | holospy | -| insitu_diffraction | | InSituDiffraction2D | pyxem | -| labeled_diffraction_vectors | | LabeledDiffractionVectors2D | pyxem | -| Luminescence | LuminescenceSpectrum | LumiSpectrum | lumispy | -| Transient | TRLumi, TR luminescence, time-resolved luminescence | LumiTransient | lumispy | -| TransientSpec | TRLumiSpec, TR luminescence spectrum, time-resolved luminescence spectrum | LumiTransientSpectrum | lumispy | -| orientation_map | | OrientationMap | pyxem | -| PL | PLSpectrum, photoluminescence | PLSpectrum | lumispy | -| pair_distribution_function | | PairDistributionFunction1D | pyxem | -| polar_diffraction | | PolarDiffraction2D | pyxem | -| polar_vectors | | PolarVectors | pyxem | -| power | | Power2D | pyxem | -| reduced_intensity | | ReducedIntensity1D | pyxem | -| vector_matching | | VectorMatchingResults | pyxem | -| virtual_dark_field | | VirtualDarkFieldImage | pyxem | +| signal_type | aliases | class name | package | +| :-------------------------: | :-----------------------------------------------------------------------: | :-------------------------: | :-------: | +| beam_shift | | BeamShift | pyxem | +| CL_SEM | CLSEM, cathodoluminescence SEM | CLSEMSpectrum | lumispy | +| CL_STEM | CLSTEM, cathodoluminescence STEM | CLSTEMSpectrum | lumispy | +| CL | CLSpectrum, cathodoluminescence | CLSpectrum | lumispy | +| correlation | | Correlation1D | pyxem | +| correlation | | Correlation2D | pyxem | +| dpc | | DPCSignal1D | pyxem | +| dpc | | DPCSignal2D | pyxem | +| DielectricFunction | dielectric function | DielectricFunction | exspy | +| diffraction | | Diffraction1D | pyxem | +| diffraction | | Diffraction2D | pyxem | +| diffraction_variance | | DiffractionVariance1D | pyxem | +| diffraction_variance | | DiffractionVariance2D | pyxem | +| diffraction_vectors | | DiffractionVectors | pyxem | +| diffraction_vectors | | DiffractionVectors1D | pyxem | +| diffraction_vectors | | DiffractionVectors2D | pyxem | +| tensor_field | | DisplacementGradientMap | pyxem | +| EBSD | electron_backscatter_diffraction | EBSD | kikuchipy | +| EBSDMasterPattern | ebsd_master_pattern, master_pattern | EBSDMasterPattern | kikuchipy | +| ECPMasterPattern | ecp_master_pattern | ECPMasterPattern | kikuchipy | +| EDS_SEM | | EDSSEMSpectrum | exspy | +| EDS_TEM | | EDSTEMSpectrum | exspy | +| EELS | TEM EELS | EELSSpectrum | exspy | +| EL | ELSpectrum, electroluminescence | ELSpectrum | lumispy | +| electron_diffraction | | ElectronDiffraction1D | pyxem | +| electron_diffraction | | ElectronDiffraction2D | pyxem | +| hologram | | HologramImage | holospy | +| insitu_diffraction | | InSituDiffraction2D | pyxem | +| labeled_diffraction_vectors | | LabeledDiffractionVectors2D | pyxem | +| Luminescence | LuminescenceSpectrum | LumiSpectrum | lumispy | +| Transient | TRLumi, TR luminescence, time-resolved luminescence | LumiTransient | lumispy | +| TransientSpec | TRLumiSpec, TR luminescence spectrum, time-resolved luminescence spectrum | LumiTransientSpectrum | lumispy | +| orientation_map | | OrientationMap | pyxem | +| PL | PLSpectrum, photoluminescence | PLSpectrum | lumispy | +| pair_distribution_function | | PairDistributionFunction1D | pyxem | +| polar_diffraction | | PolarDiffraction2D | pyxem | +| polar_vectors | | PolarVectors | pyxem | +| power | | Power2D | pyxem | +| reduced_intensity | | ReducedIntensity1D | pyxem | +| vector_matching | | VectorMatchingResults | pyxem | +| VirtualBSEImage | virtual_backscatter_electron_image | VirtualBSEImage | kikuchipy | +| virtual_dark_field | | VirtualDarkFieldImage | pyxem | diff --git a/readme_source/1-readme_base.md b/readme_source/1-readme_base.md index f6f40d6..01c9765 100644 --- a/readme_source/1-readme_base.md +++ b/readme_source/1-readme_base.md @@ -21,7 +21,7 @@ and send us a pull request. | [holospy](https://github.com/hyperspy/holospy) | Electron holography | | [hyperspy-gui-ipywidgets](https://github.com/hyperspy/hyperspy_gui_ipywidgets) | ipywidgets widgets for HyperSpy | | [hyperspy-gui-traitsui](https://github.com/hyperspy/hyperspy_gui_traitsui) | traitsui widgets for HyperSpy | -| [kikuchipy](https://github.com/kikuchipy/kikuchipy) | Processing, simulating and indexing of electron backscatter diffraction patterns | +| [kikuchipy](https://github.com/pyxem/kikuchipy) | Processing, simulating and indexing of electron backscatter diffraction patterns | | [LumiSpy](https://github.com/lumispy/lumispy) | Analysis of luminescence spectroscopy data | | [pyxem](https://github.com/pyxem/pyxem) | Multi-dimensional diffraction microscopy | | [rosettasciio](https://github.com/hyperspy/rosettasciio) | Reading and writing of scientific data formats. | diff --git a/readme_source/2-extension_table.md b/readme_source/2-extension_table.md index 5b91d2e..3a48609 100644 --- a/readme_source/2-extension_table.md +++ b/readme_source/2-extension_table.md @@ -1,40 +1,44 @@ -| signal_type | aliases | class name | package | -| :-------------------------: | :-----------------------------------------------------------------------: | :-------------------------: | :-----: | -| beam_shift | | BeamShift | pyxem | -| CL_SEM | CLSEM, cathodoluminescence SEM | CLSEMSpectrum | lumispy | -| CL_STEM | CLSTEM, cathodoluminescence STEM | CLSTEMSpectrum | lumispy | -| CL | CLSpectrum, cathodoluminescence | CLSpectrum | lumispy | -| correlation | | Correlation1D | pyxem | -| correlation | | Correlation2D | pyxem | -| dpc | | DPCSignal1D | pyxem | -| dpc | | DPCSignal2D | pyxem | -| DielectricFunction | dielectric function | DielectricFunction | exspy | -| diffraction | | Diffraction1D | pyxem | -| diffraction | | Diffraction2D | pyxem | -| diffraction_variance | | DiffractionVariance1D | pyxem | -| diffraction_variance | | DiffractionVariance2D | pyxem | -| diffraction_vectors | | DiffractionVectors | pyxem | -| diffraction_vectors | | DiffractionVectors1D | pyxem | -| diffraction_vectors | | DiffractionVectors2D | pyxem | -| tensor_field | | DisplacementGradientMap | pyxem | -| EDS_SEM | | EDSSEMSpectrum | exspy | -| EDS_TEM | | EDSTEMSpectrum | exspy | -| EELS | TEM EELS | EELSSpectrum | exspy | -| EL | ELSpectrum, electroluminescence | ELSpectrum | lumispy | -| electron_diffraction | | ElectronDiffraction1D | pyxem | -| electron_diffraction | | ElectronDiffraction2D | pyxem | -| hologram | | HologramImage | holospy | -| insitu_diffraction | | InSituDiffraction2D | pyxem | -| labeled_diffraction_vectors | | LabeledDiffractionVectors2D | pyxem | -| Luminescence | LuminescenceSpectrum | LumiSpectrum | lumispy | -| Transient | TRLumi, TR luminescence, time-resolved luminescence | LumiTransient | lumispy | -| TransientSpec | TRLumiSpec, TR luminescence spectrum, time-resolved luminescence spectrum | LumiTransientSpectrum | lumispy | -| orientation_map | | OrientationMap | pyxem | -| PL | PLSpectrum, photoluminescence | PLSpectrum | lumispy | -| pair_distribution_function | | PairDistributionFunction1D | pyxem | -| polar_diffraction | | PolarDiffraction2D | pyxem | -| polar_vectors | | PolarVectors | pyxem | -| power | | Power2D | pyxem | -| reduced_intensity | | ReducedIntensity1D | pyxem | -| vector_matching | | VectorMatchingResults | pyxem | -| virtual_dark_field | | VirtualDarkFieldImage | pyxem | +| signal_type | aliases | class name | package | +| :-------------------------: | :-----------------------------------------------------------------------: | :-------------------------: | :-------: | +| beam_shift | | BeamShift | pyxem | +| CL_SEM | CLSEM, cathodoluminescence SEM | CLSEMSpectrum | lumispy | +| CL_STEM | CLSTEM, cathodoluminescence STEM | CLSTEMSpectrum | lumispy | +| CL | CLSpectrum, cathodoluminescence | CLSpectrum | lumispy | +| correlation | | Correlation1D | pyxem | +| correlation | | Correlation2D | pyxem | +| dpc | | DPCSignal1D | pyxem | +| dpc | | DPCSignal2D | pyxem | +| DielectricFunction | dielectric function | DielectricFunction | exspy | +| diffraction | | Diffraction1D | pyxem | +| diffraction | | Diffraction2D | pyxem | +| diffraction_variance | | DiffractionVariance1D | pyxem | +| diffraction_variance | | DiffractionVariance2D | pyxem | +| diffraction_vectors | | DiffractionVectors | pyxem | +| diffraction_vectors | | DiffractionVectors1D | pyxem | +| diffraction_vectors | | DiffractionVectors2D | pyxem | +| tensor_field | | DisplacementGradientMap | pyxem | +| EBSD | electron_backscatter_diffraction | EBSD | kikuchipy | +| EBSDMasterPattern | ebsd_master_pattern, master_pattern | EBSDMasterPattern | kikuchipy | +| ECPMasterPattern | ecp_master_pattern | ECPMasterPattern | kikuchipy | +| EDS_SEM | | EDSSEMSpectrum | exspy | +| EDS_TEM | | EDSTEMSpectrum | exspy | +| EELS | TEM EELS | EELSSpectrum | exspy | +| EL | ELSpectrum, electroluminescence | ELSpectrum | lumispy | +| electron_diffraction | | ElectronDiffraction1D | pyxem | +| electron_diffraction | | ElectronDiffraction2D | pyxem | +| hologram | | HologramImage | holospy | +| insitu_diffraction | | InSituDiffraction2D | pyxem | +| labeled_diffraction_vectors | | LabeledDiffractionVectors2D | pyxem | +| Luminescence | LuminescenceSpectrum | LumiSpectrum | lumispy | +| Transient | TRLumi, TR luminescence, time-resolved luminescence | LumiTransient | lumispy | +| TransientSpec | TRLumiSpec, TR luminescence spectrum, time-resolved luminescence spectrum | LumiTransientSpectrum | lumispy | +| orientation_map | | OrientationMap | pyxem | +| PL | PLSpectrum, photoluminescence | PLSpectrum | lumispy | +| pair_distribution_function | | PairDistributionFunction1D | pyxem | +| polar_diffraction | | PolarDiffraction2D | pyxem | +| polar_vectors | | PolarVectors | pyxem | +| power | | Power2D | pyxem | +| reduced_intensity | | ReducedIntensity1D | pyxem | +| vector_matching | | VectorMatchingResults | pyxem | +| VirtualBSEImage | virtual_backscatter_electron_image | VirtualBSEImage | kikuchipy | +| virtual_dark_field | | VirtualDarkFieldImage | pyxem |