.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXsastof.nxdl.xml -- DO NOT EDIT .. index:: ! NXsastof (application definition) ! sastof (application definition) see: sastof (application definition); NXsastof .. _NXsastof: ======== NXsastof ======== .. 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-05 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 **Status**: application definition, extends :ref:`NXobject` **Description**: .. collapse:: raw, 2-D SAS data with an area detector with a time-of-flight source ... raw, 2-D SAS data with an area detector with a time-of-flight source It covers all raw data from any SAS techniques that use an area detector at a time-of-flight source. **Symbols**: The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nXPixel**: nXPixel description **nYPixel**: nYPixel description **nTOF**: nTOF description **Groups cited**: :ref:`NXcollimator`, :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXgeometry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXsample`, :ref:`NXshape`, :ref:`NXsource` .. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXcollimator (base class); used in application definition, NXgeometry (base class); used in application definition, NXshape (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**: .. _/NXsastof/ENTRY-group: **ENTRY**: (required) :ref:`NXentry` .. _/NXsastof/ENTRY@entry-attribute: .. index:: entry (group attribute) **@entry**: (required) :ref:`NX_CHAR ` NeXus convention is to use "entry1", "entry2", ... for analysis software to locate each entry .. _/NXsastof/ENTRY/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXsastof/ENTRY/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXsastof/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: ``NXsastof`` .. _/NXsastof/ENTRY/instrument-group: **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Name of the instrument actually used to perform the experiment .. _/NXsastof/ENTRY/instrument/source-group: **source**: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/source/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` type of radiation source .. _/NXsastof/ENTRY/instrument/source/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Name of the radiation source .. _/NXsastof/ENTRY/instrument/source/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``neutron`` | ``x-ray`` .. _/NXsastof/ENTRY/instrument/collimator-group: **collimator**: (required) :ref:`NXcollimator` :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/collimator/geometry-group: **geometry**: (required) :ref:`NXgeometry` :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/collimator/geometry/shape-group: **shape**: (required) :ref:`NXshape` :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/collimator/geometry/shape/shape-field: .. index:: shape (field) **shape**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``nxcylinder`` | ``nxbox`` .. _/NXsastof/ENTRY/instrument/collimator/geometry/shape/size-field: .. index:: size (field) **size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` The collimation length .. _/NXsastof/ENTRY/instrument/detector-group: **detector**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/detector/data-field: .. index:: data (field) **data**: (required) :ref:`NX_NUMBER ` (Rank: 3, Dimensions: [nXPixel, nYPixel, nTOF]) :ref:`⤆ ` .. collapse:: This is area detector data, of number of x-pixel versus ... This is area detector data, of number of x-pixel versus number of y-pixels. Since the beam center is to be determined as a step of data reduction, it is not necessary to document or assume the position of the beam center in acquired data. .. _/NXsastof/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:`⤆ ` .. _/NXsastof/ENTRY/instrument/detector/distance-field: .. index:: distance (field) **distance**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` The distance between detector and sample .. _/NXsastof/ENTRY/instrument/detector/x_pixel_size-field: .. index:: x_pixel_size (field) **x_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Physical size of a pixel in x-direction .. _/NXsastof/ENTRY/instrument/detector/y_pixel_size-field: .. index:: y_pixel_size (field) **y_pixel_size**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` Size of a pixel in y direction .. _/NXsastof/ENTRY/instrument/detector/polar_angle-field: .. index:: polar_angle (field) **polar_angle**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/detector/azimuthal_angle-field: .. index:: azimuthal_angle (field) **azimuthal_angle**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXsastof/ENTRY/instrument/detector/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXsastof/ENTRY/instrument/detector/aequatorial_angle-field: .. index:: aequatorial_angle (field) **aequatorial_angle**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXsastof/ENTRY/instrument/detector/beam_center_x-field: .. index:: beam_center_x (field) **beam_center_x**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. collapse:: This is the x position where the direct beam would hit the detector. Thi ... This is the x position where the direct beam would hit the detector. This is a length, not a pixel position, and can be outside of the actual detector. .. _/NXsastof/ENTRY/instrument/detector/beam_center_y-field: .. index:: beam_center_y (field) **beam_center_y**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} :ref:`⤆ ` .. collapse:: This is the y position where the direct beam would hit the detector. Thi ... This is the y position where the direct beam would hit the detector. This is a length, not a pixel position, and can be outside of the actual detector. .. _/NXsastof/ENTRY/sample-group: **sample**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXsastof/ENTRY/sample/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXsastof/ENTRY/sample/aequatorial_angle-field: .. index:: aequatorial_angle (field) **aequatorial_angle**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXsastof/ENTRY/control-group: **control**: (required) :ref:`NXmonitor` :ref:`⤆ ` .. _/NXsastof/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`` .. _/NXsastof/ENTRY/control/preset-field: .. index:: preset (field) **preset**: (required) :ref:`NX_FLOAT ` preset value for time or monitor .. _/NXsastof/ENTRY/control/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [nTOF]) .. _/NXsastof/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:`⤆ ` .. _/NXsastof/ENTRY/data-group: **data**: (required) :ref:`NXdata` :ref:`⤆ ` .. _/NXsastof/ENTRY/data/data-link: **data**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/NXdetector/data``) .. _/NXsastof/ENTRY/data/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:`/NXsastof/ENTRY-group ` * :ref:`/NXsastof/ENTRY/control-group ` * :ref:`/NXsastof/ENTRY/control/data-field ` * :ref:`/NXsastof/ENTRY/control/mode-field ` * :ref:`/NXsastof/ENTRY/control/preset-field ` * :ref:`/NXsastof/ENTRY/control/time_of_flight-field ` * :ref:`/NXsastof/ENTRY/data-group ` * :ref:`/NXsastof/ENTRY/data/data-link ` * :ref:`/NXsastof/ENTRY/data/time_of_flight-link ` * :ref:`/NXsastof/ENTRY/definition-field ` * :ref:`/NXsastof/ENTRY/instrument-group ` * :ref:`/NXsastof/ENTRY/instrument/collimator-group ` * :ref:`/NXsastof/ENTRY/instrument/collimator/geometry-group ` * :ref:`/NXsastof/ENTRY/instrument/collimator/geometry/shape-group ` * :ref:`/NXsastof/ENTRY/instrument/collimator/geometry/shape/shape-field ` * :ref:`/NXsastof/ENTRY/instrument/collimator/geometry/shape/size-field ` * :ref:`/NXsastof/ENTRY/instrument/detector-group ` * :ref:`/NXsastof/ENTRY/instrument/detector/aequatorial_angle-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/azimuthal_angle-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/beam_center_x-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/beam_center_y-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/data-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/distance-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/polar_angle-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/rotation_angle-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/time_of_flight-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/x_pixel_size-field ` * :ref:`/NXsastof/ENTRY/instrument/detector/y_pixel_size-field ` * :ref:`/NXsastof/ENTRY/instrument/name-field ` * :ref:`/NXsastof/ENTRY/instrument/source-group ` * :ref:`/NXsastof/ENTRY/instrument/source/name-field ` * :ref:`/NXsastof/ENTRY/instrument/source/probe-field ` * :ref:`/NXsastof/ENTRY/instrument/source/type-field ` * :ref:`/NXsastof/ENTRY/sample-group ` * :ref:`/NXsastof/ENTRY/sample/aequatorial_angle-field ` * :ref:`/NXsastof/ENTRY/sample/name-field ` * :ref:`/NXsastof/ENTRY/start_time-field ` * :ref:`/NXsastof/ENTRY/title-field ` * :ref:`/NXsastof/ENTRY@entry-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXsastof.nxdl.xml