Skip to content

Commit

Permalink
add user_guide chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaehne committed Oct 15, 2024
1 parent 29e2883 commit c91e1b4
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/user_guide/signal_axis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@ Interpolation to uniform axes
=============================

As a number of HyperSpy tools are not supporting non-uniform axes, e.g. the

Check warning on line 148 in doc/user_guide/signal_axis.rst

View workflow job for this annotation

GitHub Actions / Check links and make PR comments

external std:ref reference target not found: rebinning [ref.ref]

Check warning on line 148 in doc/user_guide/signal_axis.rst

View workflow job for this annotation

GitHub Actions / Check links and make PR comments

external std:ref reference target not found: interpolate-to-a-different-axis [ref.ref]
:ref:external+hyperspy:`rebin() <rebinning>` function, the HyperSpy function
:ref:external+hyperspy:`interpolate_on_axis() <interpolate-to-a-different-axis>`
:external+hyperspy:ref:`rebin() <rebinning>` function, the HyperSpy function
:external+hyperspy:ref:`interpolate_on_axis() <interpolate-to-a-different-axis>`
provides a possibility to convert a signal with a non-uniform axis to one with
a uniform axis. This function takes the argument ``"uniform"``, which will create
a signal with the same number of data points, but a uniform axes spacing and
Expand Down
2 changes: 1 addition & 1 deletion doc/user_guide/streak_images.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ can be transformed to e.g. a :ref:`energy_axis`.
.. Note::

For streak images, not all tools available for :class:`hyperspy.signal.Signal2D`

Check warning on line 14 in doc/user_guide/streak_images.rst

View workflow job for this annotation

GitHub Actions / Check links and make PR comments

external std:ref reference target not found: peak-finding [ref.ref]
will work. However, in particular :ref:external+hyperspy:`peak-finding` can be
will work. However, in particular :external+hyperspy:ref:`peak-finding` can be
helpful to identify local maxima in the images.


Expand Down
2 changes: 1 addition & 1 deletion upcoming_changes/205.new.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Implement correct casting of :class:`LumiTransientSpectrum` to either :class:`Luminescence` or :class:`Transient` when the signal dimension is reduced
Implement correct casting of :class:`~.signals.LumiTransientSpectrum` to either :class:`~.signals.LumiSpectrum` or :class:`~.signals.LumiTransient` when the signal dimension is reduced

0 comments on commit c91e1b4

Please sign in to comment.