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

.. index::
    ! NXxnb (application definition)
    ! xnb (application definition)
    see: xnb (application definition); NXxnb

.. _NXxnb:

=====
NXxnb
=====

..
    Contributors List

    .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28

    .. |contrib_name| replace:: Russ Berg|RussBerg|https://avatars.githubusercontent.com/u/4698891?v=4|2020-11-05

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

    .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26

**Status**:

  application definition, extends :ref:`NXxbase`

**Description**:

  .. collapse:: raw data from a single crystal diffractometer, extends :ref:`NXxbase` ...

      raw data from a single crystal diffractometer, extends :ref:`NXxbase`

      This is the application definition for raw data from 
      a single crystal diffractometer
      measuring in normal beam mode. It extends :ref:`NXxbase`, 
      so the full definition is the content of
      :ref:`NXxbase` plus the data defined here. All angles are 
      logged in order to support arbitrary scans in
      reciprocal space.

**Symbols**:

  The symbol(s) listed here will be used below to coordinate datasets with the same shape.

  **nP**: Number of points

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

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

**Structure**:

  .. _/NXxnb/entry-group:

  **entry**: (required) :ref:`NXentry` :ref:`⤆ </NXxbase/entry-group>`


    .. _/NXxnb/entry/definition-field:

    .. index:: definition (field)

    **definition**: (required) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXxbase/entry/definition-field>`

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

          Official NeXus NXDL schema to which this file conforms

          Obligatory value: ``NXxnb``

    .. _/NXxnb/entry/instrument-group:

    **instrument**: (required) :ref:`NXinstrument` :ref:`⤆ </NXxbase/entry/instrument-group>`


      .. _/NXxnb/entry/instrument/detector-group:

      **detector**: (required) :ref:`NXdetector` :ref:`⤆ </NXxbase/entry/instrument/detector-group>`


        .. _/NXxnb/entry/instrument/detector/polar_angle-field:

        .. index:: polar_angle (field)

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

          The polar_angle (gamma) of the detector for each scan point.

        .. _/NXxnb/entry/instrument/detector/tilt_angle-field:

        .. index:: tilt_angle (field)

        **tilt_angle**: (required) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 

          .. collapse:: The angle by which the detector has been tilted out of the ...

              The angle by which the detector has been tilted out of the
              scattering plane.

    .. _/NXxnb/entry/sample-group:

    **sample**: (required) :ref:`NXsample` :ref:`⤆ </NXxbase/entry/sample-group>`


      .. _/NXxnb/entry/sample/rotation_angle-field:

      .. index:: rotation_angle (field)

      **rotation_angle**: (required) :ref:`NX_FLOAT <NX_FLOAT>` (Rank: 1, Dimensions: [nP]) {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} :ref:`⤆ </NXsample/rotation_angle-field>`

        .. collapse:: This is an array holding the sample rotation angle at each ...

            This is an array holding the sample rotation angle at each
            scan point

    .. _/NXxnb/entry/name-group:

    **name**: (required) :ref:`NXdata` :ref:`⤆ </NXxbase/entry/DATA-group>`


      .. _/NXxnb/entry/name/polar_angle-link:

      **polar_angle**: :ref:`link<Design-Links>` (suggested target: ``/NXentry/NXinstrument/NXdetector/polar_angle``)


      .. _/NXxnb/entry/name/tilt-link:

      **tilt**: :ref:`link<Design-Links>` (suggested target: ``/NXentry/NXinstrument/NXdetector/tilt``)


      .. _/NXxnb/entry/name/rotation_angle-link:

      **rotation_angle**: :ref:`link<Design-Links>` (suggested target: ``/NXentry/NXsample/rotation_angle``)



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

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


* :ref:`/NXxnb/entry-group </NXxnb/entry-group>`
* :ref:`/NXxnb/entry/definition-field </NXxnb/entry/definition-field>`
* :ref:`/NXxnb/entry/instrument-group </NXxnb/entry/instrument-group>`
* :ref:`/NXxnb/entry/instrument/detector-group </NXxnb/entry/instrument/detector-group>`
* :ref:`/NXxnb/entry/instrument/detector/polar_angle-field </NXxnb/entry/instrument/detector/polar_angle-field>`
* :ref:`/NXxnb/entry/instrument/detector/tilt_angle-field </NXxnb/entry/instrument/detector/tilt_angle-field>`
* :ref:`/NXxnb/entry/name-group </NXxnb/entry/name-group>`
* :ref:`/NXxnb/entry/name/polar_angle-link </NXxnb/entry/name/polar_angle-link>`
* :ref:`/NXxnb/entry/name/rotation_angle-link </NXxnb/entry/name/rotation_angle-link>`
* :ref:`/NXxnb/entry/name/tilt-link </NXxnb/entry/name/tilt-link>`
* :ref:`/NXxnb/entry/sample-group </NXxnb/entry/sample-group>`
* :ref:`/NXxnb/entry/sample/rotation_angle-field </NXxnb/entry/sample/rotation_angle-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/applications/NXxnb.nxdl.xml