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

.. index::
    ! NXspm_piezo_sensor (base class)
    ! spm_piezo_sensor (base class)
    see: spm_piezo_sensor (base class); NXspm_piezo_sensor

.. _NXspm_piezo_sensor:

==================
NXspm_piezo_sensor
==================

**Status**:

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

**Description**:

  This piezo sensor group refers to the height (or Z) piezo sensor.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXspm_piezo_config`, :ref:`NXspm_piezoelectric_material`, :ref:`NXspm_positioner`

.. index:: NXspm_piezo_config (base class); used in base class, NXspm_positioner (base class); used in base class, NXspm_piezoelectric_material (base class); used in base class

**Structure**:

  .. _/NXspm_piezo_sensor/x-field:

  .. index:: x (field)

  **x**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    The x position (e.g., target or averaged target value) of the piezo.

  .. _/NXspm_piezo_sensor/y-field:

  .. index:: y (field)

  **y**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    The y position (e.g., target or averaged target value) of the piezo.

  .. _/NXspm_piezo_sensor/z-field:

  .. index:: z (field)

  **z**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    The z position (e.g., target or averaged target value) of the piezo.

  .. _/NXspm_piezo_sensor/AXISoffset_value-field:

  .. index:: AXISoffset_value (field)

  :bolditalic:`AXIS`\ **offset_value**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: The offset value for the piezo axis (X, Y, or Z) that will be added ...

        The offset value for the piezo axis (X, Y, or Z) that will be added
        to the measured value.

  .. _/NXspm_piezo_sensor/piezo_configuration-group:

  **piezo_configuration**: (optional) :ref:`NXspm_piezo_config` 

    .. collapse:: The piezo configuration information like piezoelectric calibration and materia ...

        The piezo configuration information like piezoelectric calibration and material
        properties.

  .. _/NXspm_piezo_sensor/SPM_POSITIONER-group:

  :bolditalic:`SPM_POSITIONER`: (optional) :ref:`NXspm_positioner` 

    .. collapse:: The positioner information like the position of the tip, the position of the ...

        The positioner information like the position of the tip, the position of the
        sample, PID controller etc.

  .. _/NXspm_piezo_sensor/piezo_material-group:

  **piezo_material**: (optional) :ref:`NXspm_piezoelectric_material` 

    The material description and properties of the piezoelectric scanner materials.


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

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


* :ref:`/NXspm_piezo_sensor/AXISoffset_value-field </NXspm_piezo_sensor/AXISoffset_value-field>`
* :ref:`/NXspm_piezo_sensor/piezo_configuration-group </NXspm_piezo_sensor/piezo_configuration-group>`
* :ref:`/NXspm_piezo_sensor/piezo_material-group </NXspm_piezo_sensor/piezo_material-group>`
* :ref:`/NXspm_piezo_sensor/SPM_POSITIONER-group </NXspm_piezo_sensor/SPM_POSITIONER-group>`
* :ref:`/NXspm_piezo_sensor/x-field </NXspm_piezo_sensor/x-field>`
* :ref:`/NXspm_piezo_sensor/y-field </NXspm_piezo_sensor/y-field>`
* :ref:`/NXspm_piezo_sensor/z-field </NXspm_piezo_sensor/z-field>`

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