.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXcollimator.nxdl.xml -- DO NOT EDIT

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

.. _NXcollimator:

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

..
    Contributors List

    .. |contrib_name| replace:: Lukas Pielsticker|lukaspie|https://avatars.githubusercontent.com/u/50139597?v=4|2025-02-13

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2024-02-18

    .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15

    .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20

    .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  A beamline collimator.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXcollimator/type-field:

  .. index:: type (field)

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


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

  .. _/NXcollimator/soller_angle-field:

  .. index:: soller_angle (field)

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

    Angular divergence of Soller collimator

  .. _/NXcollimator/divergence_x-field:

  .. index:: divergence_x (field)

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

    divergence of collimator in local x direction

  .. _/NXcollimator/divergence_y-field:

  .. index:: divergence_y (field)

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

    divergence of collimator in local y direction

  .. _/NXcollimator/frequency-field:

  .. index:: frequency (field)

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

    Frequency of oscillating collimator

  .. _/NXcollimator/blade_thickness-field:

  .. index:: blade_thickness (field)

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

    blade thickness

  .. _/NXcollimator/blade_spacing-field:

  .. index:: blade_spacing (field)

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

    blade spacing

  .. _/NXcollimator/absorbing_material-field:

  .. index:: absorbing_material (field)

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

    name of absorbing material

  .. _/NXcollimator/transmitting_material-field:

  .. index:: transmitting_material (field)

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

    name of transmitting material

  .. _/NXcollimator/depends_on-field:

  .. index:: depends_on (field)

  **depends_on**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/depends_on-field>`

    .. collapse:: Assuming a collimator with a "flat" entry surface, the reference plane is the  ...

        Assuming a collimator with a "flat" entry surface, the reference plane is the plane which contains this surface. The reference
        point of the collimator in the x and y axis is the centre of the collimator entry surface on that plane. The reference plane is orthogonal
        to the z axis and the location of this plane is the reference point on the z axis. The collimator faces negative z values.

        .. image:: collimator/collimator.png
          :width: 40%

  .. _/NXcollimator/GEOMETRY-group:

  :bolditalic:`GEOMETRY`: (optional) :ref:`NXgeometry` 


    .. index:: deprecated


    **DEPRECATED**: Use the field `depends_on` and :ref:`NXtransformations` to position the collimator and NXoff_geometry to describe its shape instead

    position, shape and size

  .. _/NXcollimator/frequency_log-group:

  **frequency_log**: (optional) :ref:`NXlog` :ref:`⤆ </NXobject/GROUPNAME_log-group>`

    Log of frequency

  .. _/NXcollimator/OFF_GEOMETRY-group:

  :bolditalic:`OFF_GEOMETRY`: (optional) :ref:`NXoff_geometry` 

    This group describes the shape of the beam line component


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

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


* :ref:`/NXcollimator/absorbing_material-field </NXcollimator/absorbing_material-field>`
* :ref:`/NXcollimator/blade_spacing-field </NXcollimator/blade_spacing-field>`
* :ref:`/NXcollimator/blade_thickness-field </NXcollimator/blade_thickness-field>`
* :ref:`/NXcollimator/depends_on-field </NXcollimator/depends_on-field>`
* :ref:`/NXcollimator/divergence_x-field </NXcollimator/divergence_x-field>`
* :ref:`/NXcollimator/divergence_y-field </NXcollimator/divergence_y-field>`
* :ref:`/NXcollimator/frequency-field </NXcollimator/frequency-field>`
* :ref:`/NXcollimator/frequency_log-group </NXcollimator/frequency_log-group>`
* :ref:`/NXcollimator/GEOMETRY-group </NXcollimator/GEOMETRY-group>`
* :ref:`/NXcollimator/OFF_GEOMETRY-group </NXcollimator/OFF_GEOMETRY-group>`
* :ref:`/NXcollimator/soller_angle-field </NXcollimator/soller_angle-field>`
* :ref:`/NXcollimator/transmitting_material-field </NXcollimator/transmitting_material-field>`
* :ref:`/NXcollimator/type-field </NXcollimator/type-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXcollimator.nxdl.xml