.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXxas_trans.nxdl.xml -- DO NOT EDIT .. index:: ! NXxas_trans (application definition) ! xas_trans (application definition) see: xas_trans (application definition); NXxas_trans .. _NXxas_trans: =========== NXxas_trans =========== **Status**: *application definition* (contribution), extends :ref:`NXxas` **Description**: .. collapse:: In transmission, the linear attenuation coefficient or absorption ... In transmission, the linear attenuation coefficient or absorption coefficient :math:`\mu(E)` is given by the Beer-Lambert law: .. math:: \mu(E)t = -\ln(I/I_0) where :math:`I` is the intensity of the transmitted beam, :math:`I_0` is the intensity of the incident beam, and :math:`t` is the thickness of the sample. The top-level :ref:`intensity ` field contains the processed absorption coefficient. When the raw detector data and processing steps are available, they can be stored in the optional ``NXinstrument``, ``NXcollection``, and ``NXprocess`` groups, enabling full reproducibility of the data reduction. **Symbols**: No symbol table **Groups cited**: :ref:`NXcollection`, :ref:`NXcrystal`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonochromator`, :ref:`NXnote`, :ref:`NXparameters`, :ref:`NXprocess`, :ref:`NXsource`, :ref:`NXsubentry` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXmonochromator (base class); used in application definition, NXcrystal (base class); used in application definition, NXdetector (base class); used in application definition, NXsubentry (base class); used in application definition, NXcollection (base class); used in application definition, NXprocess (base class); used in application definition, NXparameters (base class); used in application definition, NXnote (base class); used in application definition **Structure**: .. _/NXxas_trans/ENTRY-group: :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ ` .. _/NXxas_trans/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_trans`` .. _/NXxas_trans/ENTRY/intensity-field: .. index:: intensity (field) **intensity**: (required) :ref:`NX_FLOAT ` (Rank: dataRank, Dimensions: [nP, nEnergy]) {units=\ :ref:`NX_ANY `} :ref:`⤆ ` The absorption coefficient :math:`\mu(E)t = -\ln(I/I_0)`. .. _/NXxas_trans/ENTRY/INSTRUMENT-group: :bolditalic:`INSTRUMENT`: (recommended) :ref:`NXinstrument` :ref:`⤆ ` .. collapse:: The ``data`` field of each detector below holds the intensity ... The ``data`` field of each detector below holds the intensity used to compute the absorption coefficient and may already include corrections. If the uncorrected values are kept, they are archived in the ``NXcollection`` group and the corrections are described in ``NXprocess``. .. _/NXxas_trans/ENTRY/INSTRUMENT/SOURCE-group: :bolditalic:`SOURCE`: (recommended) :ref:`NXsource` :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/SOURCE/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/SOURCE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/SOURCE/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Obligatory value: ``x-ray`` .. _/NXxas_trans/ENTRY/INSTRUMENT/monochromator-group: **monochromator**: (recommended) :ref:`NXmonochromator` :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/monochromator/energy-field: .. index:: energy (field) **energy**: (recommended) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nEnergy]) {units=\ :ref:`NX_ENERGY `} :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal-group: **crystal**: (recommended) :ref:`NXcrystal` :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal/d_spacing-field: .. index:: d_spacing (field) **d_spacing**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` The spacing between crystal planes of the reflection .. _/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Type or material of monochromating substance ... Type or material of monochromating substance (Si, Ge, Multilayer). .. _/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal/reflection-field: .. index:: reflection (field) **reflection**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_UNITLESS `} :ref:`⤆ ` Miller indices (hkl) values of nominal reflection .. _/NXxas_trans/ENTRY/INSTRUMENT/i0-group: **i0**: (required) :ref:`NXdetector` :ref:`⤆ ` .. collapse:: Detector measuring the incident beam intensity ... Detector measuring the incident beam intensity :math:`I_0`. .. _/NXxas_trans/ENTRY/INSTRUMENT/i0/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` (Rank: dataRank, Dimensions: [nP, nEnergy]) :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/itrans-group: **itrans**: (required) :ref:`NXdetector` :ref:`⤆ ` .. collapse:: Detector measuring the transmitted beam intensity ... Detector measuring the transmitted beam intensity :math:`I`. .. _/NXxas_trans/ENTRY/INSTRUMENT/itrans/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` (Rank: dataRank, Dimensions: [nP, nEnergy]) :ref:`⤆ ` .. _/NXxas_trans/ENTRY/INSTRUMENT/iref-group: **iref**: (recommended) :ref:`NXdetector` :ref:`⤆ ` .. collapse:: Detector measuring the reference intensity ... Detector measuring the reference intensity :math:`I_{ref}`, placed after a reference sample (typically a metal foil). For a reference that is an independent spectrum probing a different absorbing element or absorption edge, use the ``reference`` subentry instead. .. _/NXxas_trans/ENTRY/INSTRUMENT/iref/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` (Rank: dataRank, Dimensions: [nP, nEnergy]) :ref:`⤆ ` .. _/NXxas_trans/ENTRY/reference-group: **reference**: (optional) :ref:`NXsubentry` :ref:`⤆ ` .. collapse:: An independent reference spectrum, for example a metal-foil ... An independent reference spectrum, for example a metal-foil standard used for energy calibration. Use this group instead of the ``iref`` detector when the reference is a complete spectrum in its own right, in particular when it probes a different absorbing element or absorption edge, so that the element, edge, energy axis, and intensity of the reference can be described in full. Provide the ``iref`` detector when the reference is a simultaneous transmission channel that shares the main energy axis. Provide this ``reference`` subentry when the reference is an independent measurement. Do not provide both for the same reference. .. _/NXxas_trans/ENTRY/reference/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Official NeXus NXDL schema to which this subentry conforms. ... Official NeXus NXDL schema to which this subentry conforms. Should be an ``NXxas``-family definition (for example ``NXxas`` or ``NXxas_trans``). .. _/NXxas_trans/ENTRY/COLLECTION-group: :bolditalic:`COLLECTION`: (optional) :ref:`NXcollection` :ref:`⤆ ` .. collapse:: Raw data as written by the acquisition software, ... Raw data as written by the acquisition software, preserved without modification to allow independent reprocessing. .. _/NXxas_trans/ENTRY/PROCESS-group: :bolditalic:`PROCESS`: (optional) :ref:`NXprocess` :ref:`⤆ ` .. collapse:: Description of how :ref:`intensity ... Description of how :ref:`intensity ` was obtained from the raw detector data (i0, itrans, and iref). When present, it allows a third party to fully reproduce the data reduction. .. _/NXxas_trans/ENTRY/PROCESS/program-field: .. index:: program (field) **program**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Name of the program used for processing. .. _/NXxas_trans/ENTRY/PROCESS/version-field: .. index:: version (field) **version**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Version of the program used for processing. .. _/NXxas_trans/ENTRY/PROCESS/date-field: .. index:: date (field) **date**: (optional) :ref:`NX_DATE_TIME ` :ref:`⤆ ` Date and time of processing. .. _/NXxas_trans/ENTRY/PROCESS/sequence_index-field: .. index:: sequence_index (field) **sequence_index**: (optional) :ref:`NX_POSINT ` :ref:`⤆ ` .. collapse:: Order of this step when several NXprocess groups ... Order of this step when several NXprocess groups describe a sequence of corrections. .. _/NXxas_trans/ENTRY/PROCESS/parameters-group: **parameters**: (optional) :ref:`NXparameters` :ref:`⤆ ` .. collapse:: Validated parameters of the corrections applied, for ... Validated parameters of the corrections applied, for example energy calibration, deglitching, incident-beam normalization, or scan merging. Each parameter should carry a units attribute where applicable. .. _/NXxas_trans/ENTRY/PROCESS/note-group: **note**: (optional) :ref:`NXnote` :ref:`⤆ ` .. collapse:: Code or notes reproducing the top-level :ref:`intensity ... Code or notes reproducing the top-level :ref:`intensity ` from the raw data. .. _/NXxas_trans/ENTRY/PROCESS/note/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Mime content type of the note data field. ... Mime content type of the note data field. Obligatory value: ``text/x-python`` .. _/NXxas_trans/ENTRY/PROCESS/note/data-field: .. index:: data (field) **data**: (required) :ref:`NX_CHAR ` The reproduction code or notes. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXxas_trans/ENTRY-group ` * :ref:`/NXxas_trans/ENTRY/COLLECTION-group ` * :ref:`/NXxas_trans/ENTRY/definition-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT-group ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/i0-group ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/i0/data-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/iref-group ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/iref/data-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/itrans-group ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/itrans/data-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/monochromator-group ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal-group ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal/d_spacing-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal/reflection-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/monochromator/crystal/type-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/monochromator/energy-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/SOURCE-group ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/SOURCE/name-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/SOURCE/probe-field ` * :ref:`/NXxas_trans/ENTRY/INSTRUMENT/SOURCE/type-field ` * :ref:`/NXxas_trans/ENTRY/intensity-field ` * :ref:`/NXxas_trans/ENTRY/PROCESS-group ` * :ref:`/NXxas_trans/ENTRY/PROCESS/date-field ` * :ref:`/NXxas_trans/ENTRY/PROCESS/note-group ` * :ref:`/NXxas_trans/ENTRY/PROCESS/note/data-field ` * :ref:`/NXxas_trans/ENTRY/PROCESS/note/type-field ` * :ref:`/NXxas_trans/ENTRY/PROCESS/parameters-group ` * :ref:`/NXxas_trans/ENTRY/PROCESS/program-field ` * :ref:`/NXxas_trans/ENTRY/PROCESS/sequence_index-field ` * :ref:`/NXxas_trans/ENTRY/PROCESS/version-field ` * :ref:`/NXxas_trans/ENTRY/reference-group ` * :ref:`/NXxas_trans/ENTRY/reference/definition-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXxas_trans.nxdl.xml