.. auto-generated by dev_tools.docs.nxdl from the NXDL source applications/NXrefscan.nxdl.xml -- DO NOT EDIT .. index:: ! NXrefscan (application definition) ! refscan (application definition) see: refscan (application definition); NXrefscan .. _NXrefscan: ========= NXrefscan ========= .. 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 **Status**: application definition, extends :ref:`NXobject` **Description**: .. collapse:: This is an application definition for a monochromatic scanning reflectometer. ... This is an application definition for a monochromatic scanning reflectometer. It does not have the information to calculate the resolution since it does not have any apertures. **Symbols**: The symbol(s) listed here will be used below to coordinate datasets with the same shape. **nP**: Number of points **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**: .. _/NXrefscan/entry-group: **entry**: (required) :ref:`NXentry` .. _/NXrefscan/entry/title-field: .. index:: title (field) **title**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXrefscan/entry/start_time-field: .. index:: start_time (field) **start_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXrefscan/entry/end_time-field: .. index:: end_time (field) **end_time**: (required) :ref:`NX_DATE_TIME ` :ref:`⤆ ` .. _/NXrefscan/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: ``NXrefscan`` .. _/NXrefscan/entry/instrument-group: **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ ` .. _/NXrefscan/entry/instrument/SOURCE-group: **SOURCE**: (required) :ref:`NXsource` :ref:`⤆ ` .. _/NXrefscan/entry/instrument/SOURCE/type-field: .. index:: type (field) **type**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXrefscan/entry/instrument/SOURCE/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` .. _/NXrefscan/entry/instrument/SOURCE/probe-field: .. index:: probe (field) **probe**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Any of these values: ``neutron`` | ``x-ray`` | ``electron`` .. _/NXrefscan/entry/instrument/monochromator-group: **monochromator**: (required) :ref:`NXmonochromator` :ref:`⤆ ` .. _/NXrefscan/entry/instrument/monochromator/wavelength-field: .. index:: wavelength (field) **wavelength**: (required) :ref:`NX_FLOAT ` {units=\ :ref:`NX_WAVELENGTH `} :ref:`⤆ ` .. _/NXrefscan/entry/instrument/DETECTOR-group: **DETECTOR**: (required) :ref:`NXdetector` :ref:`⤆ ` .. _/NXrefscan/entry/instrument/DETECTOR/data-field: .. index:: data (field) **data**: (required) :ref:`NX_INT ` (Rank: 1, Dimensions: [nP]) .. _/NXrefscan/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:`⤆ ` .. _/NXrefscan/entry/sample-group: **sample**: (required) :ref:`NXsample` :ref:`⤆ ` .. _/NXrefscan/entry/sample/name-field: .. index:: name (field) **name**: (required) :ref:`NX_CHAR ` :ref:`⤆ ` Descriptive name of sample .. _/NXrefscan/entry/sample/rotation_angle-field: .. index:: rotation_angle (field) **rotation_angle**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE `} :ref:`⤆ ` .. _/NXrefscan/entry/control-group: **control**: (required) :ref:`NXmonitor` :ref:`⤆ ` .. _/NXrefscan/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`` .. _/NXrefscan/entry/control/preset-field: .. index:: preset (field) **preset**: (required) :ref:`NX_FLOAT ` preset value for time or monitor .. _/NXrefscan/entry/control/data-field: .. index:: data (field) **data**: (required) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANY `} Monitor counts for each step .. _/NXrefscan/entry/data-group: **data**: (required) :ref:`NXdata` :ref:`⤆ ` .. _/NXrefscan/entry/data/data-link: **data**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/NXdetector/data``) .. _/NXrefscan/entry/data/rotation_angle-link: **rotation_angle**: :ref:`link` (suggested target: ``/NXentry/NXsample/rotation_angle``) .. _/NXrefscan/entry/data/polar_angle-link: **polar_angle**: :ref:`link` (suggested target: ``/NXentry/NXinstrument/NXdetector/polar_angle``) Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXrefscan/entry-group ` * :ref:`/NXrefscan/entry/control-group ` * :ref:`/NXrefscan/entry/control/data-field ` * :ref:`/NXrefscan/entry/control/mode-field ` * :ref:`/NXrefscan/entry/control/preset-field ` * :ref:`/NXrefscan/entry/data-group ` * :ref:`/NXrefscan/entry/data/data-link ` * :ref:`/NXrefscan/entry/data/polar_angle-link ` * :ref:`/NXrefscan/entry/data/rotation_angle-link ` * :ref:`/NXrefscan/entry/definition-field ` * :ref:`/NXrefscan/entry/end_time-field ` * :ref:`/NXrefscan/entry/instrument-group ` * :ref:`/NXrefscan/entry/instrument/DETECTOR-group ` * :ref:`/NXrefscan/entry/instrument/DETECTOR/data-field ` * :ref:`/NXrefscan/entry/instrument/DETECTOR/polar_angle-field ` * :ref:`/NXrefscan/entry/instrument/monochromator-group ` * :ref:`/NXrefscan/entry/instrument/monochromator/wavelength-field ` * :ref:`/NXrefscan/entry/instrument/SOURCE-group ` * :ref:`/NXrefscan/entry/instrument/SOURCE/name-field ` * :ref:`/NXrefscan/entry/instrument/SOURCE/probe-field ` * :ref:`/NXrefscan/entry/instrument/SOURCE/type-field ` * :ref:`/NXrefscan/entry/sample-group ` * :ref:`/NXrefscan/entry/sample/name-field ` * :ref:`/NXrefscan/entry/sample/rotation_angle-field ` * :ref:`/NXrefscan/entry/start_time-field ` * :ref:`/NXrefscan/entry/title-field ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/applications/NXrefscan.nxdl.xml