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

.. index::
    ! NXdirecttof (application definition)
    ! directtof (application definition)
    see: directtof (application definition); NXdirecttof

.. _NXdirecttof:

===========
NXdirecttof
===========

**Status**:

  application definition, extends :ref:`NXtofraw`

**Description**:

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

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdisk_chopper`, :ref:`NXentry`, :ref:`NXfermi_chopper`, :ref:`NXinstrument`

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

**Structure**:

  .. _/NXdirecttof/entry-group:

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


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

    .. index:: title (field)

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


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

    .. index:: start_time (field)

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


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

    .. index:: definition (field)

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

      Official NeXus NXDL schema to which this file conforms

      Obligatory value: ``NXdirecttof``

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

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

      We definitly want the rotation_speed and energy of the chopper. Thus either 
      a fermi_chopper or a disk_chopper group is required.

      .. _/NXdirecttof/entry/INSTRUMENT/fermi_chopper-group:

      **fermi_chopper**: (optional) :ref:`NXfermi_chopper`


        .. _/NXdirecttof/entry/INSTRUMENT/fermi_chopper/rotation_speed-field:

        .. index:: rotation_speed (field)

        **rotation_speed**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_FREQUENCY <NX_FREQUENCY>`}

          chopper rotation speed

        .. _/NXdirecttof/entry/INSTRUMENT/fermi_chopper/energy-field:

        .. index:: energy (field)

        **energy**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`}

          energy selected

      .. _/NXdirecttof/entry/INSTRUMENT/disk_chopper-group:

      **disk_chopper**: (optional) :ref:`NXdisk_chopper`


        .. _/NXdirecttof/entry/INSTRUMENT/disk_chopper/rotation_speed-field:

        .. index:: rotation_speed (field)

        **rotation_speed**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_FREQUENCY <NX_FREQUENCY>`}

          chopper rotation speed

        .. _/NXdirecttof/entry/INSTRUMENT/disk_chopper/energy-field:

        .. index:: energy (field)

        **energy**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`}

          energy selected


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

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


* :ref:`/NXdirecttof/entry-group </NXdirecttof/entry-group>`
* :ref:`/NXdirecttof/entry/definition-field </NXdirecttof/entry/definition-field>`
* :ref:`/NXdirecttof/entry/INSTRUMENT-group </NXdirecttof/entry/INSTRUMENT-group>`
* :ref:`/NXdirecttof/entry/INSTRUMENT/disk_chopper-group </NXdirecttof/entry/INSTRUMENT/disk_chopper-group>`
* :ref:`/NXdirecttof/entry/INSTRUMENT/disk_chopper/energy-field </NXdirecttof/entry/INSTRUMENT/disk_chopper/energy-field>`
* :ref:`/NXdirecttof/entry/INSTRUMENT/disk_chopper/rotation_speed-field </NXdirecttof/entry/INSTRUMENT/disk_chopper/rotation_speed-field>`
* :ref:`/NXdirecttof/entry/INSTRUMENT/fermi_chopper-group </NXdirecttof/entry/INSTRUMENT/fermi_chopper-group>`
* :ref:`/NXdirecttof/entry/INSTRUMENT/fermi_chopper/energy-field </NXdirecttof/entry/INSTRUMENT/fermi_chopper/energy-field>`
* :ref:`/NXdirecttof/entry/INSTRUMENT/fermi_chopper/rotation_speed-field </NXdirecttof/entry/INSTRUMENT/fermi_chopper/rotation_speed-field>`
* :ref:`/NXdirecttof/entry/start_time-field </NXdirecttof/entry/start_time-field>`
* :ref:`/NXdirecttof/entry/title-field </NXdirecttof/entry/title-field>`

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