.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXxas.nxdl.xml -- DO NOT EDIT .. index:: ! NXxas (application definition) ! xas (application definition) see: xas (application definition); NXxas .. _NXxas: ===== NXxas ===== **Status**: *application definition* (contribution), extends :ref:`NXobject` **Description**: .. collapse:: This is a generic application definition for X-ray absorption ... This is a generic application definition for X-ray absorption spectroscopy. Technique-specific application definitions extend this base definition. **Symbols**: .. collapse:: The symbol(s) listed here will be used below to coordinate datasets ... The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nP**: Number of stacked spectra (scan points). This is the growable first dimension: data could be appended along it during acquisition. It is absent when a single spectrum is stored. **nEnergy**: Number of energy data points **dataRank**: Rank of the ``intensity`` field: 1 for a single spectrum ``[nEnergy]`` or 2 for a stack of spectra ``[nP, nEnergy]``. **Groups cited**: :ref:`NXabsorption_edge`, :ref:`NXdata`, :ref:`NXelement`, :ref:`NXentry`, :ref:`NXsample` .. index:: NXentry (base class); used in application definition, NXelement (base class); used in application definition, NXabsorption_edge (base class); used in application definition, NXsample (base class); used in application definition, NXdata (base class); used in application definition **Structure**: .. _/NXxas/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` .. _/NXxas/ENTRY/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Official NeXus NXDL schema to which this file conforms. ... Official NeXus NXDL schema to which this file conforms. Obligatory value: ``NXxas`` .. _/NXxas/ENTRY/element-group: **element**: (required) :ref:`NXelement` The element being probed by the incident X-rays. .. _/NXxas/ENTRY/element/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` .. _/NXxas/ENTRY/edge-group: **edge**: (required) :ref:`NXabsorption_edge` .. collapse:: The absorption edge being probed, defined by the principal ... The absorption edge being probed, defined by the principal quantum number and orbital symmetry of the photoionized electron (e.g. K, L1, L2, L3, L2,3). Together with the element uniquely identifies probed electronic transition. .. _/NXxas/ENTRY/is_experimental-field: .. index:: is_experimental (field) **is_experimental**: (required) :ref:`NX_BOOLEAN ` .. collapse:: Specify if the data comes from an experiment. Use ``true`` for ... Specify if the data comes from an experiment. Use ``true`` for data acquired at a beamline or laboratory instrument, and ``false`` for spectra calculated/simulated using a computational tool, reconstructed from a linear combination of reference components, etc. .. _/NXxas/ENTRY/energy-field: .. index:: energy (field) **energy**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nEnergy]) {units=\ :ref:`NX_ENERGY `} The energy axis of the spectrum. .. _/NXxas/ENTRY/intensity-field: .. index:: intensity (field) **intensity**: (required) :ref:`NX_FLOAT ` (Rank: dataRank, Dimensions: [nP, nEnergy]) {units=\ :ref:`NX_ANY `} .. collapse:: The intensity of the spectrum. The precise definition of what is ... The intensity of the spectrum. The precise definition of what is meant by intensity depends on the acquisition mode, and will be specified by each subclass application definition. .. _/NXxas/ENTRY/intensity_errors-field: .. index:: intensity_errors (field) **intensity_errors**: (optional) :ref:`NX_FLOAT ` (Rank: dataRank, Dimensions: [nP, nEnergy]) {units=\ :ref:`NX_ANY `} The errors associated with the intensity of the spectrum. .. _/NXxas/ENTRY/SAMPLE-group: :bolditalic:`SAMPLE`: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXxas/ENTRY/SAMPLE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of the sample .. _/NXxas/ENTRY/SAMPLE/temperature-field: .. index:: temperature (field) **temperature**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_TEMPERATURE `} :ref:`⤆ ` Sample temperature. .. _/NXxas/ENTRY/DATA-group: :bolditalic:`DATA`: (optional) :ref:`NXdata` :ref:`⤆ ` .. collapse:: Plot of the X-ray absorption intensity versus energy. ... Plot of the X-ray absorption intensity versus energy. When several spectra are stacked along ``nP`` (a time series, a spatial map, an operando series, ...), the quantity that varies across the stack is stored in its standard NeXus location (for example ``NXsample/temperature``, ``NXsample/electric_field``, an ``NXsample/NXtransformations`` axis, or an ``NXbeam`` polarization field) and linked here as an additional axis with its ``AXISNAME_indices`` set to 0, the ``nP`` dimension. The application definition does not enumerate these coordinates: any of them, including ones not listed here, is declared simply by adding the field in its base-class location and wiring it into this group. .. _/NXxas/ENTRY/DATA/energy-field: .. index:: energy (field) **energy**: (required) :ref:`NX_CHAR ` .. _/NXxas/ENTRY/DATA/intensity-field: .. index:: intensity (field) **intensity**: (required) :ref:`NX_CHAR ` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXxas/ENTRY-group ` * :ref:`/NXxas/ENTRY/DATA-group ` * :ref:`/NXxas/ENTRY/DATA/energy-field ` * :ref:`/NXxas/ENTRY/DATA/intensity-field ` * :ref:`/NXxas/ENTRY/definition-field ` * :ref:`/NXxas/ENTRY/edge-group ` * :ref:`/NXxas/ENTRY/element-group ` * :ref:`/NXxas/ENTRY/element/name-field ` * :ref:`/NXxas/ENTRY/energy-field ` * :ref:`/NXxas/ENTRY/intensity-field ` * :ref:`/NXxas/ENTRY/intensity_errors-field ` * :ref:`/NXxas/ENTRY/is_experimental-field ` * :ref:`/NXxas/ENTRY/SAMPLE-group ` * :ref:`/NXxas/ENTRY/SAMPLE/name-field ` * :ref:`/NXxas/ENTRY/SAMPLE/temperature-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXxas.nxdl.xml