.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXsensor.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXsensor (base class)
    ! sensor (base class)
    see: sensor (base class); NXsensor

.. _NXsensor:

========
NXsensor
========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: A sensor used to monitor an external condition ...

      A sensor used to monitor an external condition

      The condition itself is described in :ref:`NXenvironment`.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXgeometry`, :ref:`NXlog`, :ref:`NXoff_geometry`, :ref:`NXorientation`

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

**Structure**:

  .. _/NXsensor/model-field:

  .. index:: model (field)

  **model**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Sensor identification code/model number

  .. _/NXsensor/name-field:

  .. index:: name (field)

  **name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/name-field>`

    Name for the sensor

  .. _/NXsensor/short_name-field:

  .. index:: short_name (field)

  **short_name**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    Short name of sensor used e.g. on monitor display program

  .. _/NXsensor/attached_to-field:

  .. index:: attached_to (field)

  **attached_to**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    where sensor is attached to ("sample" | "can")

  .. _/NXsensor/measurement-field:

  .. index:: measurement (field)

  **measurement**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: name for measured signal ...

        name for measured signal

        Any of these values or a custom value (if you use a custom value, also set @custom=True):

          * ``temperature``

          * ``pH``

          * ``magnetic_field``

          * ``electric_field``

          * ``current``

          * ``conductivity``

          * ``resistance``

          * ``voltage``

          * ``pressure``

          * ``flow``

          * ``stress``

          * ``strain``

          * ``shear``

          * ``surface_pressure``


  .. _/NXsensor/type-field:

  .. index:: type (field)

  **type**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    .. collapse:: The type of hardware used for the measurement.   ...

        The type of hardware used for the measurement.  
        Examples (suggestions but not restrictions):

        :Temperature:
          J | K | T | E | R | S | Pt100 | Rh/Fe
        :pH:
          Hg/Hg2Cl2 | Ag/AgCl | ISFET
        :Ion selective electrode:
          specify species; e.g. Ca2+
        :Magnetic field:
          Hall
        :Surface pressure:
          wilhelmy plate

  .. _/NXsensor/run_control-field:

  .. index:: run_control (field)

  **run_control**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>` 

    .. collapse:: Is data collection controlled or synchronised to this quantity:  ...

        Is data collection controlled or synchronised to this quantity: 
        1=no, 0=to "value", 1=to "value_deriv1", etc.

  .. _/NXsensor/high_trip_value-field:

  .. index:: high_trip_value (field)

  **high_trip_value**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Upper control bound of sensor reading if using run_control

  .. _/NXsensor/low_trip_value-field:

  .. index:: low_trip_value (field)

  **low_trip_value**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Lower control bound of sensor reading if using run_control

  .. _/NXsensor/value-field:

  .. index:: value (field)

  **value**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [n]) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    .. collapse:: nominal setpoint or average value  ...

        nominal setpoint or average value 
        - need [n] as may be a vector

  .. _/NXsensor/value_deriv1-field:

  .. index:: value_deriv1 (field)

  **value_deriv1**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: same as field value, Dimensions: same as field value) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    .. collapse:: Nominal/average first derivative of value  ...

        Nominal/average first derivative of value 
        e.g. strain rate 
        - same dimensions as "value" (may be a vector)

  .. _/NXsensor/value_deriv2-field:

  .. index:: value_deriv2 (field)

  **value_deriv2**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: same as field value, Dimensions: same as field value) {units=\ :ref:`NX_ANY <NX_ANY>`} 

    .. collapse:: Nominal/average second derivative of value ...

        Nominal/average second derivative of value
        - same dimensions as "value" (may be a vector)

  .. _/NXsensor/external_field_brief-field:

  .. index:: external_field_brief (field)

  **external_field_brief**: (optional) :ref:`NX_CHAR <NX_CHAR>` 


    Any of these values:

      * ``along beam``

      * ``across beam``

      * ``transverse``

      * ``solenoidal``

      * ``flow shear gradient``

      * ``flow vorticity``


  .. _/NXsensor/depends_on-field:

  .. index:: depends_on (field)

  **depends_on**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/depends_on-field>`

    .. collapse::   Add a definition for the reference point of a sensor. ...

        .. todo::
          Add a definition for the reference point of a sensor.

  .. _/NXsensor/geometry-group:

  **geometry**: (optional) :ref:`NXgeometry` 


    .. index:: deprecated


    **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the beamstop and NXoff_geometry to describe its shape instead

    Defines the axes for logged vector quantities if they are not the global instrument axes.

  .. _/NXsensor/value_log-group:

  **value_log**: (optional) :ref:`NXlog` :ref:`⤆ </NXobject/GROUPNAME_log-group>`

    Time history of sensor readings

  .. _/NXsensor/value_deriv1_log-group:

  **value_deriv1_log**: (optional) :ref:`NXlog` :ref:`⤆ </NXobject/GROUPNAME_log-group>`

    Time history of first derivative of sensor readings

  .. _/NXsensor/value_deriv2_log-group:

  **value_deriv2_log**: (optional) :ref:`NXlog` :ref:`⤆ </NXobject/GROUPNAME_log-group>`

    Time history of second derivative of sensor readings

  .. _/NXsensor/external_field_full-group:

  **external_field_full**: (optional) :ref:`NXorientation` 

    For complex external fields not satisfied by External_field_brief

  .. _/NXsensor/OFF_GEOMETRY-group:

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

    This group describes the shape of the sensor when necessary.


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

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


* :ref:`/NXsensor/attached_to-field </NXsensor/attached_to-field>`
* :ref:`/NXsensor/depends_on-field </NXsensor/depends_on-field>`
* :ref:`/NXsensor/external_field_brief-field </NXsensor/external_field_brief-field>`
* :ref:`/NXsensor/external_field_full-group </NXsensor/external_field_full-group>`
* :ref:`/NXsensor/geometry-group </NXsensor/geometry-group>`
* :ref:`/NXsensor/high_trip_value-field </NXsensor/high_trip_value-field>`
* :ref:`/NXsensor/low_trip_value-field </NXsensor/low_trip_value-field>`
* :ref:`/NXsensor/measurement-field </NXsensor/measurement-field>`
* :ref:`/NXsensor/model-field </NXsensor/model-field>`
* :ref:`/NXsensor/name-field </NXsensor/name-field>`
* :ref:`/NXsensor/OFF_GEOMETRY-group </NXsensor/OFF_GEOMETRY-group>`
* :ref:`/NXsensor/run_control-field </NXsensor/run_control-field>`
* :ref:`/NXsensor/short_name-field </NXsensor/short_name-field>`
* :ref:`/NXsensor/type-field </NXsensor/type-field>`
* :ref:`/NXsensor/value-field </NXsensor/value-field>`
* :ref:`/NXsensor/value_deriv1-field </NXsensor/value_deriv1-field>`
* :ref:`/NXsensor/value_deriv1_log-group </NXsensor/value_deriv1_log-group>`
* :ref:`/NXsensor/value_deriv2-field </NXsensor/value_deriv2-field>`
* :ref:`/NXsensor/value_deriv2_log-group </NXsensor/value_deriv2_log-group>`
* :ref:`/NXsensor/value_log-group </NXsensor/value_log-group>`

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