.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXmonitor.nxdl.xml -- DO NOT EDIT .. index:: ! NXmonitor (base class) ! monitor (base class) see: monitor (base class); NXmonitor .. _NXmonitor: ========= NXmonitor ========= .. Contributors List .. |contrib_name| replace:: Woutdenolf|woutdenolf|https://avatars.githubusercontent.com/u/7264703?v=4|2023-06-16 .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2022-09-28 .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15 .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Benajamin|benajamin|https://avatars.githubusercontent.com/u/10222548?v=4|2015-04-27 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26 **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: A monitor of incident beam data. ... A monitor of incident beam data. It is similar to the :ref:`NXdata` groups containing monitor data and its associated axis coordinates, e.g. time_of_flight or wavelength in pulsed neutron instruments. However, it may also include integrals, or scalar monitor counts, which are often used in both in both pulsed and steady-state instrumentation. **Symbols**: No symbol table **Groups cited**: :ref:`NXgeometry`, :ref:`NXlog`, :ref:`NXoff_geometry`, :ref:`NXtransformations` .. index:: NXlog (base class); used in base class, NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXmonitor@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. index:: plotting Declares which child group contains a path leading to a :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/NXmonitor/mode-field: .. index:: mode (field) **mode**: (optional) :ref:`NX_CHAR ` .. 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`` .. _/NXmonitor/start_time-field: .. index:: start_time (field) **start_time**: (optional) :ref:`NX_DATE_TIME ` Starting time of measurement .. _/NXmonitor/end_time-field: .. index:: end_time (field) **end_time**: (optional) :ref:`NX_DATE_TIME ` Ending time of measurement .. _/NXmonitor/preset-field: .. index:: preset (field) **preset**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} preset value for time or monitor .. _/NXmonitor/distance-field: .. index:: distance (field) **distance**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. index:: deprecated **DEPRECATED**: Use transformations/distance instead Distance of monitor from sample .. _/NXmonitor/range-field: .. index:: range (field) **range**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_ANY `} Range (X-axis, Time-of-flight, etc.) over which the integral was calculated .. _/NXmonitor/nominal-field: .. index:: nominal (field) **nominal**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Nominal reading to be used for normalisation purposes. .. _/NXmonitor/integral-field: .. index:: integral (field) **integral**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} Total integral monitor counts .. _/NXmonitor/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` Any of these values: ``Fission Chamber`` | ``Scintillator`` .. _/NXmonitor/time_of_flight-field: .. index:: time_of_flight (field) **time_of_flight**: (optional) :ref:`NX_FLOAT ` (Rank: same as field efficiency, Dimensions: same as field efficiency) {units=\ :ref:`NX_TIME_OF_FLIGHT `} Time-of-flight .. _/NXmonitor/efficiency-field: .. index:: efficiency (field) **efficiency**: (optional) :ref:`NX_NUMBER ` (Rank: same as field i, Dimensions: same as field i) {units=\ :ref:`NX_DIMENSIONLESS `} Monitor efficiency .. _/NXmonitor/data-field: .. index:: data (field) **data**: (optional) :ref:`NX_NUMBER ` (Rank: dataRank) {units=\ :ref:`NX_ANY `} Monitor data .. _/NXmonitor/sampled_fraction-field: .. index:: sampled_fraction (field) **sampled_fraction**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_DIMENSIONLESS `} Proportion of incident beam sampled by the monitor (0` {units=\ :ref:`NX_TIME `} .. collapse:: Elapsed actual counting time, can be an array of size ``np`` ... Elapsed actual counting time, can be an array of size ``np`` when scanning. This is not the difference of the calendar time but the time the instrument was really counting, without pauses or times lost due beam unavailability .. _/NXmonitor/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: NeXus positions components by applying a set of translations and rotations ... NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere. The reference plane of the monitor contains the surface of the detector that faces the source and is the entry point of the beam. The reference point of the monitor in the x and y axis is its centre on this surface. The reference plane is orthogonal to the the z axis and the reference point on this z axis is where they intersect. .. image:: monitor/monitor.png :width: 40% .. _/NXmonitor/integral_log-group: **integral_log**: (optional) :ref:`NXlog` Time variation of monitor counts .. _/NXmonitor/GEOMETRY-group: **GEOMETRY**: (optional) :ref:`NXgeometry` .. index:: deprecated **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the monitor and NXoff_geometry to describe its shape instead Geometry of the monitor .. _/NXmonitor/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXmonitor/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: This is the group recommended for holding the chain of translation ... This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXmonitor/count_time-field ` * :ref:`/NXmonitor/data-field ` * :ref:`/NXmonitor/depends_on-field ` * :ref:`/NXmonitor/distance-field ` * :ref:`/NXmonitor/efficiency-field ` * :ref:`/NXmonitor/end_time-field ` * :ref:`/NXmonitor/GEOMETRY-group ` * :ref:`/NXmonitor/integral-field ` * :ref:`/NXmonitor/integral_log-group ` * :ref:`/NXmonitor/mode-field ` * :ref:`/NXmonitor/nominal-field ` * :ref:`/NXmonitor/OFF_GEOMETRY-group ` * :ref:`/NXmonitor/preset-field ` * :ref:`/NXmonitor/range-field ` * :ref:`/NXmonitor/sampled_fraction-field ` * :ref:`/NXmonitor/start_time-field ` * :ref:`/NXmonitor/time_of_flight-field ` * :ref:`/NXmonitor/TRANSFORMATIONS-group ` * :ref:`/NXmonitor/type-field ` * :ref:`/NXmonitor@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXmonitor.nxdl.xml