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

.. index::
    ! NXtranslation (base class)
    ! translation (base class)
    see: translation (base class); NXtranslation

.. _NXtranslation:

=============
NXtranslation
=============

**Status**:

  base class, extends :ref:`NXobject`, version 1.0

**Description**:

  legacy class - (used by :ref:`NXgeometry`) - general spatial location of a component.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXgeometry`

.. index:: NXgeometry (base class); used in base class

**Structure**:

  .. index:: distances (field)

  **distances[numobj, 3]**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    (x,y,z)
    This field describes the lateral movement of a component.
    The pair of groups NXtranslation and NXorientation together
    describe the position of a component. 
    For absolute position, the origin is the scattering center (where a perfectly 
    aligned sample would be) with the z-axis pointing downstream and the y-axis 
    pointing gravitationally up. For a relative position the NXtranslation is 
    taken into account before the NXorientation. The axes are right-handed and 
    orthonormal.

  **geometry**: :ref:`NXgeometry`

    Link to other object if we are relative, else absent

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/base_classes/NXtranslation.nxdl.xml