Skip to content

Commit

Permalink
Improve readability
Browse files Browse the repository at this point in the history
  • Loading branch information
pietsjoh committed Sep 27, 2022
1 parent abe16dd commit 2012e20
Show file tree
Hide file tree
Showing 3 changed files with 145 additions and 266 deletions.
14 changes: 2 additions & 12 deletions docs/supported_formats/jobin_yvon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,29 +25,19 @@ also uses the ``.xml`` file-extension.

The reader supports all signal axis units exported by LabSpec, i.e. wavelengths,
wavenumbers (absolute), Raman shift (relative wavenumbers),
as well as energy.
as well as energy.

.. Note::

The wavelength-to-energy conversion is not documented for LabSpec, i.e. it is
not clear whether the permittivity of air is taken into account. When working
not clear whether the refractive index of air is taken into account. When working
with energy axes, it is therefore recommended to import the data using the
wavelength axis and doing the `conversion using the LumiSpy package
<https://lumispy.readthedocs.io/en/latest/user_guide/signal_axis.html#the-energy-axis>`_.
Additionally, to our knowledge, LabSpec does not have an option to take into
account the `Jacobian transformation of the intensity
<https://lumispy.readthedocs.io/en/latest/user_guide/signal_axis.html#jacobian-transformation>`_.


Extra loading arguments
^^^^^^^^^^^^^^^^^^^^^^^

- ``use_uniform_signal_axis``: bool, default is False. This option decides whether to
use a uniform or non-uniform axis for the signal. If `True`, the axis is defined
only by an ``offset`` and a ``scale``. If `False`, the full ``axis`` vector is
loaded. When set to `True`, a warning message is printed in case the difference
between the first 2 and last 2 wavelengths exceeds 1%.

.. Note::

From LabSpec 6.3, an alternative export to an open HDF5 data format is
Expand Down
Loading

0 comments on commit 2012e20

Please sign in to comment.