NXxps sub app-def

contributed_definitions/NXxps.nxdl.xml

@@ -0,0 +1,170 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<?xml-stylesheet type="text/xsl" href="nxdlformat.xsl"?>
+<!--
+# NeXus - Neutron and X-ray Common Data Format
+#
+# Copyright (C) 2014-2024 NeXus International Advisory Committee (NIAC)
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 3 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+#
+# For further information, see http://www.nexusformat.org
+-->
+<definition xmlns="http://definition.nexusformat.org/nxdl/3.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" category="application" type="group" name="NXxps" extends="NXmpes" xsi:schemaLocation="http://definition.nexusformat.org/nxdl/3.1 ../nxdl.xsd">
+    <doc>
+         This is the application definition for X-ray photoelectron spectroscopy.
+    </doc>
+    <group type="NXentry">
+        <field name="definition" type="NX_CHAR">
+            <enumeration>
+                <item value="NXxps"/>
+            </enumeration>
+        </field>
+        <field name="method" recommended="true">
+            <doc>
+                 A name of the experimental method according to `Clause 11`_ of
+                 the `ISO 18115-1:2023`_ specification.
+
+                 Examples for XPS-related experiments include:
+                     * X-ray photoelectron spectroscopy (XPS)
+                     * angle-resolved X-ray photoelectron spectroscopy (ARXPS)
+                     * ultraviolet photoelectron spectroscopy (UPS)
+                     * hard X-ray photoemission spectroscopy (HAXPES)
+                     * near ambient pressure X-ray photoelectron spectroscopy (NAPXPS)
+                     * electron spectroscopy for chemical analysis (ESCA)
+
+                 .. _ISO 18115-1:2023: https://www.iso.org/standard/74811.html
+                 .. _Clause 11: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:sec:11
+            </doc>
+        </field>
+        <group name="geometries" type="NXcoordinate_system_set">
+            <field name="coordinate_system" type="NX_coordinate_system">
+                <doc>
+                     Description of the XPS base coordinate system, which is defined such that the positive z-axis
+                     points towards the analyzer entry, and the x-axis lies within the beam/analyzer plane.
+                </doc>
+                <field name="origin">
+                    <enumeration>
+                        <item value="beam/analyzer plane"/>
+                    </enumeration>
+                </field>
+                <field name="handedness">
+                    <enumeration>
+                        <item value="right_handed"/>
+                    </enumeration>
+                </field>
+                <field name="z_direction">
+                    <enumeration>
+                        <item value="analyzer entry axis"/>
+                    </enumeration>
+                </field>
+            </field>
+        </group>
+        <group type="NXtransformations">
+            <doc>
+                 Set of transformations, describing the orientation of the XPS coordinate system with respect to
+                  the beam coordinate system (.). These should be links towards the NXtransformations instances
+                  defined on the individual parts of NXinstrument.
+            </doc>
+        </group>
+        <group type="NXinstrument">
+            <doc>
+                 XPS spectrometer
+            </doc>
+            <group type="NXelectronanalyser">
+                <field name="depends_on" recommended="true">
+                    <doc>
+                         Reference to the transformation describing the orientation of the analyzer
+                         relative to the beam.
+                    </doc>
+                </field>
+                <group type="NXtransformations">
+                    <field name="angle_beam_analyser" type="NX_NUMBER" recommended="true" units="NX_ANGLE">
+                        <doc>
+                             Angle between incoming beam and the center analyser axis.
+                        </doc>
+                        <attribute name="transformation_type">
+                            <enumeration>
+                                <item value="rotation"/>
+                            </enumeration>
+                        </attribute>
+                        <link name="depends_on" target="/entry/instrument/geometries/coordinate_system">
+                            <doc>
+                                 Link to the XPS base coordinate system.
+                            </doc>
+                        </link>
+                    </field>
+                </group>
+            </group>
+            <group type="NXenergydispersion">
+                <field name="scheme">
+                    <enumeration>
+                        <item value="hemispherical"/>
+                        <item value="double hemispherical"/>
+                        <item value="cylindrical mirror"/>
+                    </enumeration>
+                </field>
+                <field name="energy_scan_mode">
+                    <enumeration>
+                        <item value="fixed_analyser_transmission"/>
+                        <item value="fixed_retardation_ratio"/>
+                        <item value="fixed_energy"/>
+                        <item value="snapshot"/>
+                    </enumeration>
+                </field>
+                <field name="diameter" type="NX_FLOAT" recommended="true"/>
+            </group>
+        </group>
+        <group type="NXsample">
+            <field name="depends_on" type="NX_CHAR" recommended="true">
+                <doc>
+                     Reference to the transformation describing the orientation of the sample
+                     relative to the beam.
+                </doc>
+            </field>
+            <group type="NXtransformations">
+                <field name="angle_beam_sample" type="NX_NUMBER" recommended="true" units="NX_ANGLE">
+                    <doc>
+                         Angle between incoming beam and the sample.
+                    </doc>
+                    <attribute name="transformation_type">
+                        <enumeration>
+                            <item value="rotation"/>
+                        </enumeration>
+                    </attribute>
+                    <link name="depends_on" target="/entry/instrument/geometries/coordinate_system">
+                        <doc>
+                             Link to the XPS base coordinate system.
+                        </doc>
+                    </link>
+                </field>
+            </group>
+        </group>
+        <group type="NXdata">
+            <attribute name="signal">
+                <enumeration>
+                    <item value="data"/>
+                </enumeration>
+            </attribute>
+            <field name="data" type="NX_NUMBER" units="NX_ANY">
+                <doc>
+                     Represents a measure of one- or more-dimensional photoemission counts, where the
+                     varied axis may be for example energy, pump-probe delay, temperature, etc.
+                     The axes traces should be linked to the actual encoder position in NXinstrument
+                     or calibrated axes in NXprocess.
+                </doc>
+            </field>
+        </group>
+    </group>
+</definition>