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

.. index::
    ! NXtofraw (application definition)
    ! tofraw (application definition)
    see: tofraw (application definition); NXtofraw

.. _NXtofraw:

========
NXtofraw
========

**Status**:

  application definition, extends :ref:`NXobject`

**Description**:

  This is an application definition for raw data from a generic TOF instrument

**Symbols**:

  No symbol table

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

.. index:: NXentry (base class); used in application definition, NXuser (base class); used in application definition, NXinstrument (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**: (required) :ref:`NXentry`


    .. index:: title (field)

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


    .. index:: start_time (field)

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


    .. index:: definition (field)

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

      Official NeXus NXDL schema to which this file conforms

      Obligatory value:  ``NXtofraw``

    .. index:: duration (field)

    **duration**: (required) :ref:`NX_FLOAT <NX_FLOAT>`


    .. index:: run_number (field)

    **run_number**: (required) :ref:`NX_INT <NX_INT>`


    .. index:: pre_sample_flightpath (field)

    **pre_sample_flightpath**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      This is the flight path before the sample position. This can be determined by a chopper,
      by the moderator, or the source itself. In other words: it is the distance to the component
      which gives the T0 signal to the detector electronics. If another component in the
      NXinstrument hierarchy provides this information, this should be a link.

    **user**: (required) :ref:`NXuser`


      .. index:: name (field)

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


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


      **detector**: (required) :ref:`NXdetector`


        .. index:: data (field)

        **data[ndet, ntimechan]**: (required) :ref:`NX_INT <NX_INT>`


        .. index:: detector_number (field)

        **detector_number[ndet]**: (required) :ref:`NX_INT <NX_INT>`


        .. index:: distance (field)

        **distance[ndet]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

          distance to sample for each detector

        .. index:: time_of_flight (field)

        **time_of_flight[ntimechan]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME_OF_FLIGHT <NX_TIME_OF_FLIGHT>`}


        .. index:: polar_angle (field)

        **polar_angle[ndet]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

          polar angle for each detector element

        .. index:: azimuthal_angle (field)

        **azimuthal_angle[ndet]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

          polar angle for each detector element

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


      .. index:: name (field)

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

        Descriptive name of sample

      .. index:: nature (field)

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


        Any of these values: ``powder`` | ``liquid`` | ``single crystal``

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


      .. index:: mode (field)

      **mode**: (required) :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 (field)

      **preset**: (required) :ref:`NX_FLOAT <NX_FLOAT>`

        preset value for time or monitor

      .. index:: distance (field)

      **distance**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}


      .. index:: data (field)

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


      .. index:: time_of_flight (field)

      **time_of_flight[ntimechan]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME_OF_FLIGHT <NX_TIME_OF_FLIGHT>`}


      .. index:: integral_counts (field)

      **integral_counts**: (required) :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}


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


      **data** --> /NXentry/NXinstrument/NXdetector/data


      **detector_number** --> /NXentry/NXinstrument/NXdetector/detector_number


      **time_of_flight** --> /NXentry/NXinstrument/NXdetector/time_of_flight


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