.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXtas.nxdl.xml -- DO NOT EDIT .. index:: ! NXtas (application definition) ! tas (application definition) see: tas (application definition); NXtas .. _NXtas: ===== NXtas ===== .. Contributors List .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Mark Koennecke|mkoennecke|https://avatars.githubusercontent.com/u/5029850?v=4|2021-05-06 .. |contrib_name| replace:: Russ Berg|RussBerg|https://avatars.githubusercontent.com/u/4698891?v=4|2020-11-05 .. |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**: .. collapse:: This is an application definition for a triple axis spectrometer. ... This is an application definition for a triple axis spectrometer. It is for the trademark scan of the TAS, the Q-E scan. For your alignment scans use the rules in :ref:`NXscan`. **Symbols**: The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nP**: Number of points **Groups cited**: :ref:`NXcrystal`, :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXsample`, :ref:`NXsource` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXcrystal (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**: .. _/NXtas/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXtas/entry/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtas/entry/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXtas/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: ``NXtas`` .. _/NXtas/entry/INSTRUMENT-group: **INSTRUMENT**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXtas/entry/INSTRUMENT/SOURCE-group: **SOURCE**: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXtas/entry/INSTRUMENT/SOURCE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXtas/entry/INSTRUMENT/SOURCE/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``neutron`` | ``x-ray`` .. _/NXtas/entry/INSTRUMENT/monochromator-group: **monochromator**: (required) :ref:`NXcrystal` :ref:`⤆ ` .. _/NXtas/entry/INSTRUMENT/monochromator/ei-field: .. index:: ei (field) **ei**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ENERGY `} .. _/NXtas/entry/INSTRUMENT/monochromator/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} .. _/NXtas/entry/INSTRUMENT/analyser-group: **analyser**: (required) :ref:`NXcrystal` :ref:`⤆ ` .. _/NXtas/entry/INSTRUMENT/analyser/ef-field: .. index:: ef (field) **ef**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ENERGY `} .. _/NXtas/entry/INSTRUMENT/analyser/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} .. _/NXtas/entry/INSTRUMENT/analyser/polar_angle-field: .. index:: polar_angle (field) **polar_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXtas/entry/INSTRUMENT/DETECTOR-group: **DETECTOR**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXtas/entry/INSTRUMENT/DETECTOR/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [nP]) .. _/NXtas/entry/INSTRUMENT/DETECTOR/polar_angle-field: .. index:: polar_angle (field) **polar_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXtas/entry/SAMPLE-group: **SAMPLE**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXtas/entry/SAMPLE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXtas/entry/SAMPLE/qh-field: .. index:: qh (field) **qh**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_DIMENSIONLESS `} .. _/NXtas/entry/SAMPLE/qk-field: .. index:: qk (field) **qk**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_DIMENSIONLESS `} .. _/NXtas/entry/SAMPLE/ql-field: .. index:: ql (field) **ql**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_DIMENSIONLESS `} .. _/NXtas/entry/SAMPLE/en-field: .. index:: en (field) **en**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ENERGY `} .. _/NXtas/entry/SAMPLE/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXtas/entry/SAMPLE/polar_angle-field: .. index:: polar_angle (field) **polar_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} .. _/NXtas/entry/SAMPLE/sgu-field: .. index:: sgu (field) **sgu**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} .. _/NXtas/entry/SAMPLE/sgl-field: .. index:: sgl (field) **sgl**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} .. _/NXtas/entry/SAMPLE/unit_cell-field: .. index:: unit_cell (field) **unit_cell**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [6]) {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXtas/entry/SAMPLE/orientation_matrix-field: .. index:: orientation_matrix (field) **orientation_matrix**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [9]) {units=\ :ref:`NX_DIMENSIONLESS `} :ref:`⤆ ` .. _/NXtas/entry/MONITOR-group: **MONITOR**: (required) :ref:`NXmonitor` :ref:`⤆ ` .. _/NXtas/entry/MONITOR/mode-field: .. index:: mode (field) **mode**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Count to a preset value based on either clock time (timer) ... Count to a preset value based on either clock time (timer) or received monitor counts (monitor). Any of these values: ``monitor`` | ``timer`` .. _/NXtas/entry/MONITOR/preset-field: .. index:: preset (field) **preset**: (required) :ref:`NX_FLOAT ` preset value for time or monitor .. _/NXtas/entry/MONITOR/data-field: .. index:: data (field) **data**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANY `} Total integral monitor counts .. _/NXtas/entry/DATA-group: **DATA**: (required) :ref:`NXdata` :ref:`⤆ ` One of the ei,ef,qh,qk,ql,en should get a primary=1 attribute to denote the main scan axis .. _/NXtas/entry/DATA/ei-link: **ei**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/monochromator:NXcrystal/ei``) .. _/NXtas/entry/DATA/ef-link: **ef**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/analyser:NXcrystal/ef``) .. _/NXtas/entry/DATA/en-link: **en**: :ref:`link` (suggested target: ``/NXentry/NXsample/en``) .. _/NXtas/entry/DATA/qh-link: **qh**: :ref:`link` (suggested target: ``/NXentry/NXsample/qh``) .. _/NXtas/entry/DATA/qk-link: **qk**: :ref:`link` (suggested target: ``/NXentry/NXsample/qk``) .. _/NXtas/entry/DATA/ql-link: **ql**: :ref:`link` (suggested target: ``/NXentry/NXsample/ql``) .. _/NXtas/entry/DATA/data-link: **data**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/NXdetector/data``) Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXtas/entry-group ` * :ref:`/NXtas/entry/DATA-group ` * :ref:`/NXtas/entry/DATA/data-link ` * :ref:`/NXtas/entry/DATA/ef-link ` * :ref:`/NXtas/entry/DATA/ei-link ` * :ref:`/NXtas/entry/DATA/en-link ` * :ref:`/NXtas/entry/DATA/qh-link ` * :ref:`/NXtas/entry/DATA/qk-link ` * :ref:`/NXtas/entry/DATA/ql-link ` * :ref:`/NXtas/entry/definition-field ` * :ref:`/NXtas/entry/INSTRUMENT-group ` * :ref:`/NXtas/entry/INSTRUMENT/analyser-group ` * :ref:`/NXtas/entry/INSTRUMENT/analyser/ef-field ` * :ref:`/NXtas/entry/INSTRUMENT/analyser/polar_angle-field ` * :ref:`/NXtas/entry/INSTRUMENT/analyser/rotation_angle-field ` * :ref:`/NXtas/entry/INSTRUMENT/DETECTOR-group ` * :ref:`/NXtas/entry/INSTRUMENT/DETECTOR/data-field ` * :ref:`/NXtas/entry/INSTRUMENT/DETECTOR/polar_angle-field ` * :ref:`/NXtas/entry/INSTRUMENT/monochromator-group ` * :ref:`/NXtas/entry/INSTRUMENT/monochromator/ei-field ` * :ref:`/NXtas/entry/INSTRUMENT/monochromator/rotation_angle-field ` * :ref:`/NXtas/entry/INSTRUMENT/SOURCE-group ` * :ref:`/NXtas/entry/INSTRUMENT/SOURCE/name-field ` * :ref:`/NXtas/entry/INSTRUMENT/SOURCE/probe-field ` * :ref:`/NXtas/entry/MONITOR-group ` * :ref:`/NXtas/entry/MONITOR/data-field ` * :ref:`/NXtas/entry/MONITOR/mode-field ` * :ref:`/NXtas/entry/MONITOR/preset-field ` * :ref:`/NXtas/entry/SAMPLE-group ` * :ref:`/NXtas/entry/SAMPLE/en-field ` * :ref:`/NXtas/entry/SAMPLE/name-field ` * :ref:`/NXtas/entry/SAMPLE/orientation_matrix-field ` * :ref:`/NXtas/entry/SAMPLE/polar_angle-field ` * :ref:`/NXtas/entry/SAMPLE/qh-field ` * :ref:`/NXtas/entry/SAMPLE/qk-field ` * :ref:`/NXtas/entry/SAMPLE/ql-field ` * :ref:`/NXtas/entry/SAMPLE/rotation_angle-field ` * :ref:`/NXtas/entry/SAMPLE/sgl-field ` * :ref:`/NXtas/entry/SAMPLE/sgu-field ` * :ref:`/NXtas/entry/SAMPLE/unit_cell-field ` * :ref:`/NXtas/entry/start_time-field ` * :ref:`/NXtas/entry/title-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXtas.nxdl.xml