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

.. index::
    ! NXsqom (application definition)
    ! sqom (application definition)
    see: sqom (application definition); NXsqom

.. _NXsqom:

======
NXsqom
======

**Status**:

  application definition, extends :ref:`NXobject`

**Description**:

  This is the application definition for S(Q,OM) processed data.

  As this kind of data is in
  general not on a rectangular grid after data reduction, it is stored as Q,E positions plus their
  intensity, table like. It is the task of a possible visualisation program to regrid this data in
  a sensible way.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdata`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXparameters`, :ref:`NXprocess`, :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, NXsample (base class); used in application definition, NXprocess (base class); used in application definition, NXparameters (base class); used in application definition, NXdata (base class); used in application definition

**Structure**:

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


    .. index:: entry (group attribute)

    **@entry**: (required) :ref:`NX_CHAR <NX_CHAR>`


    .. index:: title (field)

    **title**: (required) :ref:`NX_CHAR <NX_CHAR>`


    .. index:: definition (field)

    **definition**: (required) :ref:`NX_CHAR <NX_CHAR>`

      Official NeXus NXDL schema to which this file conforms

      Obligatory value:  ``NXsqom``

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


      .. index:: name (field)

      **name**: (required) :ref:`NX_CHAR <NX_CHAR>`

        Name of the instrument from which this data was reduced.

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


        .. index:: type (field)

        **type**: (required) :ref:`NX_CHAR <NX_CHAR>`


        .. index:: name (field)

        **name**: (required) :ref:`NX_CHAR <NX_CHAR>`


        .. index:: probe (field)

        **probe**: (required) :ref:`NX_CHAR <NX_CHAR>`


          Any of these values: ``neutron`` | ``x-ray`` | ``electron``

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


      .. index:: name (field)

      **name**: (required) :ref:`NX_CHAR <NX_CHAR>`

        Descriptive name of sample

    **reduction**: (required) :ref:`NXprocess`


      .. index:: program (field)

      **program**: (required) :ref:`NX_CHAR <NX_CHAR>`


      .. index:: version (field)

      **version**: (required) :ref:`NX_CHAR <NX_CHAR>`


      **input**: (required) :ref:`NXparameters`

        Input parameters for the reduction program used

        .. index:: filenames (field)

        **filenames**: (required) :ref:`NX_CHAR <NX_CHAR>`

          Raw data files used to generate this I(Q)

      **output**: (required) :ref:`NXparameters`

        Eventual output parameters from the data reduction program used

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


      .. index:: data (field)

      **data[NP]**: (required) :ref:`NX_INT <NX_INT>`

        This is the intensity for each point in QE

      .. index:: qx (field)

      **qx[NP]**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_WAVENUMBER <NX_WAVENUMBER>`}

        Positions for the first dimension of Q

      .. index:: qy (field)

      **qy[NP]**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_WAVENUMBER <NX_WAVENUMBER>`}

        Positions for the the second dimension of Q

      .. index:: qz (field)

      **qz[NP]**: (required) :ref:`NX_CHAR <NX_CHAR>` {units=\ :ref:`NX_WAVENUMBER <NX_WAVENUMBER>`}

        Positions for the the third dimension of Q

      .. index:: en (field)

      **en[NP]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`}

        Values for the energy transfer for each point

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/applications/NXsqom.nxdl.xml