Skip to content

Commit

Permalink
update signal_basics
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaehne committed Sep 11, 2024
1 parent 2d701f4 commit 36c0107
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions doc/user_guide/signal/signal_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ appropriate, functionalities are restricted to certain
.. versionchanged:: 2.0
The subclasses ``EELS``, ``EDS_SEM``, ``EDS_TEM`` and
``DielectricFunction`` have been moved to the extension package
``EleXSpy`` and the subclass ``hologram`` has been
moved to the extension package ``HoloSpy``.
``eXSpy`` and the subclass ``hologram`` has been
moved to the extension package ``holoSpy``.

.. _hyperspy_extensions-label:

Expand All @@ -206,7 +206,8 @@ The metadata attribute ``signal_type`` describes the nature of the signal. It ca
be any string, normally the acronym associated with a particular signal. To print
all :class:`~.api.signals.BaseSignal` subclasses available in your system call
the function :func:`~.api.print_known_signal_types` as in the following
example:
example (assuming the extensions :external+exspy:ref:`eXSpy <user_guide>` and
:external+holospy:ref:`holoSpy <user_guide>` are installed):

.. code-block:: python
Expand All @@ -229,12 +230,12 @@ otherwise a warning will be raised to explain that
no registered signal class can be assigned to the given ``signal_type``.

Since the :func:`~.api.load` can return domain specific signal objects (e.g.
``EDSSEMSpectrum`` from ``EleXSpy``) provided by extensions, the corresponding
``EDSSEMSpectrum`` from ``eXSpy``) provided by extensions, the corresponding
functionalities (so-called `method` of `object` in object-oriented programming,
e.g. ``EDSSEMSpectrum.get_lines_intensity()``) implemented in signal classes of
the extension can be accessed directly. To use additional functionalities
implemented in extensions, but not as method of the signal class, the extensions
need to be imported explicitly (e.g. ``import elexspy``). Check the user guides
need to be imported explicitly (e.g. ``import exspy``). Check the user guides
of the respective `HyperSpy extensions
<https://github.com/hyperspy/hyperspy-extensions-list>`_ for details on the
provided methods and functions.
Expand All @@ -253,7 +254,8 @@ in place, which may result in a :class:`~.api.signals.BaseSignal` subclass
transformation.

The following example shows how to change the signal dimensionality and how
to transform between different subclasses:
to transform between different subclasses (converting to ``EELS`` requires the
extension :external+exspy:ref:`eXSpy <user_guide>` to be installed):

.. code-block:: python
Expand Down

0 comments on commit 36c0107

Please sign in to comment.