.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXxbase.nxdl.xml -- DO NOT EDIT .. index:: ! NXxbase (application definition) ! xbase (application definition) see: xbase (application definition); NXxbase .. _NXxbase: ======= NXxbase ======= .. 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:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2014-09-23 .. |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 definition covers the common parts of all monochromatic single crystal raw data application definitions. **Symbols**: The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nP**: Number of points **nXPixels**: Number of X pixels **nYPixels**: Number of Y pixels **Groups cited**: :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXmonochromator`, :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, NXmonochromator (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**: .. _/NXxbase/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXxbase/entry/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXxbase/entry/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXxbase/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: ``NXxbase`` .. _/NXxbase/entry/instrument-group: **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXxbase/entry/instrument/source-group: **source**: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXxbase/entry/instrument/source/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXxbase/entry/instrument/source/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXxbase/entry/instrument/source/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``neutron`` | ``x-ray`` | ``electron`` .. _/NXxbase/entry/instrument/monochromator-group: **monochromator**: (required) :ref:`NXmonochromator` :ref:`⤆ ` .. _/NXxbase/entry/instrument/monochromator/wavelength-field: .. index:: wavelength (field) **wavelength**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} :ref:`⤆ ` .. _/NXxbase/entry/instrument/detector-group: **detector**: (required) :ref:`NXdetector` :ref:`⤆ ` .. collapse:: The name of the group is detector if there is only one detector, ... The name of the group is detector if there is only one detector, if there are several, names have to be detector1, detector2, ...detectorn. .. _/NXxbase/entry/instrument/detector/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 3, Dimensions: [nP, nXPixels, nYPixels]) .. collapse:: The area detector data, the first dimension is always the ... The area detector data, the first dimension is always the number of scan points, the second and third are the number of pixels in x and y. The origin is always assumed to be in the center of the detector. maxOccurs is limited to the the number of detectors on your instrument. .. _/NXxbase/entry/instrument/detector/data@signal-attribute: .. index:: signal (field attribute) **@signal**: (required) :ref:`NX_POSINT ` Obligatory value: ``1`` .. _/NXxbase/entry/instrument/detector/x_pixel_size-field: .. index:: x_pixel_size (field) **x_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXxbase/entry/instrument/detector/y_pixel_size-field: .. index:: y_pixel_size (field) **y_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXxbase/entry/instrument/detector/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. _/NXxbase/entry/instrument/detector/frame_start_number-field: .. index:: frame_start_number (field) **frame_start_number**: (required) :ref:`NX_INT ` :ref:`⤆ ` .. collapse:: This is the start number of the first frame of a scan. In PX one often s ... This is the start number of the first frame of a scan. In PX one often scans a couple of frames on a give sample, then does something else, then returns to the same sample and scans some more frames. Each time with a new data file. This number helps concatenating such measurements. .. _/NXxbase/entry/sample-group: **sample**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXxbase/entry/sample/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXxbase/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 the UB nearly always. .. _/NXxbase/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. .. _/NXxbase/entry/sample/temperature-field: .. index:: temperature (field) **temperature**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) :ref:`⤆ ` The sample temperature or whatever sensor represents this value best .. _/NXxbase/entry/sample/x_translation-field: .. index:: x_translation (field) **x_translation**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Translation of the sample along the X-direction of the laboratory coordinate system .. _/NXxbase/entry/sample/y_translation-field: .. index:: y_translation (field) **y_translation**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Translation of the sample along the Y-direction of the laboratory coordinate system .. _/NXxbase/entry/sample/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Translation of the sample along the Z-direction of the laboratory coordinate system .. _/NXxbase/entry/control-group: **control**: (required) :ref:`NXmonitor` :ref:`⤆ ` .. _/NXxbase/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) ... Count to a preset value based on either clock time (timer) or received monitor counts (monitor). Any of these values: ``monitor`` | ``timer`` .. _/NXxbase/entry/control/preset-field: .. index:: preset (field) **preset**: (required) :ref:`NX_FLOAT ` preset value for time or monitor .. _/NXxbase/entry/control/integral-field: .. index:: integral (field) **integral**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANY `} Total integral monitor counts .. _/NXxbase/entry/DATA-group: **DATA**: (required) :ref:`NXdata` :ref:`⤆ ` .. collapse:: The name of this group id data if there is only ... The name of this group id data if there is only one detector; if there are several the names will be data1, data2, data3 and will point to the corresponding detector groups in the instrument hierarchy. .. _/NXxbase/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:`/NXxbase/entry-group ` * :ref:`/NXxbase/entry/control-group ` * :ref:`/NXxbase/entry/control/integral-field ` * :ref:`/NXxbase/entry/control/mode-field ` * :ref:`/NXxbase/entry/control/preset-field ` * :ref:`/NXxbase/entry/DATA-group ` * :ref:`/NXxbase/entry/DATA/data-link ` * :ref:`/NXxbase/entry/definition-field ` * :ref:`/NXxbase/entry/instrument-group ` * :ref:`/NXxbase/entry/instrument/detector-group ` * :ref:`/NXxbase/entry/instrument/detector/data-field ` * :ref:`/NXxbase/entry/instrument/detector/data@signal-attribute ` * :ref:`/NXxbase/entry/instrument/detector/distance-field ` * :ref:`/NXxbase/entry/instrument/detector/frame_start_number-field ` * :ref:`/NXxbase/entry/instrument/detector/x_pixel_size-field ` * :ref:`/NXxbase/entry/instrument/detector/y_pixel_size-field ` * :ref:`/NXxbase/entry/instrument/monochromator-group ` * :ref:`/NXxbase/entry/instrument/monochromator/wavelength-field ` * :ref:`/NXxbase/entry/instrument/source-group ` * :ref:`/NXxbase/entry/instrument/source/name-field ` * :ref:`/NXxbase/entry/instrument/source/probe-field ` * :ref:`/NXxbase/entry/instrument/source/type-field ` * :ref:`/NXxbase/entry/sample-group ` * :ref:`/NXxbase/entry/sample/distance-field ` * :ref:`/NXxbase/entry/sample/name-field ` * :ref:`/NXxbase/entry/sample/orientation_matrix-field ` * :ref:`/NXxbase/entry/sample/temperature-field ` * :ref:`/NXxbase/entry/sample/unit_cell-field ` * :ref:`/NXxbase/entry/sample/x_translation-field ` * :ref:`/NXxbase/entry/sample/y_translation-field ` * :ref:`/NXxbase/entry/start_time-field ` * :ref:`/NXxbase/entry/title-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXxbase.nxdl.xml