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

.. index::
    ! NXcollimator (base class)
    ! collimator (base class)
    see: collimator (base class); NXcollimator

.. _NXcollimator:

============
NXcollimator
============

**Status**:

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

**Description**:

  Template of a beamline collimator.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXgeometry`, :ref:`NXlog`

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

**Structure**:

  .. index:: type (data field)

  **type**: :ref:`NX_CHAR <NX_CHAR>`


    Any of these values: ``Soller`` | ``radial`` | ``oscillating`` | ``honeycomb``

  .. index:: soller_angle (data field)

  **soller_angle**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

    Angular divergence of Soller collimator

  .. index:: divergence_x (data field)

  **divergence_x**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

    divergence of collimator in local x direction

  .. index:: divergence_y (data field)

  **divergence_y**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

    divergence of collimator in local y direction

  .. index:: frequency (data field)

  **frequency**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_FREQUENCY <NX_FREQUENCY>`}

    Frequency of oscillating collimator

  .. index:: blade_thickness (data field)

  **blade_thickness**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    blade thickness

  .. index:: blade_spacing (data field)

  **blade_spacing**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

    blade spacing

  .. index:: absorbing_material (data field)

  **absorbing_material**: :ref:`NX_CHAR <NX_CHAR>`

    name of absorbing material

  .. index:: transmitting_material (data field)

  **transmitting_material**: :ref:`NX_CHAR <NX_CHAR>`

    name of transmitting material

  **(geometry)**: :ref:`NXgeometry`

    position, shape and size

  **frequency_log**: :ref:`NXlog`

    Log of frequency

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