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

.. index::
    ! NXspm_cantilever (base class)
    ! spm_cantilever (base class)
    see: spm_cantilever (base class); NXspm_cantilever

.. _NXspm_cantilever:

================
NXspm_cantilever
================

**Status**:

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

**Description**:

  A base class to describe the cantilever used in Atomic Force Microscopy (AFM).

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXpositioner`, :ref:`NXspm_cantilever_config`, :ref:`NXspm_cantilever_oscillator`

.. index:: NXspm_cantilever_oscillator (base class); used in base class, NXspm_cantilever_config (base class); used in base class, NXpositioner (base class); used in base class

**Structure**:

  .. _/NXspm_cantilever/cantilever_oscillator-group:

  **cantilever_oscillator**: (optional) :ref:`NXspm_cantilever_oscillator` 

    The oscillator of the cantilever.

  .. _/NXspm_cantilever/cantilever_config-group:

  **cantilever_config**: (optional) :ref:`NXspm_cantilever_config` 

    .. collapse:: The configuration parameters of the cantilever used in scanning probe ...

        The configuration parameters of the cantilever used in scanning probe
        microscopy.

  .. _/NXspm_cantilever/phase_positioner-group:

  **phase_positioner**: (optional) :ref:`NXpositioner` 

    The phase positioner of the cantilever.

  .. _/NXspm_cantilever/amplitude_positioner-group:

  **amplitude_positioner**: (optional) :ref:`NXpositioner` 

    The amplitude positioner of the cantilever.


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

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


* :ref:`/NXspm_cantilever/amplitude_positioner-group </NXspm_cantilever/amplitude_positioner-group>`
* :ref:`/NXspm_cantilever/cantilever_config-group </NXspm_cantilever/cantilever_config-group>`
* :ref:`/NXspm_cantilever/cantilever_oscillator-group </NXspm_cantilever/cantilever_oscillator-group>`
* :ref:`/NXspm_cantilever/phase_positioner-group </NXspm_cantilever/phase_positioner-group>`

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