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

.. index::
    ! NXgeometry (base class)
    ! geometry (base class)
    see: geometry (base class); NXgeometry

.. _NXgeometry:

==========
NXgeometry
==========

**Status**:

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

**Description**:

  This is the description for a general position of a component. 
  It is recommended to name an instance of NXgeometry as "geometry"
  to aid in the use of the definition in simulation codes such as McStas.
  Also, in HDF, linked items must share the same name.
  However, it might not be possible or practical in all situations.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXorientation`, :ref:`NXshape`, :ref:`NXtranslation`

.. index:: NXshape (base class); used in base class, NXtranslation (base class); used in base class, NXorientation (base class); used in base class

**Structure**:

  .. index:: description (data field)

  **description**: :ref:`NX_CHAR <NX_CHAR>`

    Optional description/label. Probably only present if we are
    an additional reference point for components rather than the
    location of a real component.

  .. index:: component_index (data field)

  **component_index**: :ref:`NX_INT <NX_INT>`

    Position of the component along the beam path. The sample is at 0, components upstream
    have negative component_index, components downstream have positive
    component_index.

  **(shape)**: :ref:`NXshape`

    shape/size information of component

  **(translation)**: :ref:`NXtranslation`

    translation of component

  **(orientation)**: :ref:`NXorientation`

    orientation of component

**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXgeometry.nxdl.xml