.. 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
=========

**Status**:

  base class, extends :ref:`NXcomponent`

**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`

.. index:: NXlog (base class); used in base class, NXgeometry (base class); used in base class, NXoff_geometry (base class); used in base class

**Structure**:

  .. _/NXmonitor/mode-field:

  .. index:: mode (field)

  **mode**: (optional) :ref:`NX_CHAR <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 <NX_DATE_TIME>` 

    Starting time of measurement

  .. _/NXmonitor/end_time-field:

  .. index:: end_time (field)

  **end_time**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>` 

    Ending time of measurement

  .. _/NXmonitor/preset-field:

  .. index:: preset (field)

  **preset**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    preset value for time or monitor

  .. _/NXmonitor/distance-field:

  .. index:: distance (field)

  **distance**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <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 <NX_FLOAT>` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_ANY <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 <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Nominal reading to be used for normalisation purposes.

  .. _/NXmonitor/integral-field:

  .. index:: integral (field)

  **integral**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Total integral monitor counts

  .. _/NXmonitor/type-field:

  .. index:: type (field)

  **type**: (optional) :ref:`NX_CHAR <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 <NX_FLOAT>` (Rank: same as field efficiency, Dimensions: same as field efficiency) {units=\ :ref:`NX_TIME_OF_FLIGHT <NX_TIME_OF_FLIGHT>`} 

    Time-of-flight

  .. _/NXmonitor/efficiency-field:

  .. index:: efficiency (field)

  **efficiency**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: same as field i, Dimensions: same as field i) {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    Monitor efficiency

  .. _/NXmonitor/data-field:

  .. index:: data (field)

  **data**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: dataRank) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Monitor data

  .. _/NXmonitor/sampled_fraction-field:

  .. index:: sampled_fraction (field)

  **sampled_fraction**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    Proportion of incident beam sampled by the monitor (0<x<1)

  .. _/NXmonitor/count_time-field:

  .. index:: count_time (field)

  **count_time**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TIME <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 <NX_CHAR>` :ref:`⤆ </NXcomponent/depends_on-field>`

    .. collapse:: The reference plane of the monitor contains the surface of the detector that f ...

        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` :ref:`⤆ </NXobject/GROUPNAME_log-group>`

    Time variation of monitor counts

  .. _/NXmonitor/GEOMETRY-group:

  :bolditalic:`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:

  :bolditalic:`OFF_GEOMETRY`: (optional) :ref:`NXoff_geometry` 

    This group describes the shape of the beam line component


Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXmonitor/count_time-field </NXmonitor/count_time-field>`
* :ref:`/NXmonitor/data-field </NXmonitor/data-field>`
* :ref:`/NXmonitor/depends_on-field </NXmonitor/depends_on-field>`
* :ref:`/NXmonitor/distance-field </NXmonitor/distance-field>`
* :ref:`/NXmonitor/efficiency-field </NXmonitor/efficiency-field>`
* :ref:`/NXmonitor/end_time-field </NXmonitor/end_time-field>`
* :ref:`/NXmonitor/GEOMETRY-group </NXmonitor/GEOMETRY-group>`
* :ref:`/NXmonitor/integral-field </NXmonitor/integral-field>`
* :ref:`/NXmonitor/integral_log-group </NXmonitor/integral_log-group>`
* :ref:`/NXmonitor/mode-field </NXmonitor/mode-field>`
* :ref:`/NXmonitor/nominal-field </NXmonitor/nominal-field>`
* :ref:`/NXmonitor/OFF_GEOMETRY-group </NXmonitor/OFF_GEOMETRY-group>`
* :ref:`/NXmonitor/preset-field </NXmonitor/preset-field>`
* :ref:`/NXmonitor/range-field </NXmonitor/range-field>`
* :ref:`/NXmonitor/sampled_fraction-field </NXmonitor/sampled_fraction-field>`
* :ref:`/NXmonitor/start_time-field </NXmonitor/start_time-field>`
* :ref:`/NXmonitor/time_of_flight-field </NXmonitor/time_of_flight-field>`
* :ref:`/NXmonitor/type-field </NXmonitor/type-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXmonitor.nxdl.xml