.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source ../../../../applications/NXxas.nxdl.xml

.. index::
    ! NXxas (application definition)
    ! xas (application definition)
    see: xas (application definition); NXxas

.. _NXxas:

=====
NXxas
=====

**Status**:

  application definition, extends :ref:`NXobject`, version 1.0

**Description**:

  This is an application definition for raw data from an X-ray absorption 
  spectroscopy experiment. This is essentially a scan on energy versus incoming/ 
  absorbed beam.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXmonochromator`, :ref:`NXsample`, :ref:`NXsource`

.. 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, NXdetector (base class); used in application definition, NXsample (base class); used in application definition, NXmonitor (base class); used in application definition, NXdata (base class); used in application definition

**Structure**:

  **(entry)**: :ref:`NXentry`


    .. index:: entry (attribute)

    **@entry**: :ref:`NX_CHAR <NX_CHAR>`

      NeXus convention is to use "entry1", "entry2", ... 
      for analysis software to locate each entry.

    .. index:: title (data field)

    **title**: :ref:`NX_CHAR <NX_CHAR>`


    .. index:: start_time (data field)

    **start_time**: :ref:`NX_DATE_TIME <NX_DATE_TIME>`


    .. index:: definition (data field)

    **definition**: :ref:`NX_CHAR <NX_CHAR>`

      Official NeXus NXDL schema to which this file conforms

      Obligatory value:  ``NXxas``

    **(instrument)**: :ref:`NXinstrument`


      **(source)**: :ref:`NXsource`


        .. index:: type (data field)

        **type**: :ref:`NX_CHAR <NX_CHAR>`


        .. index:: name (data field)

        **name**: :ref:`NX_CHAR <NX_CHAR>`


        .. index:: probe (data field)

        **probe**: :ref:`NX_CHAR <NX_CHAR>`


          Obligatory value:  ``x-ray``

      **monochromator**: :ref:`NXmonochromator`


        .. index:: energy (data field)

        **energy[np]**: :ref:`NX_FLOAT <NX_FLOAT>`


      **incoming_beam**: :ref:`NXdetector`


        .. index:: data (data field)

        **data[np]**: :ref:`NX_INT <NX_INT>`


      **absorbed_beam**: :ref:`NXdetector`


        .. index:: data (data field)

        **data[np]**: :ref:`NX_INT <NX_INT>`

          mark this field with attribute  ``signal=1``

    **(sample)**: :ref:`NXsample`


      .. index:: name (data field)

      **name**: :ref:`NX_CHAR <NX_CHAR>`

        Descriptive name of sample

    **(monitor)**: :ref:`NXmonitor`


      .. index:: mode (data field)

      **mode**: :ref:`NX_CHAR <NX_CHAR>`

        Count to a preset value based on either clock time (timer)
        or received monitor counts (monitor).

        Any of these values: ``monitor`` | ``timer``

      .. index:: preset (data field)

      **preset**: :ref:`NX_FLOAT <NX_FLOAT>`

        preset value for time or monitor

      .. index:: data (data field)

      **data[np]**: :ref:`NX_INT <NX_INT>`


    **(data)**: :ref:`NXdata`


      **energy** --> /entry/instrument/monochromator/energy


      **absorbed_beam** --> /entry/instrument/absorbed_beam/data


**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/applications/NXxas.nxdl.xml