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

.. index::
    ! NXmonopd (application definition)
    ! monopd (application definition)
    see: monopd (application definition); NXmonopd

.. _NXmonopd:

========
NXmonopd
========

**Status**:

  application definition, extends :ref:`NXobject`

**Description**:

  Monochromatic Neutron and X-Ray Powder diffractometer

  Instrument 
  definition for a powder diffractometer at a monochromatic neutron 
  or X-ray beam. This is both suited for a powder diffractometer 
  with a single detector or a powder diffractometer with a position 
  sensitive detector.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXcrystal`, :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXmonitor`, :ref:`NXsample`, :ref:`NXsource`

.. index:: NXentry (base class); used in application definition, NXinstrument (base class); used in application definition, NXsource (base class); used in application definition, NXcrystal (base class); used in application definition, NXdetector (base class); used in application definition, NXsample (base class); used in application definition, NXmonitor (base class); used in application definition, NXdata (base class); used in application definition

**Structure**:

  **entry**: (required) :ref:`NXentry`


    .. index:: title (field)

    **title**: (required) :ref:`NX_CHAR <NX_CHAR>`


    .. index:: start_time (field)

    **start_time**: (required) :ref:`NX_DATE_TIME <NX_DATE_TIME>`


    .. index:: definition (field)

    **definition**: (required) :ref:`NX_CHAR <NX_CHAR>`

      Official NeXus NXDL schema to which this file conforms

      Obligatory value:  ``NXmonopd``

    **(instrument)**: (required) :ref:`NXinstrument`


      **(source)**: (required) :ref:`NXsource`


        .. index:: type (field)

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


        .. index:: name (field)

        **name**: (required) :ref:`NX_CHAR <NX_CHAR>`


        .. index:: probe (field)

        **probe**: (required) :ref:`NX_CHAR <NX_CHAR>`


          Any of these values: ``neutron`` | ``x-ray`` | ``electron``

      **(crystal)**: (required) :ref:`NXcrystal`


        .. index:: wavelength (field)

        **wavelength[i]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_WAVELENGTH <NX_WAVELENGTH>`}

          Optimum diffracted wavelength

      **(detector)**: (required) :ref:`NXdetector`


        .. index:: polar_angle (field)

        **polar_angle[ndet]**: (required) :ref:`NX_FLOAT <NX_FLOAT>`

          where ndet = number of detectors

        .. index:: data (field)

        **data[ndet]**: (required) :ref:`NX_INT <NX_INT>`

          detector signal (usually counts) are already
          corrected for detector efficiency

    **(sample)**: (required) :ref:`NXsample`


      .. index:: name (field)

      **name**: (required) :ref:`NX_CHAR <NX_CHAR>`

        Descriptive name of sample

      .. index:: rotation_angle (field)

      **rotation_angle**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

        Optional rotation angle for the case when the powder diagram 
        has been obtained through an omega-2theta scan like from a 
        traditional single detector powder diffractometer

    **(monitor)**: (required) :ref:`NXmonitor`


      .. index:: mode (field)

      **mode**: (required) :ref:`NX_CHAR <NX_CHAR>`

        Count to a preset value based on either clock time (timer) 
        or received monitor counts (monitor).

        Any of these values: ``monitor`` | ``timer``

      .. index:: preset (field)

      **preset**: (required) :ref:`NX_FLOAT <NX_FLOAT>`

        preset value for time or monitor

      .. index:: integral (field)

      **integral**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANY <NX_ANY>`}

        Total integral monitor counts

    **(data)**: (required) :ref:`NXdata`


      **polar_angle** --> /NXentry/NXinstrument/NXdetector/polar_angle

        Link to polar angle in /NXentry/NXinstrument/NXdetector

      **data** --> /NXentry/NXinstrument/NXdetector/data

        Link to data in /NXentry/NXinstrument/NXdetector

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/applications/NXmonopd.nxdl.xml