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

.. index::
    ! NXmoderator (base class)
    ! moderator (base class)
    see: moderator (base class); NXmoderator

.. _NXmoderator:

===========
NXmoderator
===========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  A neutron moderator

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. _/NXmoderator/distance-field:

  .. index:: distance (field)

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

    .. collapse:: Effective distance as seen by measuring radiation. ...

        Effective distance as seen by measuring radiation.
        Note, it is recommended to use NXtransformations instead.

  .. _/NXmoderator/type-field:

  .. index:: type (field)

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


    Any of these values:

      * ``H20``

      * ``D20``

      * ``Liquid H2``

      * ``Liquid CH4``

      * ``Liquid D2``

      * ``Solid D2``

      * ``C``

      * ``Solid CH4``

      * ``Solid H2``


  .. _/NXmoderator/poison_depth-field:

  .. index:: poison_depth (field)

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


  .. _/NXmoderator/coupled-field:

  .. index:: coupled (field)

  **coupled**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>` 

    whether the moderator is coupled

  .. _/NXmoderator/coupling_material-field:

  .. index:: coupling_material (field)

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

    The material used for coupling. Usually Cd.

  .. _/NXmoderator/poison_material-field:

  .. index:: poison_material (field)

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


    Any of these values: ``Gd`` | ``Cd``

  .. _/NXmoderator/temperature-field:

  .. index:: temperature (field)

  **temperature**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_TEMPERATURE <NX_TEMPERATURE>`} 

    average/nominal moderator temperature

  .. _/NXmoderator/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 moderator is its center in the x and y axis. The re ...

        The reference point of the moderator is its center in the x and y axis. The reference point on the z axis is the
        surface of the moderator pointing towards the source (the negative part of the z axis).

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


  .. _/NXmoderator/GEOMETRY-group:

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


    .. index:: deprecated


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

    "Engineering" position of moderator

  .. _/NXmoderator/temperature_log-group:

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

    log file of moderator temperature

  .. _/NXmoderator/pulse_shape-group:

  **pulse_shape**: (optional) :ref:`NXdata` :ref:`⤆ </NXobject/DATA-group>`

    moderator pulse shape

  .. _/NXmoderator/OFF_GEOMETRY-group:

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

    This group describes the shape of the moderator


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

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


* :ref:`/NXmoderator/coupled-field </NXmoderator/coupled-field>`
* :ref:`/NXmoderator/coupling_material-field </NXmoderator/coupling_material-field>`
* :ref:`/NXmoderator/depends_on-field </NXmoderator/depends_on-field>`
* :ref:`/NXmoderator/distance-field </NXmoderator/distance-field>`
* :ref:`/NXmoderator/GEOMETRY-group </NXmoderator/GEOMETRY-group>`
* :ref:`/NXmoderator/OFF_GEOMETRY-group </NXmoderator/OFF_GEOMETRY-group>`
* :ref:`/NXmoderator/poison_depth-field </NXmoderator/poison_depth-field>`
* :ref:`/NXmoderator/poison_material-field </NXmoderator/poison_material-field>`
* :ref:`/NXmoderator/pulse_shape-group </NXmoderator/pulse_shape-group>`
* :ref:`/NXmoderator/temperature-field </NXmoderator/temperature-field>`
* :ref:`/NXmoderator/temperature_log-group </NXmoderator/temperature_log-group>`
* :ref:`/NXmoderator/type-field </NXmoderator/type-field>`

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