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.

Sign up for GitHub

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

Add documentation and extend the XAS modes #5

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add documentation and extend the XAS modes #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a569c40
Add initial text for XAS absorption modes
mretegan Nov 21, 2024
3e46fe1
Added more detection modes
mretegan Nov 22, 2024
5ffe42b
List the modes in the documentation
mretegan Nov 26, 2024
a850c68
Remove empty line
mretegan Jan 20, 2025
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
1 change: 0 additions & 1 deletion applications/NXxas_new.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@
</group>
<group type="NXedge" name="edge">
<doc>Absorption edge</doc>

</group>
<field name="calculated" type="NX_BOOLEAN" units="NX_UNITLESS" optional="true">
<doc>Specify if the data commes from a calculation</doc>
Expand Down
88 changes: 73 additions & 15 deletions base_classes/NXxas_mode.nxdl.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,52 +27,110 @@
<doc>XAS measurement mode</doc>
<field name="name" type="NX_CHAR" minOccurs="1" maxOccurs="1">
<doc>
Name of the mode
X-ray absorption spectroscopy (XAS) is a technique that measures the absorption coefficient :math:`\mu(E)` of a material as a function of energy.

The name of the XAS mode indicates the type of process being monitored to obtain the spectrum. Below is a description of the available modes, with emphasis on the expected values for the `intensity` and `monitor` fields.

1. Transmission

The absorption coefficient is obtained by measuring the intensity of the incident :math:`I_0` and transmitted beam :math:`I`.

.. math::
\mu(E) = -\ln(I/I_0)

2. Total fluorescence yield (TFY)

The absorption coefficient is obtained by measuring the intensity of the emitted fluorescence :math:`I_f` and the incident beam :math:`I_0`.

.. math::
\mu(E) \propto I_f/I_0

3. Partial fluorescence yield (PFY)

4. Inverse partial fluorescence yield (IPFY)

5. High-energy resolution fluorescence detection (HERFD)

6. Total electron yield (TEY)

7. Partial electron yield (PEY)

8. Electron energy loss (EELS)

9. X-ray Raman Scattering (XRS)

10. Diffraction Anomalous Fine Structure (DAFS)

11. X-ray Excited Optical Luminescence (XEOL)

12. Grazing Angle Reflection Extended X-ray Absorption Fine Structure (ReflEXAFS)

13. Other
</doc>
<enumeration>
<item value="transmission">
<doc>
TODO
Transmission
</doc>
</item>
<item value="tfy">
<doc>
Total Fluorescence Yield
</doc>
</item>
<item value="fluorescence yield">
<item value="pfy">
<doc>
TODO total or partial fluorescence yield
Partial Fluorescence Yield
</doc>
</item>
<item value="ipfy">
<doc>
Inverse Partial Fluorescence Yield
</doc>
</item>
<item value="herfd">
<doc>
TODO high energy resolution fluorescence detected
High Energy Resolution Fluorescence Detected
</doc>
</item>
<item value="electron yield">
<item value="tey">
<doc>
TODO total or partial electron yield
Total Electron Yield
</doc>
</item>
<item value="luminescence">
<item value="pey">
<doc>
TODO
Partial Electron Yield
</doc>
</item>
<item value="x-ray Raman">
<item value="eels">
<doc>
TODO
Electron Energy Loss
</doc>
</item>
<item value="electron energy loss">
<item value="raman">
<doc>
TODO
X-ray Raman Scattering
</doc>
</item>
<item value="dafs">
<doc>
TODO
Diffraction Anomalous Fine Structure
</doc>
</item>
<item value="xeol">
<doc>
X-ray Excited Optical Luminescence
</doc>
</item>
<item value="reflexafs">
<doc>
Grazing Angle Reflection Extended X-ray Absorption Fine Structure
</doc>
</item>
<item value="other">
<doc>
TODO
Other
</doc>
</item>
</enumeration>
Expand Down
Loading