.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXtofsingle.nxdl.xml .. index:: ! NXtofsingle (application definition) ! tofsingle (application definition) see: tofsingle (application definition); NXtofsingle .. _NXtofsingle: =========== NXtofsingle =========== **Status**: application definition, extends :ref:`NXobject` **Description**: This is a application definition for raw data from a generic TOF instrument **Symbols**: The symbol(s) listed here will be used below to coordinate datasets with the same shape. **xSize**: xSize description **ySize**: ySize description **nDet**: Number of detectors **nTimeChan**: nTimeChan description **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**: .. _/NXtofsingle/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXtofsingle/entry/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` .. _/NXtofsingle/entry/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` .. _/NXtofsingle/entry/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` Official NeXus NXDL schema to which this file conforms Obligatory value: ``NXtofsingle`` .. _/NXtofsingle/entry/duration-field: .. index:: duration (field) **duration**: (required) :ref:`NX_FLOAT ` .. _/NXtofsingle/entry/pre_sample_flightpath-field: .. index:: pre_sample_flightpath (field) **pre_sample_flightpath**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`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 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. .. _/NXtofsingle/entry/user-group: **user**: (required) :ref:`NXuser` .. _/NXtofsingle/entry/user/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` .. _/NXtofsingle/entry/INSTRUMENT-group: **INSTRUMENT**: (required) :ref:`NXinstrument` .. _/NXtofsingle/entry/INSTRUMENT/detector-group: **detector**: (required) :ref:`NXdetector` .. _/NXtofsingle/entry/INSTRUMENT/detector/data-field: .. index:: data (field) **data[xSize, ySize, nTimeChan]**: (required) :ref:`NX_INT ` .. _/NXtofsingle/entry/INSTRUMENT/detector/distance-field: .. index:: distance (field) **distance[1]**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Distance to sample for the center of the detector .. _/NXtofsingle/entry/INSTRUMENT/detector/time_of_flight-field: .. index:: time_of_flight (field) **time_of_flight[nTimeChan]**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME_OF_FLIGHT `} .. _/NXtofsingle/entry/INSTRUMENT/detector/polar_angle-field: .. index:: polar_angle (field) **polar_angle[nDet]**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} polar angle for each detector element .. _/NXtofsingle/entry/INSTRUMENT/detector/azimuthal_angle-field: .. index:: azimuthal_angle (field) **azimuthal_angle[nDet]**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} azimuthal angle for each detector element .. _/NXtofsingle/entry/SAMPLE-group: **SAMPLE**: (required) :ref:`NXsample` .. _/NXtofsingle/entry/SAMPLE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` Descriptive name of sample .. _/NXtofsingle/entry/SAMPLE/nature-field: .. index:: nature (field) **nature**: (required) :ref:`NX_CHAR ` Any of these values: ``powder`` | ``liquid`` | ``single crystal`` .. _/NXtofsingle/entry/MONITOR-group: **MONITOR**: (required) :ref:`NXmonitor` .. _/NXtofsingle/entry/MONITOR/mode-field: .. index:: mode (field) **mode**: (required) :ref:`NX_CHAR ` Count to a preset value based on either clock time (timer) or received monitor counts (monitor). Any of these values: ``monitor`` | ``timer`` .. _/NXtofsingle/entry/MONITOR/preset-field: .. index:: preset (field) **preset**: (required) :ref:`NX_FLOAT ` preset value for time or monitor .. _/NXtofsingle/entry/MONITOR/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXtofsingle/entry/MONITOR/data-field: .. index:: data (field) **data[nTimeChan]**: (required) :ref:`NX_INT ` .. _/NXtofsingle/entry/MONITOR/time_of_flight-field: .. index:: time_of_flight (field) **time_of_flight[nTimeChan]**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_TIME_OF_FLIGHT `} .. _/NXtofsingle/entry/data-group: **data**: (required) :ref:`NXdata` .. _/NXtofsingle/entry/data/data-link: **data**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/NXdetector/data``) .. _/NXtofsingle/entry/data/time_of_flight-link: **time_of_flight**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/NXdetector/time_of_flight``) Hypertext Anchors ----------------- Table of hypertext anchors for all groups, fields, attributes, and links defined in this class. ================================================================================================================================== ================================================================================================================================== documentation (reST source) anchor web page (HTML) anchor ================================================================================================================================== ================================================================================================================================== :ref:`/NXtofsingle/entry-group ` :ref:`#nxtofsingle-entry-group ` :ref:`/NXtofsingle/entry/data-group ` :ref:`#nxtofsingle-entry-data-group ` :ref:`/NXtofsingle/entry/data/data-link ` :ref:`#nxtofsingle-entry-data-data-link ` :ref:`/NXtofsingle/entry/data/time_of_flight-link ` :ref:`#nxtofsingle-entry-data-time-of-flight-link ` :ref:`/NXtofsingle/entry/definition-field ` :ref:`#nxtofsingle-entry-definition-field ` :ref:`/NXtofsingle/entry/duration-field ` :ref:`#nxtofsingle-entry-duration-field ` :ref:`/NXtofsingle/entry/INSTRUMENT-group ` :ref:`#nxtofsingle-entry-instrument-group ` :ref:`/NXtofsingle/entry/INSTRUMENT/detector-group ` :ref:`#nxtofsingle-entry-instrument-detector-group ` :ref:`/NXtofsingle/entry/INSTRUMENT/detector/azimuthal_angle-field ` :ref:`#nxtofsingle-entry-instrument-detector-azimuthal-angle-field ` :ref:`/NXtofsingle/entry/INSTRUMENT/detector/data-field ` :ref:`#nxtofsingle-entry-instrument-detector-data-field ` :ref:`/NXtofsingle/entry/INSTRUMENT/detector/distance-field ` :ref:`#nxtofsingle-entry-instrument-detector-distance-field ` :ref:`/NXtofsingle/entry/INSTRUMENT/detector/polar_angle-field ` :ref:`#nxtofsingle-entry-instrument-detector-polar-angle-field ` :ref:`/NXtofsingle/entry/INSTRUMENT/detector/time_of_flight-field ` :ref:`#nxtofsingle-entry-instrument-detector-time-of-flight-field ` :ref:`/NXtofsingle/entry/MONITOR-group ` :ref:`#nxtofsingle-entry-monitor-group ` :ref:`/NXtofsingle/entry/MONITOR/data-field ` :ref:`#nxtofsingle-entry-monitor-data-field ` :ref:`/NXtofsingle/entry/MONITOR/distance-field ` :ref:`#nxtofsingle-entry-monitor-distance-field ` :ref:`/NXtofsingle/entry/MONITOR/mode-field ` :ref:`#nxtofsingle-entry-monitor-mode-field ` :ref:`/NXtofsingle/entry/MONITOR/preset-field ` :ref:`#nxtofsingle-entry-monitor-preset-field ` :ref:`/NXtofsingle/entry/MONITOR/time_of_flight-field ` :ref:`#nxtofsingle-entry-monitor-time-of-flight-field ` :ref:`/NXtofsingle/entry/pre_sample_flightpath-field ` :ref:`#nxtofsingle-entry-pre-sample-flightpath-field ` :ref:`/NXtofsingle/entry/SAMPLE-group ` :ref:`#nxtofsingle-entry-sample-group ` :ref:`/NXtofsingle/entry/SAMPLE/name-field ` :ref:`#nxtofsingle-entry-sample-name-field ` :ref:`/NXtofsingle/entry/SAMPLE/nature-field ` :ref:`#nxtofsingle-entry-sample-nature-field ` :ref:`/NXtofsingle/entry/start_time-field ` :ref:`#nxtofsingle-entry-start-time-field ` :ref:`/NXtofsingle/entry/title-field ` :ref:`#nxtofsingle-entry-title-field ` :ref:`/NXtofsingle/entry/user-group ` :ref:`#nxtofsingle-entry-user-group ` :ref:`/NXtofsingle/entry/user/name-field ` :ref:`#nxtofsingle-entry-user-name-field ` ================================================================================================================================== ================================================================================================================================== **NXDL Source**: https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/applications/NXtofsingle.nxdl.xml