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

.. index::
    ! NXxrd (base class)
    ! xrd (base class)
    see: xrd (base class); NXxrd

.. _NXxrd:

=====
NXxrd
=====

**Status**:

  base class, extends :ref:`NXmonopd`

**Description**:

  NXxrd on top of NXmonopd

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXbeam`, :ref:`NXdata`, :ref:`NXdetector`, :ref:`NXentry`, :ref:`NXinstrument`, :ref:`NXprocess`

.. index:: NXentry (base class); used in base class, NXinstrument (base class); used in base class, NXbeam (base class); used in base class, NXdetector (base class); used in base class, NXdata (base class); used in base class, NXprocess (base class); used in base class

**Structure**:

  .. _/NXxrd/ENTRY-group:

  **ENTRY**: (optional) :ref:`NXentry` 


    .. _/NXxrd/ENTRY/definition-field:

    .. index:: definition (field)

    **definition**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXentry/definition-field>`

      .. collapse:: Official NeXus NXDL schema to which this file conforms ...

          Official NeXus NXDL schema to which this file conforms

          Obligatory value: ``NXxrd``

    .. _/NXxrd/ENTRY/INSTRUMENT-group:

    **INSTRUMENT**: (optional) :ref:`NXinstrument` :ref:`⤆ </NXentry/INSTRUMENT-group>`


      .. _/NXxrd/ENTRY/INSTRUMENT/BEAM-group:

      **BEAM**: (optional) :ref:`NXbeam` :ref:`⤆ </NXinstrument/BEAM-group>`


        .. _/NXxrd/ENTRY/INSTRUMENT/BEAM/incident_energy-field:

        .. index:: incident_energy (field)

        **incident_energy**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ENERGY <NX_ENERGY>`} :ref:`⤆ </NXbeam/incident_energy-field>`


      .. _/NXxrd/ENTRY/INSTRUMENT/DETECTOR-group:

      **DETECTOR**: (optional) :ref:`NXdetector` :ref:`⤆ </NXinstrument/DETECTOR-group>`


        .. _/NXxrd/ENTRY/INSTRUMENT/DETECTOR/polar_angle-field:

        .. index:: polar_angle (field)

        **polar_angle**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nDet]) {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} :ref:`⤆ </NXdetector/polar_angle-field>`

          The 2-theta range of the difractogram

          .. _/NXxrd/ENTRY/INSTRUMENT/DETECTOR/polar_angle@units-attribute:

          .. index:: units (field attribute)

          **@units**: (optional) :ref:`NX_CHAR <NX_CHAR>` 


            Obligatory value: ``deg``

        .. _/NXxrd/ENTRY/INSTRUMENT/DETECTOR/raw_data-group:

        **raw_data**: (optional) :ref:`NXdata` :ref:`⤆ </NXdetector/DATA-group>`

          .. collapse:: raw detector signal (usually counts) as colected ...

              raw detector signal (usually counts) as colected
              it can be a multi-dimensional dataset depending on
              the detector type (faster axes) and 
              the scanning method (slower axes)

    .. _/NXxrd/ENTRY/DATA-group:

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


      .. _/NXxrd/ENTRY/DATA/polar_angle-field:

      .. index:: polar_angle (field)

      **polar_angle**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nDet]) 

        .. collapse:: link (suggested target:/NXentry/NXinstrument/NXdetector/polar_angle) ...

            link (suggested target:/NXentry/NXinstrument/NXdetector/polar_angle)
            Link to ponglar ale in /NXentry/NXinstrument/NXdetector

      .. _/NXxrd/ENTRY/DATA/data-field:

      .. index:: data (field)

      **data**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [nDet]) :ref:`⤆ </NXdata/DATA-field>`

        .. collapse:: link (suggested target:/NXentry/NXinstrument/NXdetector/data) ...

            link (suggested target:/NXentry/NXinstrument/NXdetector/data)
            Link to data in /Nxentry/Nxinstrument/Nxdetector

    .. _/NXxrd/ENTRY/PROCESS-group:

    **PROCESS**: (optional) :ref:`NXprocess` :ref:`⤆ </NXentry/PROCESS-group>`

      .. collapse:: Description of a processing or analysis step, such as the  ...

          Description of a processing or analysis step, such as the 
          baseline extraction or azimuth integration.
          Add additional fields as needed to describe value(s) of 
          any variable, parameter, or term related to 
          the NXprocess step. Be sure to include units attributes 
          for all numerical fields.


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

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


* :ref:`/NXxrd/ENTRY-group </NXxrd/ENTRY-group>`
* :ref:`/NXxrd/ENTRY/DATA-group </NXxrd/ENTRY/DATA-group>`
* :ref:`/NXxrd/ENTRY/DATA/data-field </NXxrd/ENTRY/DATA/data-field>`
* :ref:`/NXxrd/ENTRY/DATA/polar_angle-field </NXxrd/ENTRY/DATA/polar_angle-field>`
* :ref:`/NXxrd/ENTRY/definition-field </NXxrd/ENTRY/definition-field>`
* :ref:`/NXxrd/ENTRY/INSTRUMENT-group </NXxrd/ENTRY/INSTRUMENT-group>`
* :ref:`/NXxrd/ENTRY/INSTRUMENT/BEAM-group </NXxrd/ENTRY/INSTRUMENT/BEAM-group>`
* :ref:`/NXxrd/ENTRY/INSTRUMENT/BEAM/incident_energy-field </NXxrd/ENTRY/INSTRUMENT/BEAM/incident_energy-field>`
* :ref:`/NXxrd/ENTRY/INSTRUMENT/DETECTOR-group </NXxrd/ENTRY/INSTRUMENT/DETECTOR-group>`
* :ref:`/NXxrd/ENTRY/INSTRUMENT/DETECTOR/polar_angle-field </NXxrd/ENTRY/INSTRUMENT/DETECTOR/polar_angle-field>`
* :ref:`/NXxrd/ENTRY/INSTRUMENT/DETECTOR/polar_angle@units-attribute </NXxrd/ENTRY/INSTRUMENT/DETECTOR/polar_angle@units-attribute>`
* :ref:`/NXxrd/ENTRY/INSTRUMENT/DETECTOR/raw_data-group </NXxrd/ENTRY/INSTRUMENT/DETECTOR/raw_data-group>`
* :ref:`/NXxrd/ENTRY/PROCESS-group </NXxrd/ENTRY/PROCESS-group>`

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