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

.. index::
    ! NXreflections (contributed definition)
    ! reflections (contributed definition)
    see: reflections (contributed definition); NXreflections

.. _NXreflections:

=============
NXreflections
=============

**Status**:

  contributed definition, extends :ref:`NXobject`, version 1.0

**Description**:

  This is a definition for reflection data from diffraction experiments

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXentry`

.. index:: NXentry (base class); used in contributed definition

**Structure**:

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


    .. index:: definition (field)

    **definition**: :ref:`NX_CHAR <NX_CHAR>`

      NeXus NXDL schema to which this file conforms

      Obligatory value:  ``NXreflections``

    .. index:: experiments (field)

    **experiments**: :ref:`NX_CHAR <NX_CHAR>`

      The experiments from which the reflection data derives

    .. index:: h (field)

    **h**: :ref:`NX_INT <NX_INT>`

      The h component of the miller index

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: k (field)

    **k**: :ref:`NX_INT <NX_INT>`

      The k component of the miller index

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: l (field)

    **l**: :ref:`NX_INT <NX_INT>`

      The l component of the miller index

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: id (field)

    **id**: :ref:`NX_INT <NX_INT>`

      The id of the experiment which resulted in the reflection. If the value
      is greater than 0, the experiments must link to a multi-experiment NXmx
      group

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: reflection id (field)

    **reflection_id**: :ref:`NX_INT <NX_INT>`

      The id of the reflection. Multiple partials from the same reflection
      should all have the same id

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: entering (field)

    **entering**: :ref:`NX_BOOLEAN <NX_BOOLEAN>`

      Is the reflection entering or exiting the Ewald sphere

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: det module (field)

    **det_module**: :ref:`NX_INT <NX_INT>`

      The detector module on which the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: flags (field)

    **flags**: :ref:`NX_INT <NX_INT>`

      Status flags describing the reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: d (field)

    **d**: :ref:`NX_FLOAT <NX_FLOAT>`

      The resolution of the reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: partiality (field)

    **partiality**: :ref:`NX_FLOAT <NX_FLOAT>`

      The partiality of the reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: prd frame (field)

    **prd_frame**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The frame on which the bragg peak of the reflection is predicted

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: prd mm x (field)

    **prd_mm_x**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      The x millimetre position at which the bragg peak of the reflection
      is predicted

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: prd mm y (field)

    **prd_mm_y**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      The y millimetre position at which the bragg peak of the reflection
      is predicted

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: prd phi (field)

    **prd_phi**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

      The phi angle at which the bragg peak of the reflection is predicted

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: prd px x (field)

    **prd_px_x**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The x pixel position at which the bragg peak of the reflection is
      predicted

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: prd px y (field)

    **prd_px_y**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The y pixel position at which the bragg peak of the reflection is
      predicted

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs frame val (field)

    **obs_frame_val**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The estimate of the frame at which the central impact of the
      reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs frame var (field)

    **obs_frame_var**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The variance on the estimate of the frame at which the central
      impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs px x val (field)

    **obs_px_x_val**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The estimate of the pixel x position at which the central impact of
      the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs px x var (field)

    **obs_px_x_var**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The variance on the estimate of the pixel x position at which the
      central impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs px y val (field)

    **obs_px_y_val**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The estimate of the pixel y position at which the central impact of
      the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs px y var (field)

    **obs_px_y_var**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The variance on the estimate of the pixel y position at which the
      central impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs phi val (field)

    **obs_phi_val**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

      The estimate of the phi angle at which the central impact of the
      reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs phi var (field)

    **obs_phi_var**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`}

      The variance on the estimate of the phi angle at which the central
      impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs mm x val (field)

    **obs_mm_x_val**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      The estimate of the millimetre x position at which the central
      impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs mm x var (field)

    **obs_mm_x_var**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      The variance on the estimate of the millimetre x position at which
      the central impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs mm y val (field)

    **obs_mm_y_val**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      The estimate of the millimetre y position at which the central
      impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: obs mm y var (field)

    **obs_mm_y_var**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`}

      The variance on the estimate of the millimetre y position at which
      the central impact of the reflection was recorded

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: bbx0 (field)

    **bbx0**: :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The lower pixel x position of the bounding box around the recorded
      reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: bbx1 (field)

    **bbx1**: :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The upper pixel x position of the bounding box around the recorded
      reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: bby0 (field)

    **bby0**: :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The lower pixel y position of the bounding box around the recorded
      reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: bby1 (field)

    **bby1**: :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The upper pixel y position of the bounding box around the recorded
      reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: bbz0 (field)

    **bbz0**: :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The lower frame number of the bounding box around the recorded
      reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: bbz1 (field)

    **bbz1**: :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

      The upper frame number of the bounding box around the recorded
      reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: bkg mean (field)

    **bkg_mean**: :ref:`NX_FLOAT <NX_FLOAT>`

      The mean background under the reflection peak

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: int prf val (field)

    **int_prf_val**: (optional) :ref:`NX_FLOAT <NX_FLOAT>`

      The estimate of the reflection intensity by profile fitting

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: int prf var (field)

    **int_prf_var**: (optional) :ref:`NX_FLOAT <NX_FLOAT>`

      The variance on the estimate of the reflection intensity by profile
      fitting

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: int sum val (field)

    **int_sum_val**: :ref:`NX_FLOAT <NX_FLOAT>`

      The estimate of the reflection intensity by summation

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: int sum var (field)

    **int_sum_var**: :ref:`NX_FLOAT <NX_FLOAT>`

      The variance on the estimate of the reflection intensity by
      summation

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: lp (field)

    **lp**: :ref:`NX_FLOAT <NX_FLOAT>`

      The LP correction factor to be applied to the reflection intensities

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: prf cc (field)

    **prf_cc**: (optional) :ref:`NX_FLOAT <NX_FLOAT>`

      The correlation of the reflection profile with the reference profile
      used in profile fitting

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

    .. index:: overlaps (field)

    **overlaps**: (optional) :ref:`NX_INT <NX_INT>`

      An adjacency list specifying the spatial overlaps of reflections. The
      adjacency list is specified using an array data type where the elements
      of the array are the indices of the adjacent overlapped reflection

      .. index:: description (field attribute)

      **@description**: :ref:`NX_CHAR <NX_CHAR>`

        Describes the dataset

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/contributed_definitions/NXreflections.nxdl.xml