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

.. index::
    ! NXmirror (base class)
    ! mirror (base class)
    see: mirror (base class); NXmirror

.. _NXmirror:

========
NXmirror
========

**Status**:

  base class, extends :ref:`NXobject`, version 1.0

**Description**:

  Template of a beamline mirror or supermirror.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdata`, :ref:`NXgeometry`, :ref:`NXshape`

.. index:: NXgeometry (base class); used in base class, NXdata (base class); used in base class, NXshape (base class); used in base class

**Structure**:

  .. index:: type (data field)

  **type**: :ref:`NX_CHAR <NX_CHAR>`


    Any of these values:

      * ``single``: mirror with a single material as a reflecting surface

      * ``multi``: mirror with stacked, multiple layers as a reflecting surface


  .. index:: description (data field)

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

    description of this mirror

  .. index:: incident_angle (data field)

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


  .. index:: bend_angle_x (data field)

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


  .. index:: bend_angle_y (data field)

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


  .. index:: interior_atmosphere (data field)

  **interior_atmosphere**: :ref:`NX_CHAR <NX_CHAR>`


    Any of these values: ``vacuum`` | ``helium`` | ``argon``

  .. index:: external_material (data field)

  **external_material**: :ref:`NX_CHAR <NX_CHAR>`

    external material outside substrate

  .. index:: m_value (data field)

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

    The m value for a supermirror, which defines the supermirror 
    regime in multiples of the critical angle of Nickel.

  .. index:: substrate_material (data field)

  **substrate_material**: :ref:`NX_CHAR <NX_CHAR>`


  .. index:: substrate_density (data field)

  **substrate_density**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_MASS_DENSITY <NX_MASS_DENSITY>`}


  .. index:: substrate_thickness (data field)

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


  .. index:: coating_material (data field)

  **coating_material**: :ref:`NX_CHAR <NX_CHAR>`


  .. index:: substrate_roughness (data field)

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


  .. index:: coating_roughness (data field)

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


  .. index:: even_layer_material (data field)

  **even_layer_material**: :ref:`NX_CHAR <NX_CHAR>`


  .. index:: even_layer_density (data field)

  **even_layer_density**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_MASS_DENSITY <NX_MASS_DENSITY>`}


  .. index:: odd_layer_material (data field)

  **odd_layer_material**: :ref:`NX_CHAR <NX_CHAR>`


  .. index:: odd_layer_density (data field)

  **odd_layer_density**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_MASS_DENSITY <NX_MASS_DENSITY>`}


  .. index:: layer_thickness (data field)

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

    An array describing the thickness of each layer

  **(geometry)**: :ref:`NXgeometry`


  **reflectivity**: :ref:`NXdata`

    Reflectivity as function of wavelength

  **shape**: :ref:`NXshape`

    A NXshape group describing the shape of the mirror

  **figure_data**: :ref:`NXdata`

    Numerical description of the surface figure of the mirror.

**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXmirror.nxdl.xml