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

.. index::
    ! NXattenuator (base class)
    ! attenuator (base class)
    see: attenuator (base class); NXattenuator

.. _NXattenuator:

============
NXattenuator
============

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: A device that reduces the intensity of a beam by attenuation. ...

      A device that reduces the intensity of a beam by attenuation.

      If uncertain whether to use :ref:`NXfilter` (band-pass filter)
      or :ref:`NXattenuator` (reduces beam intensity), then choose 
      :ref:`NXattenuator`.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXoff_geometry`

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

**Structure**:

  .. _/NXattenuator/distance-field:

  .. index:: distance (field)

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

    Distance from sample. Note, it is recommended to use NXtransformations instead.

  .. _/NXattenuator/type-field:

  .. index:: type (field)

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

    Type or composition of attenuator, e.g. polythene

  .. _/NXattenuator/thickness-field:

  .. index:: thickness (field)

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

    Thickness of attenuator along beam direction

  .. _/NXattenuator/scattering_cross_section-field:

  .. index:: scattering_cross_section (field)

  **scattering_cross_section**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CROSS_SECTION <NX_CROSS_SECTION>`} 

    Scattering cross section (coherent+incoherent)

  .. _/NXattenuator/absorption_cross_section-field:

  .. index:: absorption_cross_section (field)

  **absorption_cross_section**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CROSS_SECTION <NX_CROSS_SECTION>`} 

    Absorption cross section

  .. _/NXattenuator/attenuator_transmission-field:

  .. index:: attenuator_transmission (field)

  **attenuator_transmission**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    .. collapse:: The nominal amount of the beam that gets through ...

        The nominal amount of the beam that gets through
        (transmitted intensity)/(incident intensity)

  .. _/NXattenuator/status-field:

  .. index:: status (field)

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

    .. collapse:: In or out or moving of the beam ...

        In or out or moving of the beam

        Any of these values: ``in`` | ``out`` | ``moving``

    .. _/NXattenuator/status@time-attribute:

    .. index:: time (field attribute)

    **@time**: (optional) :ref:`NX_DATE_TIME <NX_DATE_TIME>` 

      time stamp for this observation

  .. _/NXattenuator/depends_on-field:

  .. index:: depends_on (field)

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

    .. collapse:: The reference point of the attenuator is its center in the x and y axis. The r ...

        The reference point of the attenuator is its center in the x and y axis. The reference point on the z axis is the
        surface of the attenuator pointing towards the source.

        In complex (asymmetric) geometries an NXoff_geometry group can be used to provide an unambiguous reference.

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

  .. _/NXattenuator/shape-group:

  **shape**: (optional) :ref:`NXoff_geometry` 

    Shape of this component. Particularly useful to define the origin for position and orientation in non-standard cases.


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

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


* :ref:`/NXattenuator/absorption_cross_section-field </NXattenuator/absorption_cross_section-field>`
* :ref:`/NXattenuator/attenuator_transmission-field </NXattenuator/attenuator_transmission-field>`
* :ref:`/NXattenuator/depends_on-field </NXattenuator/depends_on-field>`
* :ref:`/NXattenuator/distance-field </NXattenuator/distance-field>`
* :ref:`/NXattenuator/scattering_cross_section-field </NXattenuator/scattering_cross_section-field>`
* :ref:`/NXattenuator/shape-group </NXattenuator/shape-group>`
* :ref:`/NXattenuator/status-field </NXattenuator/status-field>`
* :ref:`/NXattenuator/status@time-attribute </NXattenuator/status@time-attribute>`
* :ref:`/NXattenuator/thickness-field </NXattenuator/thickness-field>`
* :ref:`/NXattenuator/type-field </NXattenuator/type-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXattenuator.nxdl.xml