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

.. index::
    ! NXdetector_module (base class)
    ! detector module (base class)
    see: detector module (base class); NXdetector_module

.. _NXdetector_module:

=================
NXdetector_module
=================

**Status**:

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

**Description**:

  Geometry and logical description of a detector module.

  Many detectors consist of multiple
  smaller modules. Sometimes it is important to know the exact position of such
  modules.
  This is the purpose of this group. It is a child group to NXdetector.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. index:: data origin (field)

  **data_origin**: :ref:`NX_INT <NX_INT>`

    A two value field which gives the index of the start of the
    modules data in the
    main area detector image in the underlying NXdetector module.

  .. index:: data size (field)

  **data_size**: :ref:`NX_INT <NX_INT>`

    Two values for the size of the module in pixels in each direction.

  .. index:: module offset (field)

  **module_offset**: :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    Offset of the module in regards to the origin of the detector in an
    arbitrary direction.

    .. index:: transformation type (field attribute)

    **@transformation_type**: :ref:`NX_CHAR <NX_CHAR>`


      Obligatory value:  ``translation``

    .. index:: vector (field attribute)

    **@vector**: :ref:`NX_NUMBER <NX_NUMBER>`

      Three values that define the axis for this transformation

    .. index:: offset (field attribute)

    **@offset**: :ref:`NX_NUMBER <NX_NUMBER>`

      A fixed offset applied before the transformation (three vector components).

    .. index:: offset units (field attribute)

    **@offset_units**: :ref:`NX_CHAR <NX_CHAR>`

      Units of the offset.

    .. index:: depends on (field attribute)

    **@depends_on**: :ref:`NX_CHAR <NX_CHAR>`

      Points to the path of the next element in the geometry chain.

  .. index:: fast pixel direction (field)

  **fast_pixel_direction**: :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    Values along the direction of fastest varying pixel direction.The direction
    itself is given through the vector attribute

    .. index:: transformation type (field attribute)

    **@transformation_type**: :ref:`NX_CHAR <NX_CHAR>`


      Obligatory value:  ``translation``

    .. index:: vector (field attribute)

    **@vector**: :ref:`NX_NUMBER <NX_NUMBER>`

      Three values that define the axis for this transformation

    .. index:: offset (field attribute)

    **@offset**: :ref:`NX_NUMBER <NX_NUMBER>`

      A fixed offset applied before the transformation (three vector components).

    .. index:: offset units (field attribute)

    **@offset_units**: :ref:`NX_CHAR <NX_CHAR>`

      Units of the offset.

    .. index:: depends on (field attribute)

    **@depends_on**: :ref:`NX_CHAR <NX_CHAR>`

      Points to the path of the next element in the geometry chain.

  .. index:: slow pixel direction (field)

  **slow_pixel_direction**: :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    Values along the direction of slow varying pixel direction. The direction
    itself is given through the vector attribute

    .. index:: transformation type (field attribute)

    **@transformation_type**: :ref:`NX_CHAR <NX_CHAR>`


      Obligatory value:  ``translation``

    .. index:: vector (field attribute)

    **@vector**: :ref:`NX_NUMBER <NX_NUMBER>`

      Three values that define the axis for this transformation

    .. index:: offset (field attribute)

    **@offset**: :ref:`NX_NUMBER <NX_NUMBER>`

      A fixed offset applied before the transformation (three vector components).

    .. index:: offset units (field attribute)

    **@offset_units**: :ref:`NX_CHAR <NX_CHAR>`

      Units of the offset.

    .. index:: depends on (field attribute)

    **@depends_on**: :ref:`NX_CHAR <NX_CHAR>`

      Points to the path of the next element in the geometry chain.

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