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

.. index::
    ! NXxraylens (base class)
    ! xraylens (base class)
    see: xraylens (base class); NXxraylens

.. _NXxraylens:

==========
NXxraylens
==========

**Status**:

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

**Description**:

  An X-ray lens, typically at a synchrotron X-ray beam line.

  Based on information provided by Gerd Wellenreuther (DESY).

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXnote`

.. index:: NXnote (base class); used in base class

**Structure**:

  .. index:: lens geometry (field)

  **lens_geometry**: :ref:`NX_CHAR <NX_CHAR>`

    Geometry of the lens

    Any of these values:

      * ``paraboloid``

      * ``spherical``

      * ``elliptical``

      * ``hyperbolical``


  .. index:: symmetric (field)

  **symmetric**: :ref:`NX_BOOLEAN <NX_BOOLEAN>`

    Is the device symmetric?

  .. index:: cylindrical (field)

  **cylindrical**: :ref:`NX_BOOLEAN <NX_BOOLEAN>`

    Is the device cylindrical?

  .. index:: focus type (field)

  **focus_type**: :ref:`NX_CHAR <NX_CHAR>`

    The type of focus of the lens

    Any of these values: ``line`` | ``point``

  .. index:: lens thickness (field)

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

    Thickness of the lens

  .. index:: lens length (field)

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

    Length of the lens

  .. index:: curvature (field)

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

    Radius of the curvature as measured in the middle of the lens

  .. index:: aperture (field)

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

    Diameter of the lens.

  .. index:: number of lenses (field)

  **number_of_lenses**: :ref:`NX_INT <NX_INT>`

    Number of lenses that make up the compound lens.

  .. index:: lens material (field)

  **lens_material**: :ref:`NX_CHAR <NX_CHAR>`

    Material used to make the lens.

  .. index:: gas (field)

  **gas**: :ref:`NX_CHAR <NX_CHAR>`

    Gas used to fill the lens

  .. index:: gas pressure (field)

  **gas_pressure**: :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_PRESSURE <NX_PRESSURE>`}

    Gas pressure in the lens

  **cylinder_orientation**: :ref:`NXnote`

    Orientation of the cylinder axis.

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/base_classes/NXxraylens.nxdl.xml