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

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

.. _NXsqom:

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

..
    Contributors List

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28

    .. |contrib_name| replace:: Russ Berg|RussBerg|https://avatars.githubusercontent.com/u/4698891?v=4|2021-03-22

    .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15

    .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26

**Status**:

  application definition, extends :ref:`NXobject`

**Description**:

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

      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**:

  The symbol(s) listed here will be used below to coordinate datasets with the same shape.

  **nP**: Number of points

**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**:

  .. _/NXsqom/ENTRY-group:

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


    .. _/NXsqom/ENTRY@entry-attribute:

    .. index:: entry (group attribute)

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


    .. _/NXsqom/ENTRY/title-field:

    .. index:: title (field)

    **title**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/title-field>`


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

    .. index:: definition (field)

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

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

          Official NeXus NXDL schema to which this file conforms

          Obligatory value: ``NXsqom``

    .. _/NXsqom/ENTRY/instrument-group:

    **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ </NXentry/INSTRUMENT-group>`


      .. _/NXsqom/ENTRY/instrument/name-field:

      .. index:: name (field)

      **name**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXinstrument/name-field>`

        Name of the instrument from which this data was reduced.

      .. _/NXsqom/ENTRY/instrument/SOURCE-group:

      **SOURCE**: (required) :ref:`NXsource` :ref:`⤆ </NXinstrument/SOURCE-group>`


        .. _/NXsqom/ENTRY/instrument/SOURCE/type-field:

        .. index:: type (field)

        **type**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsource/type-field>`


        .. _/NXsqom/ENTRY/instrument/SOURCE/name-field:

        .. index:: name (field)

        **name**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsource/name-field>`


        .. _/NXsqom/ENTRY/instrument/SOURCE/probe-field:

        .. index:: probe (field)

        **probe**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsource/probe-field>`


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

    .. _/NXsqom/ENTRY/SAMPLE-group:

    **SAMPLE**: (required) :ref:`NXsample` :ref:`⤆ </NXentry/SAMPLE-group>`


      .. _/NXsqom/ENTRY/SAMPLE/name-field:

      .. index:: name (field)

      **name**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXsample/name-field>`

        Descriptive name of sample

    .. _/NXsqom/ENTRY/reduction-group:

    **reduction**: (required) :ref:`NXprocess` :ref:`⤆ </NXentry/PROCESS-group>`


      .. _/NXsqom/ENTRY/reduction/program-field:

      .. index:: program (field)

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


      .. _/NXsqom/ENTRY/reduction/version-field:

      .. index:: version (field)

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


      .. _/NXsqom/ENTRY/reduction/input-group:

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

        Input parameters for the reduction program used

        .. _/NXsqom/ENTRY/reduction/input/filenames-field:

        .. index:: filenames (field)

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

          Raw data files used to generate this I(Q)

      .. _/NXsqom/ENTRY/reduction/output-group:

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

        Eventual output parameters from the data reduction program used

    .. _/NXsqom/ENTRY/DATA-group:

    **DATA**: (required) :ref:`NXdata` :ref:`⤆ </NXentry/DATA-group>`


      .. _/NXsqom/ENTRY/DATA/data-field:

      .. index:: data (field)

      **data**: (required) :ref:`NX_INT <NX_INT>` (Rank: 1, Dimensions: [nP]) 

        This is the intensity for each point in QE

      .. _/NXsqom/ENTRY/DATA/qx-field:

      .. index:: qx (field)

      **qx**: (required) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_WAVENUMBER <NX_WAVENUMBER>`} 

        Positions for the first dimension of Q

      .. _/NXsqom/ENTRY/DATA/qy-field:

      .. index:: qy (field)

      **qy**: (required) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_WAVENUMBER <NX_WAVENUMBER>`} 

        Positions for the the second dimension of Q

      .. _/NXsqom/ENTRY/DATA/qz-field:

      .. index:: qz (field)

      **qz**: (required) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_WAVENUMBER <NX_WAVENUMBER>`} 

        Positions for the the third dimension of Q

      .. _/NXsqom/ENTRY/DATA/en-field:

      .. index:: en (field)

      **en**: (required) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} 

        Values for the energy transfer for each point


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

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


* :ref:`/NXsqom/ENTRY-group </NXsqom/ENTRY-group>`
* :ref:`/NXsqom/ENTRY/DATA-group </NXsqom/ENTRY/DATA-group>`
* :ref:`/NXsqom/ENTRY/DATA/data-field </NXsqom/ENTRY/DATA/data-field>`
* :ref:`/NXsqom/ENTRY/DATA/en-field </NXsqom/ENTRY/DATA/en-field>`
* :ref:`/NXsqom/ENTRY/DATA/qx-field </NXsqom/ENTRY/DATA/qx-field>`
* :ref:`/NXsqom/ENTRY/DATA/qy-field </NXsqom/ENTRY/DATA/qy-field>`
* :ref:`/NXsqom/ENTRY/DATA/qz-field </NXsqom/ENTRY/DATA/qz-field>`
* :ref:`/NXsqom/ENTRY/definition-field </NXsqom/ENTRY/definition-field>`
* :ref:`/NXsqom/ENTRY/instrument-group </NXsqom/ENTRY/instrument-group>`
* :ref:`/NXsqom/ENTRY/instrument/name-field </NXsqom/ENTRY/instrument/name-field>`
* :ref:`/NXsqom/ENTRY/instrument/SOURCE-group </NXsqom/ENTRY/instrument/SOURCE-group>`
* :ref:`/NXsqom/ENTRY/instrument/SOURCE/name-field </NXsqom/ENTRY/instrument/SOURCE/name-field>`
* :ref:`/NXsqom/ENTRY/instrument/SOURCE/probe-field </NXsqom/ENTRY/instrument/SOURCE/probe-field>`
* :ref:`/NXsqom/ENTRY/instrument/SOURCE/type-field </NXsqom/ENTRY/instrument/SOURCE/type-field>`
* :ref:`/NXsqom/ENTRY/reduction-group </NXsqom/ENTRY/reduction-group>`
* :ref:`/NXsqom/ENTRY/reduction/input-group </NXsqom/ENTRY/reduction/input-group>`
* :ref:`/NXsqom/ENTRY/reduction/input/filenames-field </NXsqom/ENTRY/reduction/input/filenames-field>`
* :ref:`/NXsqom/ENTRY/reduction/output-group </NXsqom/ENTRY/reduction/output-group>`
* :ref:`/NXsqom/ENTRY/reduction/program-field </NXsqom/ENTRY/reduction/program-field>`
* :ref:`/NXsqom/ENTRY/reduction/version-field </NXsqom/ENTRY/reduction/version-field>`
* :ref:`/NXsqom/ENTRY/SAMPLE-group </NXsqom/ENTRY/SAMPLE-group>`
* :ref:`/NXsqom/ENTRY/SAMPLE/name-field </NXsqom/ENTRY/SAMPLE/name-field>`
* :ref:`/NXsqom/ENTRY/title-field </NXsqom/ENTRY/title-field>`
* :ref:`/NXsqom/ENTRY@entry-attribute </NXsqom/ENTRY@entry-attribute>`

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