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

.. index::
    ! NXreftof (application definition)
    ! reftof (application definition)
    see: reftof (application definition); NXreftof

.. _NXreftof:

========
NXreftof
========

**Status**:

  application definition, extends :ref:`NXobject`

**Description**:

  This is an application definition for raw data from a TOF reflectometer.

**Symbols**:

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

  **xSize**: xSize description

  **ySize**: ySize description

  **nTOF**: nTOF description

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

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

  .. _/NXreftof/entry-group:

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


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

    .. index:: title (field)

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


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

    .. index:: start_time (field)

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


    .. _/NXreftof/entry/end_time-field:

    .. index:: end_time (field)

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


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

    .. index:: definition (field)

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

      Official NeXus NXDL schema to which this file conforms

      Obligatory value: ``NXreftof``

    .. _/NXreftof/entry/instrument-group:

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


      .. _/NXreftof/entry/instrument/name-field:

      .. index:: name (field)

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


      .. _/NXreftof/entry/instrument/chopper-group:

      **chopper**: (required) :ref:`NXdisk_chopper`


        .. _/NXreftof/entry/instrument/chopper/distance-field:

        .. index:: distance (field)

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

          Distance between chopper and sample

      .. _/NXreftof/entry/instrument/detector-group:

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


        .. _/NXreftof/entry/instrument/detector/data-field:

        .. index:: data (field)

        **data**: (required) :ref:`NX_INT <NX_INT>` (Rank: 3, Dimensions: [xSize, ySize, nTOF])


        .. _/NXreftof/entry/instrument/detector/time_of_flight-field:

        .. index:: time_of_flight (field)

        **time_of_flight**: (required) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nTOF]) {units=\ :ref:`NX_TIME_OF_FLIGHT <NX_TIME_OF_FLIGHT>`}

          Array of time values for each bin in a time-of-flight
          measurement

        .. _/NXreftof/entry/instrument/detector/distance-field:

        .. index:: distance (field)

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


        .. _/NXreftof/entry/instrument/detector/polar_angle-field:

        .. index:: polar_angle (field)

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


        .. _/NXreftof/entry/instrument/detector/x_pixel_size-field:

        .. index:: x_pixel_size (field)

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


        .. _/NXreftof/entry/instrument/detector/y_pixel_size-field:

        .. index:: y_pixel_size (field)

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


    .. _/NXreftof/entry/sample-group:

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


      .. _/NXreftof/entry/sample/name-field:

      .. index:: name (field)

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

        Descriptive name of sample

      .. _/NXreftof/entry/sample/rotation_angle-field:

      .. index:: rotation_angle (field)

      **rotation_angle**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}


    .. _/NXreftof/entry/control-group:

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


      .. _/NXreftof/entry/control/mode-field:

      .. 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``

      .. _/NXreftof/entry/control/preset-field:

      .. index:: preset (field)

      **preset**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`}

        preset value for time or monitor

      .. _/NXreftof/entry/control/integral-field:

      .. index:: integral (field)

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

        Total integral monitor counts

      .. _/NXreftof/entry/control/time_of_flight-field:

      .. index:: time_of_flight (field)

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

        Time channels

      .. _/NXreftof/entry/control/data-field:

      .. index:: data (field)

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

        Monitor counts in each time channel

    .. _/NXreftof/entry/data-group:

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


      .. _/NXreftof/entry/data/data-link:

      **data**: :ref:`link<Design-Links>` (suggested target: ``/NXentry/NXinstrument/NXdetector/data``


      .. _/NXreftof/entry/data/time_of_flight-link:

      **time_of_flight**: :ref:`link<Design-Links>` (suggested target: ``/NXentry/NXinstrument/NXdetector/time_of_flight``



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

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


* :ref:`/NXreftof/entry-group </NXreftof/entry-group>`
* :ref:`/NXreftof/entry/control-group </NXreftof/entry/control-group>`
* :ref:`/NXreftof/entry/control/data-field </NXreftof/entry/control/data-field>`
* :ref:`/NXreftof/entry/control/integral-field </NXreftof/entry/control/integral-field>`
* :ref:`/NXreftof/entry/control/mode-field </NXreftof/entry/control/mode-field>`
* :ref:`/NXreftof/entry/control/preset-field </NXreftof/entry/control/preset-field>`
* :ref:`/NXreftof/entry/control/time_of_flight-field </NXreftof/entry/control/time_of_flight-field>`
* :ref:`/NXreftof/entry/data-group </NXreftof/entry/data-group>`
* :ref:`/NXreftof/entry/data/data-link </NXreftof/entry/data/data-link>`
* :ref:`/NXreftof/entry/data/time_of_flight-link </NXreftof/entry/data/time_of_flight-link>`
* :ref:`/NXreftof/entry/definition-field </NXreftof/entry/definition-field>`
* :ref:`/NXreftof/entry/end_time-field </NXreftof/entry/end_time-field>`
* :ref:`/NXreftof/entry/instrument-group </NXreftof/entry/instrument-group>`
* :ref:`/NXreftof/entry/instrument/chopper-group </NXreftof/entry/instrument/chopper-group>`
* :ref:`/NXreftof/entry/instrument/chopper/distance-field </NXreftof/entry/instrument/chopper/distance-field>`
* :ref:`/NXreftof/entry/instrument/detector-group </NXreftof/entry/instrument/detector-group>`
* :ref:`/NXreftof/entry/instrument/detector/data-field </NXreftof/entry/instrument/detector/data-field>`
* :ref:`/NXreftof/entry/instrument/detector/distance-field </NXreftof/entry/instrument/detector/distance-field>`
* :ref:`/NXreftof/entry/instrument/detector/polar_angle-field </NXreftof/entry/instrument/detector/polar_angle-field>`
* :ref:`/NXreftof/entry/instrument/detector/time_of_flight-field </NXreftof/entry/instrument/detector/time_of_flight-field>`
* :ref:`/NXreftof/entry/instrument/detector/x_pixel_size-field </NXreftof/entry/instrument/detector/x_pixel_size-field>`
* :ref:`/NXreftof/entry/instrument/detector/y_pixel_size-field </NXreftof/entry/instrument/detector/y_pixel_size-field>`
* :ref:`/NXreftof/entry/instrument/name-field </NXreftof/entry/instrument/name-field>`
* :ref:`/NXreftof/entry/sample-group </NXreftof/entry/sample-group>`
* :ref:`/NXreftof/entry/sample/name-field </NXreftof/entry/sample/name-field>`
* :ref:`/NXreftof/entry/sample/rotation_angle-field </NXreftof/entry/sample/rotation_angle-field>`
* :ref:`/NXreftof/entry/start_time-field </NXreftof/entry/start_time-field>`
* :ref:`/NXreftof/entry/title-field </NXreftof/entry/title-field>`

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