.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXxas_tfy.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXxas_tfy (application definition)
    ! xas_tfy (application definition)
    see: xas_tfy (application definition); NXxas_tfy

.. _NXxas_tfy:

=========
NXxas_tfy
=========

**Status**:

  *application definition* (contribution), extends :ref:`NXxas`

**Description**:

  .. collapse:: In total fluorescence yield (TFY), the absorption coefficient ...

      In total fluorescence yield (TFY), the absorption coefficient
      :math:`\mu(E)` is proportional to the ratio of the total fluorescence
      intensity :math:`I_f` and the incident beam intensity :math:`I_0`:

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

      The total fluorescence signal is measured with a detector such as a
      photodiode that collects all emitted fluorescence without energy
      discrimination.

      The top-level :ref:`intensity </NXxas/ENTRY/intensity-field>`
      field contains the processed absorption coefficient. When the raw
      detector data and processing steps are available, they can be stored
      in the optional ``NXinstrument`` and ``NXprocess`` groups,
      enabling full reproducibility of the data reduction.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXprocess`

.. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXdetector (base class); used in application definition, NXprocess (base class); used in application definition

**Structure**:

  .. _/NXxas_tfy/ENTRY-group:

  :bolditalic:`ENTRY`: (required) :ref:`NXentry` :ref:`⤆ </NXxas/ENTRY-group>`


    .. _/NXxas_tfy/ENTRY/definition-field:

    .. index:: definition (field)

    **definition**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXxas/ENTRY/definition-field>`

      .. collapse:: Official NeXus NXDL schema to which this file conforms. ...

          Official NeXus NXDL schema to which this file conforms.

          Obligatory value: ``NXxas_tfy``

    .. _/NXxas_tfy/ENTRY/intensity-field:

    .. index:: intensity (field)

    **intensity**: (required) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nEnergy]) {units=\ :ref:`NX_ANY <NX_ANY>`} :ref:`⤆ </NXxas/ENTRY/intensity-field>`

      The absorption coefficient :math:`\mu(E) \propto I_f/I_0`.

    .. _/NXxas_tfy/ENTRY/INSTRUMENT-group:

    :bolditalic:`INSTRUMENT`: (optional) :ref:`NXinstrument` :ref:`⤆ </NXentry/INSTRUMENT-group>`


      .. _/NXxas_tfy/ENTRY/INSTRUMENT/i0-group:

      **i0**: (required) :ref:`NXdetector` :ref:`⤆ </NXinstrument/DETECTOR-group>`

        .. collapse:: Detector measuring the incident beam intensity ...

            Detector measuring the incident beam intensity
            :math:`I_0`.

        .. _/NXxas_tfy/ENTRY/INSTRUMENT/i0/data-field:

        .. index:: data (field)

        **data**: (required) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [nEnergy]) :ref:`⤆ </NXdetector/data-field>`


      .. _/NXxas_tfy/ENTRY/INSTRUMENT/ifluor-group:

      **ifluor**: (required) :ref:`NXdetector` :ref:`⤆ </NXinstrument/DETECTOR-group>`

        .. collapse:: Detector measuring the total fluorescence emission ...

            Detector measuring the total fluorescence emission
            :math:`I_f`.

        .. _/NXxas_tfy/ENTRY/INSTRUMENT/ifluor/data-field:

        .. index:: data (field)

        **data**: (required) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [nEnergy]) :ref:`⤆ </NXdetector/data-field>`


    .. _/NXxas_tfy/ENTRY/PROCESS-group:

    :bolditalic:`PROCESS`: (optional) :ref:`NXprocess` :ref:`⤆ </NXentry/PROCESS-group>`

      .. collapse:: Description of how :ref:`intensity ...

          Description of how :ref:`intensity
          </NXxas/ENTRY/intensity-field>` was obtained from
          the raw detector data (i0, if).

      .. _/NXxas_tfy/ENTRY/PROCESS/program-field:

      .. index:: program (field)

      **program**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXprocess/program-field>`

        Name of the program used for processing.

      .. _/NXxas_tfy/ENTRY/PROCESS/version-field:

      .. index:: version (field)

      **version**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXprocess/version-field>`

        Version of the program used for processing.

      .. _/NXxas_tfy/ENTRY/PROCESS/date-field:

      .. index:: date (field)

      **date**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>` :ref:`⤆ </NXprocess/date-field>`

        Date and time of processing.


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXxas_tfy/ENTRY-group </NXxas_tfy/ENTRY-group>`
* :ref:`/NXxas_tfy/ENTRY/definition-field </NXxas_tfy/ENTRY/definition-field>`
* :ref:`/NXxas_tfy/ENTRY/INSTRUMENT-group </NXxas_tfy/ENTRY/INSTRUMENT-group>`
* :ref:`/NXxas_tfy/ENTRY/INSTRUMENT/i0-group </NXxas_tfy/ENTRY/INSTRUMENT/i0-group>`
* :ref:`/NXxas_tfy/ENTRY/INSTRUMENT/i0/data-field </NXxas_tfy/ENTRY/INSTRUMENT/i0/data-field>`
* :ref:`/NXxas_tfy/ENTRY/INSTRUMENT/ifluor-group </NXxas_tfy/ENTRY/INSTRUMENT/ifluor-group>`
* :ref:`/NXxas_tfy/ENTRY/INSTRUMENT/ifluor/data-field </NXxas_tfy/ENTRY/INSTRUMENT/ifluor/data-field>`
* :ref:`/NXxas_tfy/ENTRY/intensity-field </NXxas_tfy/ENTRY/intensity-field>`
* :ref:`/NXxas_tfy/ENTRY/PROCESS-group </NXxas_tfy/ENTRY/PROCESS-group>`
* :ref:`/NXxas_tfy/ENTRY/PROCESS/date-field </NXxas_tfy/ENTRY/PROCESS/date-field>`
* :ref:`/NXxas_tfy/ENTRY/PROCESS/program-field </NXxas_tfy/ENTRY/PROCESS/program-field>`
* :ref:`/NXxas_tfy/ENTRY/PROCESS/version-field </NXxas_tfy/ENTRY/PROCESS/version-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXxas_tfy.nxdl.xml