.. 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 ======== .. Contributors List .. |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:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 **Status**: base class, extends :ref:`NXobject` **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`, :ref:`NXtransformations` .. 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, NXtransformations (base class); used in base class **Structure**: .. _/NXsensor@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. .. _/NXsensor/model-field: .. index:: model (field) **model**: (optional) :ref:`NX_CHAR ` Sensor identification code/model number .. _/NXsensor/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Name for the sensor .. _/NXsensor/short_name-field: .. index:: short_name (field) **short_name**: (optional) :ref:`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 ` where sensor is attached to ("sample" | "can") .. _/NXsensor/measurement-field: .. index:: measurement (field) **measurement**: (optional) :ref:`NX_CHAR ` .. collapse:: name for measured signal ... name for measured signal Any of these values: * ``temperature`` * ``pH`` * ``magnetic_field`` * ``electric_field`` * ``conductivity`` * ``resistance`` * ``voltage`` * ``pressure`` * ``flow`` * ``stress`` * ``strain`` * ``shear`` * ``surface_pressure`` .. _/NXsensor/type-field: .. index:: type (field) **type**: (optional) :ref:`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 ` .. 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 ` {units=\ :ref:`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 ` {units=\ :ref:`NX_ANY `} Lower control bound of sensor reading if using run_control .. _/NXsensor/value-field: .. index:: value (field) **value**: (optional) :ref:`NX_FLOAT ` (Rank: 1, Dimensions: [n]) {units=\ :ref:`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 ` (Rank: same as field value, Dimensions: same as field value) {units=\ :ref:`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 ` (Rank: same as field value, Dimensions: same as field value) {units=\ :ref:`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 ` 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 ` .. 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. .. 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` Time history of sensor readings .. _/NXsensor/value_deriv1_log-group: **value_deriv1_log**: (optional) :ref:`NXlog` Time history of first derivative of sensor readings .. _/NXsensor/value_deriv2_log-group: **value_deriv2_log**: (optional) :ref:`NXlog` 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: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the sensor when necessary. .. _/NXsensor/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:`/NXsensor/attached_to-field ` * :ref:`/NXsensor/depends_on-field ` * :ref:`/NXsensor/external_field_brief-field ` * :ref:`/NXsensor/external_field_full-group ` * :ref:`/NXsensor/geometry-group ` * :ref:`/NXsensor/high_trip_value-field ` * :ref:`/NXsensor/low_trip_value-field ` * :ref:`/NXsensor/measurement-field ` * :ref:`/NXsensor/model-field ` * :ref:`/NXsensor/name-field ` * :ref:`/NXsensor/OFF_GEOMETRY-group ` * :ref:`/NXsensor/run_control-field ` * :ref:`/NXsensor/short_name-field ` * :ref:`/NXsensor/TRANSFORMATIONS-group ` * :ref:`/NXsensor/type-field ` * :ref:`/NXsensor/value-field ` * :ref:`/NXsensor/value_deriv1-field ` * :ref:`/NXsensor/value_deriv1_log-group ` * :ref:`/NXsensor/value_deriv2-field ` * :ref:`/NXsensor/value_deriv2_log-group ` * :ref:`/NXsensor/value_log-group ` * :ref:`/NXsensor@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXsensor.nxdl.xml