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

.. index::
    ! NXindirecttof (application definition)
    ! indirecttof (application definition)
    see: indirecttof (application definition); NXindirecttof

.. _NXindirecttof:

=============
NXindirecttof
=============

**Status**:

  application definition, extends :ref:`NXtofraw`

**Description**:

  This is a application definition for raw data from a direct geometry TOF spectrometer

**Symbols**:

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

  **nDet**: Number of detectors

**Groups cited**:
  :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonochromator`

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

**Structure**:

  .. _/NXindirecttof/entry-group:

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


    .. _/NXindirecttof/entry/title-field:

    .. index:: title (field)

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


    .. _/NXindirecttof/entry/start_time-field:

    .. index:: start_time (field)

    **start_time**: (required) :ref:`NX_DATE_TIME <NX_DATE_TIME>`


    .. _/NXindirecttof/entry/definition-field:

    .. index:: definition (field)

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

      Official NeXus NXDL schema to which this file conforms

      Obligatory value: ``NXindirecttof``

    .. _/NXindirecttof/entry/INSTRUMENT-group:

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


      .. _/NXindirecttof/entry/INSTRUMENT/analyser-group:

      **analyser**: (required) :ref:`NXmonochromator`


        .. _/NXindirecttof/entry/INSTRUMENT/analyser/energy-field:

        .. index:: energy (field)

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

          analyzed energy

        .. _/NXindirecttof/entry/INSTRUMENT/analyser/polar_angle-field:

        .. index:: polar_angle (field)

        **polar_angle**: (required) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nDet]) {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

          polar angle towards sample

        .. _/NXindirecttof/entry/INSTRUMENT/analyser/distance-field:

        .. index:: distance (field)

        **distance**: (required) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nDet]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

          distance from sample


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

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


* :ref:`/NXindirecttof/entry-group </NXindirecttof/entry-group>`
* :ref:`/NXindirecttof/entry/definition-field </NXindirecttof/entry/definition-field>`
* :ref:`/NXindirecttof/entry/INSTRUMENT-group </NXindirecttof/entry/INSTRUMENT-group>`
* :ref:`/NXindirecttof/entry/INSTRUMENT/analyser-group </NXindirecttof/entry/INSTRUMENT/analyser-group>`
* :ref:`/NXindirecttof/entry/INSTRUMENT/analyser/distance-field </NXindirecttof/entry/INSTRUMENT/analyser/distance-field>`
* :ref:`/NXindirecttof/entry/INSTRUMENT/analyser/energy-field </NXindirecttof/entry/INSTRUMENT/analyser/energy-field>`
* :ref:`/NXindirecttof/entry/INSTRUMENT/analyser/polar_angle-field </NXindirecttof/entry/INSTRUMENT/analyser/polar_angle-field>`
* :ref:`/NXindirecttof/entry/start_time-field </NXindirecttof/entry/start_time-field>`
* :ref:`/NXindirecttof/entry/title-field </NXindirecttof/entry/title-field>`

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