Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix links in documentation #182

Merged
merged 3 commits into from
Mar 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions doc/source/user_guide/fitting_luminescence.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,17 @@
Fitting luminescence data
*************************

LumiSpy is compatible with :external+hyperspy:ref:`HyperSpy model fitting
LumiSpy is compatible with :external+hyperspy:doc:`HyperSpy model fitting
<user_guide/model>`.
It can fit using both `uniform and and non-uniform axes
<https://hyperspy.org/hyperspy-doc/current/user_guide/axes.html#types-of-data-axes>`_
It can fit using both :external+hyperspy:ref:`uniform and and non-uniform axes
<Axes_types>`
(e.g. energy scale). A general introduction can be found in the
:external+hyperspy:ref:`HyperSpy user guide <user_guide/model>`.
:external+hyperspy:doc:`HyperSpy user guide <user_guide/model>`.

A detailed example is given in the ``Fitting_tutorial`` in the
`HyperSpy demos repository <https://github.com/hyperspy/hyperspy-demos>`_.
See also the `LumiSpy demo notebooks <https://github.com/LumiSpy/lumispy-demos>`_
for examples of data fitting.

.. Note::
The :ref:`jacobian` may affect the shape, in particular of broader peaks.
Expand All @@ -19,8 +24,7 @@ It can fit using both `uniform and and non-uniform axes

TODO: Show how to extract the *modeled signal* with all/one component.

See also the `LumiSpy demo notebooks <https://github.com/LumiSpy/lumispy-demos>`_
for examples of data fitting.


.. _fitting_variance:

Expand All @@ -31,4 +35,4 @@ TODO: Documentation on variance handling in the context of fitting,
in particular using :external:py:meth:`estimate_poissonian_noise_variance()
<hyperspy.signal.BaseSignal.estimate_poissonian_noise_variance>`

See [Tappy]_
For a detailed discussion, see [Tappy]_
6 changes: 3 additions & 3 deletions doc/source/user_guide/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ that can be described as multidimensional arrays of a given signal.

Notable features that **HyperSpy** provides are:

- :external+hyperspy:ref:`base signal classes <user_guide/signal>`
- :external+hyperspy:doc:`base signal classes <user_guide/signal>`
for the handling of (multidimensional) spectral data,
- the necessary tools for loading :external+hyperspy:ref:`various data file formats
<io>`,
- :external+hyperspy:ref:`analytical tools <user_guide/signal1d >`
- :external+hyperspy:doc:`analytical tools <user_guide/signal1d>`
that exploit the multidimensionality of datasets,
- a user-friendly and powerful framework for :external+hyperspy:ref:`model fitting
<model-label>` that
Expand Down Expand Up @@ -137,7 +137,7 @@ but also bug reports and feature requests from any other users. Don't hesitate
to join the discussions!

Currrently, we have implemented the base functionality that extends
`HyperSpy's capabilities <https://hyperspy.org/hyperspy-doc/current/index.html>`_
:external+hyperspy:ref:`HyperSpy's capabilities <user_guide-label>`
to additional signal classes. In the near future, the following functions
should be developed:

Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/metadata_structure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ LumiSpy metadata structure
LumiSpy extends the :external+hyperspy:ref:`HyperSpy metadata structure
<metadata_structure>`
with conventions for metadata specific to its signal types. Refer to the
:external+hyperspy:ref:`HyperSpy metadata documentation <user_guide/metadata_structure>`
:external+hyperspy:doc:`HyperSpy metadata documentation <user_guide/metadata_structure>`
for general metadata fields.

The metadata of any **signal objects** is stored in the `metadata` attribute,
Expand Down
2 changes: 1 addition & 1 deletion doc/source/user_guide/signal_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ This function also works for non-linear axes. For the
based on the function used to create the non-uniform axis. For
:external:py:class:`hyperspy.axes.DataAxis`, a linear interpolation between the
axes points at the center of mass is assumed, but this behaviour can be changed
with the `kwargs` of :external:py:meth:`scipy.interpolate.interp1d` function.
with the `kwargs` of :external:py:class:`scipy.interpolate.interp1d` function.

.. code-block:: python

Expand Down
1 change: 0 additions & 1 deletion lumispy/signals/cl_spectrum.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,6 @@ def remove_spikes(
interactive=False,
**kwargs
):

if luminescence_roi is not None and signal_mask is not None:
raise AttributeError(
"Only either `luminescence_roi` or the `signal_mask` can be an input."
Expand Down