Skip to content

Commit

Permalink
Update README with kikuchipy signals
Browse files Browse the repository at this point in the history 
Signed-off-by: Håkon Wiik Ånes <[email protected]>
  • Loading branch information
@hakonanes @ericpre
hakonanes authored and ericpre committed Nov 11, 2024
1 parent 34adcd5 commit 4130ee6
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 82 deletions.
86 changes: 45 additions & 41 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,53 +21,57 @@ 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. |

## 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 |


2 changes: 1 addition & 1 deletion readme_source/1-readme_base.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Loading

0 comments on commit 4130ee6

Please sign in to comment.