.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXmanipulator.nxdl.xml

.. index::
    ! NXmanipulator (base class)
    ! manipulator (base class)
    see: manipulator (base class); NXmanipulator

.. _NXmanipulator:

=============
NXmanipulator
=============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Draft extension of NXpositioner to include fields to describe the use of manipulators in photoemission experiments.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays

  **ncoords**

  **nangles**

  **npos**

**Groups cited**:
  :ref:`NXpositioner`, :ref:`NXtransformations`

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

**Structure**:

  .. _/NXmanipulator/name-field:

  .. index:: name (field)

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

    Name

  .. _/NXmanipulator/description-field:

  .. index:: description (field)

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

    Description

  .. _/NXmanipulator/type-field:

  .. index:: type (field)

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

    Type of manipulator, Hexapod, Rod, etc.

  .. _/NXmanipulator/coordinates-field:

  .. index:: coordinates (field)

  **coordinates[ncoord]**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    Coordinates of the manipulator position (x,y,z)

  .. _/NXmanipulator/angles-field:

  .. index:: angles (field)

  **angles[nangles]**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

    Angles of the manipulator orientation (polar,tilt,azimuth)

  .. _/NXmanipulator/coordinate_values-field:

  .. index:: coordinate_values (field)

  **coordinate_values[npos]**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    Effective positions assumed by the manipulator during the measurement.

  .. _/NXmanipulator/angle_values-field:

  .. index:: angle_values (field)

  **angle_values[npos]**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

    Effective angles assumed by the manipulator during the measurement.

  .. _/NXmanipulator/cryocoolant-field:

  .. index:: cryocoolant (field)

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

    Is cryocoolant flowing through the manipulator?

  .. _/NXmanipulator/cryostat_temperature-field:

  .. index:: cryostat_temperature (field)

  **cryostat_temperature**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`}

    Temperature of the cryostat (coldest point)

  .. _/NXmanipulator/heater_power-field:

  .. index:: heater_power (field)

  **heater_power**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_POWER <NX_POWER>`}

    Power in the heater for temperature control.

  .. _/NXmanipulator/sample_temperature-field:

  .. index:: sample_temperature (field)

  **sample_temperature**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`}

    Temperature at the closest point to the sample

  .. _/NXmanipulator/drain_current-field:

  .. index:: drain_current (field)

  **drain_current**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    Current to neutralize the photoemission current

  .. _/NXmanipulator/sample_bias-field:

  .. index:: sample_bias (field)

  **sample_bias**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`}

    Possible bias of the sample with trespect to analyser ground

  .. _/NXmanipulator/POSITIONER-group:

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

    class to describe the motors that are used in the manipulator

  .. _/NXmanipulator/TRANSFORMATIONS-group:

  **TRANSFORMATIONS**: (optional) :ref:`NXtransformations`

    class to describe the transformations used.


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

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


============================================================================================ ============================================================================================
documentation (reST source) anchor                                                           web page (HTML) anchor                                                                      
============================================================================================ ============================================================================================
:ref:`/NXmanipulator/angle_values-field </NXmanipulator/angle_values-field>`                 :ref:`#nxmanipulator-angle-values-field </NXmanipulator/angle_values-field>`                
:ref:`/NXmanipulator/angles-field </NXmanipulator/angles-field>`                             :ref:`#nxmanipulator-angles-field </NXmanipulator/angles-field>`                            
:ref:`/NXmanipulator/coordinate_values-field </NXmanipulator/coordinate_values-field>`       :ref:`#nxmanipulator-coordinate-values-field </NXmanipulator/coordinate_values-field>`      
:ref:`/NXmanipulator/coordinates-field </NXmanipulator/coordinates-field>`                   :ref:`#nxmanipulator-coordinates-field </NXmanipulator/coordinates-field>`                  
:ref:`/NXmanipulator/cryocoolant-field </NXmanipulator/cryocoolant-field>`                   :ref:`#nxmanipulator-cryocoolant-field </NXmanipulator/cryocoolant-field>`                  
:ref:`/NXmanipulator/cryostat_temperature-field </NXmanipulator/cryostat_temperature-field>` :ref:`#nxmanipulator-cryostat-temperature-field </NXmanipulator/cryostat_temperature-field>`
:ref:`/NXmanipulator/description-field </NXmanipulator/description-field>`                   :ref:`#nxmanipulator-description-field </NXmanipulator/description-field>`                  
:ref:`/NXmanipulator/drain_current-field </NXmanipulator/drain_current-field>`               :ref:`#nxmanipulator-drain-current-field </NXmanipulator/drain_current-field>`              
:ref:`/NXmanipulator/heater_power-field </NXmanipulator/heater_power-field>`                 :ref:`#nxmanipulator-heater-power-field </NXmanipulator/heater_power-field>`                
:ref:`/NXmanipulator/name-field </NXmanipulator/name-field>`                                 :ref:`#nxmanipulator-name-field </NXmanipulator/name-field>`                                
:ref:`/NXmanipulator/POSITIONER-group </NXmanipulator/POSITIONER-group>`                     :ref:`#nxmanipulator-positioner-group </NXmanipulator/POSITIONER-group>`                    
:ref:`/NXmanipulator/sample_bias-field </NXmanipulator/sample_bias-field>`                   :ref:`#nxmanipulator-sample-bias-field </NXmanipulator/sample_bias-field>`                  
:ref:`/NXmanipulator/sample_temperature-field </NXmanipulator/sample_temperature-field>`     :ref:`#nxmanipulator-sample-temperature-field </NXmanipulator/sample_temperature-field>`    
:ref:`/NXmanipulator/TRANSFORMATIONS-group </NXmanipulator/TRANSFORMATIONS-group>`           :ref:`#nxmanipulator-transformations-group </NXmanipulator/TRANSFORMATIONS-group>`          
:ref:`/NXmanipulator/type-field </NXmanipulator/type-field>`                                 :ref:`#nxmanipulator-type-field </NXmanipulator/type-field>`                                
============================================================================================ ============================================================================================


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