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

.. index::
    ! NXspm_temperature_sensor (base class)
    ! spm_temperature_sensor (base class)
    see: spm_temperature_sensor (base class); NXspm_temperature_sensor

.. _NXspm_temperature_sensor:

========================
NXspm_temperature_sensor
========================

**Status**:

  *base class* (contribution), extends :ref:`NXsensor`

**Description**:

  .. collapse:: The :ref:`NXspm_temperature_sensor` class describes a temperature sensor ...

      The :ref:`NXspm_temperature_sensor` class describes a temperature sensor
      used in scanning probe microscopy (SPM) experiments. It includes fields
      for the temperature measurement, calibration, and associated data.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXcalibration`, :ref:`NXdata`, :ref:`NXparameters`

.. index:: NXcalibration (base class); used in base class, NXparameters (base class); used in base class, NXdata (base class); used in base class

**Structure**:

  .. _/NXspm_temperature_sensor/temperature-field:

  .. index:: temperature (field)

  **temperature**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`} 

    The obtained average temperature of the sensor.

  .. _/NXspm_temperature_sensor/target_temperature-field:

  .. index:: target_temperature (field)

  **target_temperature**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`} 

    .. collapse:: The target temperature of the sensor, which is the desired temperature ...

        The target temperature of the sensor, which is the desired temperature
        to be maintained during the experiment.

  .. _/NXspm_temperature_sensor/temp_offset_value-field:

  .. index:: temp_offset_value (field)

  **temp_offset_value**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`} 

    .. collapse:: The offset temperature of the sensor, which will be added to obtained correct  ...

        The offset temperature of the sensor, which will be added to obtained correct the
        measured temperature.

  .. _/NXspm_temperature_sensor/TEMPERATUREchannel-field:

  .. index:: TEMPERATUREchannel (field)

  :bolditalic:`TEMPERATURE`\ **channel**: (optional) :ref:`NX_CHAR <NX_CHAR>` 

    The name of the channel that handles the temperature measurement.

  .. _/NXspm_temperature_sensor/calibration-group:

  **calibration**: (optional) :ref:`NXcalibration` 

    Calibration of the temperature measurement.

    .. _/NXspm_temperature_sensor/calibration/calibration_parameters-group:

    **calibration_parameters**: (optional) :ref:`NXparameters` :ref:`⤆ </NXcalibration/calibration_parameters-group>`


      .. _/NXspm_temperature_sensor/calibration/calibration_parameters/coefficient-field:

      .. index:: coefficient (field)

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

        The coefficient of the calibration.

  .. _/NXspm_temperature_sensor/DATA-group:

  :bolditalic:`DATA`: (optional) :ref:`NXdata` :ref:`⤆ </NXobject/DATA-group>`

    .. collapse:: Data related to the temperature measurement, such as time series data ...

        Data related to the temperature measurement, such as time series data
        or voltage-temperature data.

    .. _/NXspm_temperature_sensor/DATA/DATA-field:

    .. index:: DATA (field)

    :bolditalic:`DATA`: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`} :ref:`⤆ </NXdata/DATA-field>`

      Temperature data collected during the scan.

    .. _/NXspm_temperature_sensor/DATA/AXISNAME-field:

    .. index:: AXISNAME (field)

    :bolditalic:`AXISNAME`: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

      independent axis data like time or position or bias voltage.


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

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


* :ref:`/NXspm_temperature_sensor/calibration-group </NXspm_temperature_sensor/calibration-group>`
* :ref:`/NXspm_temperature_sensor/calibration/calibration_parameters-group </NXspm_temperature_sensor/calibration/calibration_parameters-group>`
* :ref:`/NXspm_temperature_sensor/calibration/calibration_parameters/coefficient-field </NXspm_temperature_sensor/calibration/calibration_parameters/coefficient-field>`
* :ref:`/NXspm_temperature_sensor/DATA-group </NXspm_temperature_sensor/DATA-group>`
* :ref:`/NXspm_temperature_sensor/DATA/AXISNAME-field </NXspm_temperature_sensor/DATA/AXISNAME-field>`
* :ref:`/NXspm_temperature_sensor/DATA/DATA-field </NXspm_temperature_sensor/DATA/DATA-field>`
* :ref:`/NXspm_temperature_sensor/target_temperature-field </NXspm_temperature_sensor/target_temperature-field>`
* :ref:`/NXspm_temperature_sensor/temp_offset_value-field </NXspm_temperature_sensor/temp_offset_value-field>`
* :ref:`/NXspm_temperature_sensor/temperature-field </NXspm_temperature_sensor/temperature-field>`
* :ref:`/NXspm_temperature_sensor/TEMPERATUREchannel-field </NXspm_temperature_sensor/TEMPERATUREchannel-field>`

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