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

.. index::
    ! NXxrot (application definition)
    ! xrot (application definition)
    see: xrot (application definition); NXxrot

.. _NXxrot:

======
NXxrot
======

**Status**:

  application definition, extends :ref:`NXxbase`

**Description**:

  raw data from a rotation camera, extends :ref:`NXxbase`

  This is the application definition for raw data from a rotation camera.
  It extends :ref:`NXxbase`, so the full definition is the content of :ref:`NXxbase`
  plus the data defined here.

**Symbols**:

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

  **nP**: Number of points

**Groups cited**:
  :ref:`NXattenuator`, :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, NXattenuator (base class); used in application definition, NXsample (base class); used in application definition, NXdata (base class); used in application definition

**Structure**:

  .. _/NXxrot/entry-group:

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


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

    .. index:: definition (field)

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

      Official NeXus NXDL schema to which this file conforms.

      Obligatory value:  ``NXxrot``

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

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


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

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


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

        .. index:: polar_angle (field)

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

          The polar_angle (two theta) where the detector is placed.

        .. _/NXxrot/entry/instrument/detector/beam_center_x-field:

        .. index:: beam_center_x (field)

        **beam_center_x**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

          This is the x position where the direct beam would hit the detector. This is a
          length, not a pixel position, and can be outside of the actual detector.

        .. _/NXxrot/entry/instrument/detector/beam_center_y-field:

        .. index:: beam_center_y (field)

        **beam_center_y**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

          This is the y position where the direct beam would hit the detector. This is a
          length, not a pixel position, and can be outside of the actual detector.

      .. _/NXxrot/entry/instrument/attenuator-group:

      **attenuator**: (required) :ref:`NXattenuator`


        .. _/NXxrot/entry/instrument/attenuator/attenuator_transmission-field:

        .. index:: attenuator_transmission (field)

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


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

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


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

      .. index:: rotation_angle (field)

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

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

      .. _/NXxrot/entry/sample/rotation_angle_step-field:

      .. index:: rotation_angle_step (field)

      **rotation_angle_step[nP]**: (required) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

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

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

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


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

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



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

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


============================================================================================================================================ ============================================================================================================================================
documentation (reST source) anchor                                                                                                           web page (HTML) anchor                                                                                                                      
============================================================================================================================================ ============================================================================================================================================
:ref:`/NXxrot/entry-group </NXxrot/entry-group>`                                                                                             :ref:`#nxxrot-entry-group </NXxrot/entry-group>`                                                                                            
:ref:`/NXxrot/entry/definition-field </NXxrot/entry/definition-field>`                                                                       :ref:`#nxxrot-entry-definition-field </NXxrot/entry/definition-field>`                                                                      
:ref:`/NXxrot/entry/instrument-group </NXxrot/entry/instrument-group>`                                                                       :ref:`#nxxrot-entry-instrument-group </NXxrot/entry/instrument-group>`                                                                      
:ref:`/NXxrot/entry/instrument/attenuator-group </NXxrot/entry/instrument/attenuator-group>`                                                 :ref:`#nxxrot-entry-instrument-attenuator-group </NXxrot/entry/instrument/attenuator-group>`                                                
:ref:`/NXxrot/entry/instrument/attenuator/attenuator_transmission-field </NXxrot/entry/instrument/attenuator/attenuator_transmission-field>` :ref:`#nxxrot-entry-instrument-attenuator-attenuator-transmission-field </NXxrot/entry/instrument/attenuator/attenuator_transmission-field>`
:ref:`/NXxrot/entry/instrument/detector-group </NXxrot/entry/instrument/detector-group>`                                                     :ref:`#nxxrot-entry-instrument-detector-group </NXxrot/entry/instrument/detector-group>`                                                    
:ref:`/NXxrot/entry/instrument/detector/beam_center_x-field </NXxrot/entry/instrument/detector/beam_center_x-field>`                         :ref:`#nxxrot-entry-instrument-detector-beam-center-x-field </NXxrot/entry/instrument/detector/beam_center_x-field>`                        
:ref:`/NXxrot/entry/instrument/detector/beam_center_y-field </NXxrot/entry/instrument/detector/beam_center_y-field>`                         :ref:`#nxxrot-entry-instrument-detector-beam-center-y-field </NXxrot/entry/instrument/detector/beam_center_y-field>`                        
:ref:`/NXxrot/entry/instrument/detector/polar_angle-field </NXxrot/entry/instrument/detector/polar_angle-field>`                             :ref:`#nxxrot-entry-instrument-detector-polar-angle-field </NXxrot/entry/instrument/detector/polar_angle-field>`                            
:ref:`/NXxrot/entry/name-group </NXxrot/entry/name-group>`                                                                                   :ref:`#nxxrot-entry-name-group </NXxrot/entry/name-group>`                                                                                  
:ref:`/NXxrot/entry/name/rotation_angle-link </NXxrot/entry/name/rotation_angle-link>`                                                       :ref:`#nxxrot-entry-name-rotation-angle-link </NXxrot/entry/name/rotation_angle-link>`                                                      
:ref:`/NXxrot/entry/sample-group </NXxrot/entry/sample-group>`                                                                               :ref:`#nxxrot-entry-sample-group </NXxrot/entry/sample-group>`                                                                              
:ref:`/NXxrot/entry/sample/rotation_angle-field </NXxrot/entry/sample/rotation_angle-field>`                                                 :ref:`#nxxrot-entry-sample-rotation-angle-field </NXxrot/entry/sample/rotation_angle-field>`                                                
:ref:`/NXxrot/entry/sample/rotation_angle_step-field </NXxrot/entry/sample/rotation_angle_step-field>`                                       :ref:`#nxxrot-entry-sample-rotation-angle-step-field </NXxrot/entry/sample/rotation_angle_step-field>`                                      
============================================================================================================================================ ============================================================================================================================================


**NXDL Source**:
  https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/applications/NXxrot.nxdl.xml