.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXlauetof.nxdl.xml -- DO NOT EDIT .. index:: ! NXlauetof (application definition) ! lauetof (application definition) see: lauetof (application definition); NXlauetof .. _NXlauetof: ========= NXlauetof ========= .. Contributors List .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Russ Berg|RussBerg|https://avatars.githubusercontent.com/u/4698891?v=4|2020-11-19 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26 **Status**: application definition, extends :ref:`NXobject` **Description**: This is the application definition for a TOF laue diffractometer **Symbols**: The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nXPixels**: Number of X pixels **nYPixels**: Number of Y pixels **nTOF**: Time of flight **Groups cited**: :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXsample` .. index:: NXentry (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**: .. _/NXlauetof/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXlauetof/entry/definition-field: .. index:: definition (field) **definition**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Official NeXus NXDL schema to which this file conforms ... Official NeXus NXDL schema to which this file conforms Obligatory value: ``NXlauetof`` .. _/NXlauetof/entry/instrument-group: **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXlauetof/entry/instrument/detector-group: **detector**: (required) :ref:`NXdetector` :ref:`⤆ ` .. collapse:: This assumes a planar 2D detector. All angles and distances refer to the c ... This assumes a planar 2D detector. All angles and distances refer to the center of the detector. .. _/NXlauetof/entry/instrument/detector/polar_angle-field: .. index:: polar_angle (field) **polar_angle**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` The polar_angle (two theta) where the detector is placed. .. _/NXlauetof/entry/instrument/detector/azimuthal_angle-field: .. index:: azimuthal_angle (field) **azimuthal_angle**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` The azimuthal angle where the detector is placed. .. _/NXlauetof/entry/instrument/detector/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 3, Dimensions: [nXPixels, nYPixels, nTOF]) .. _/NXlauetof/entry/instrument/detector/data@signal-attribute: .. index:: signal (field attribute) **@signal**: (required) :ref:`NX_POSINT ` Obligatory value: ``1`` .. _/NXlauetof/entry/instrument/detector/x_pixel_size-field: .. index:: x_pixel_size (field) **x_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXlauetof/entry/instrument/detector/y_pixel_size-field: .. index:: y_pixel_size (field) **y_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXlauetof/entry/instrument/detector/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXlauetof/entry/instrument/detector/time_of_flight-field: .. index:: time_of_flight (field) **time_of_flight**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nTOF]) {units=\ :ref:`NX_TIME_OF_FLIGHT `} :ref:`⤆ ` .. _/NXlauetof/entry/sample-group: **sample**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXlauetof/entry/sample/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXlauetof/entry/sample/orientation_matrix-field: .. index:: orientation_matrix (field) **orientation_matrix**: (required) :ref:`NX_FLOAT ` (Rank: 2, Dimensions: [3, 3]) :ref:`⤆ ` .. collapse:: The orientation matrix according to Busing and ... The orientation matrix according to Busing and Levy conventions. This is not strictly necessary as the UB can always be derived from the data. But let us bow to common usage which includes thie UB nearly always. .. _/NXlauetof/entry/sample/unit_cell-field: .. index:: unit_cell (field) **unit_cell**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [6]) :ref:`⤆ ` .. collapse:: The unit cell, a, b, c, alpha, beta, gamma. ... The unit cell, a, b, c, alpha, beta, gamma. Again, not strictly necessary, but normally written. .. _/NXlauetof/entry/control-group: **control**: (required) :ref:`NXmonitor` :ref:`⤆ ` .. _/NXlauetof/entry/control/mode-field: .. index:: mode (field) **mode**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Count to a preset value based on either clock time (timer) or received mon ... Count to a preset value based on either clock time (timer) or received monitor counts (monitor). Any of these values: ``monitor`` | ``timer`` .. _/NXlauetof/entry/control/preset-field: .. index:: preset (field) **preset**: (required) :ref:`NX_FLOAT ` preset value for time or monitor .. _/NXlauetof/entry/control/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [nTOF]) use these attributes ``primary=1 signal=1`` .. _/NXlauetof/entry/control/time_of_flight-field: .. index:: time_of_flight (field) **time_of_flight**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nTOF]) {units=\ :ref:`NX_TIME_OF_FLIGHT `} :ref:`⤆ ` .. _/NXlauetof/entry/name-group: **name**: (required) :ref:`NXdata` :ref:`⤆ ` .. _/NXlauetof/entry/name/data-link: **data**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/NXdetector/data``) .. _/NXlauetof/entry/name/time_of_flight-link: **time_of_flight**: :ref:`link` (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:`/NXlauetof/entry-group ` * :ref:`/NXlauetof/entry/control-group ` * :ref:`/NXlauetof/entry/control/data-field ` * :ref:`/NXlauetof/entry/control/mode-field ` * :ref:`/NXlauetof/entry/control/preset-field ` * :ref:`/NXlauetof/entry/control/time_of_flight-field ` * :ref:`/NXlauetof/entry/definition-field ` * :ref:`/NXlauetof/entry/instrument-group ` * :ref:`/NXlauetof/entry/instrument/detector-group ` * :ref:`/NXlauetof/entry/instrument/detector/azimuthal_angle-field ` * :ref:`/NXlauetof/entry/instrument/detector/data-field ` * :ref:`/NXlauetof/entry/instrument/detector/data@signal-attribute ` * :ref:`/NXlauetof/entry/instrument/detector/distance-field ` * :ref:`/NXlauetof/entry/instrument/detector/polar_angle-field ` * :ref:`/NXlauetof/entry/instrument/detector/time_of_flight-field ` * :ref:`/NXlauetof/entry/instrument/detector/x_pixel_size-field ` * :ref:`/NXlauetof/entry/instrument/detector/y_pixel_size-field ` * :ref:`/NXlauetof/entry/name-group ` * :ref:`/NXlauetof/entry/name/data-link ` * :ref:`/NXlauetof/entry/name/time_of_flight-link ` * :ref:`/NXlauetof/entry/sample-group ` * :ref:`/NXlauetof/entry/sample/name-field ` * :ref:`/NXlauetof/entry/sample/orientation_matrix-field ` * :ref:`/NXlauetof/entry/sample/unit_cell-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXlauetof.nxdl.xml