.. 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`

**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**:

  .. _/NXxraylens@default-attribute:

  .. index:: default (file attribute)

  **@default**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    .. index:: plotting

    Declares which child group contains a path leading 
    to a :ref:`NXdata` group.

    It is recommended (as of NIAC2014) to use this attribute
    to help define the path to the default dataset to be plotted.
    See https://www.nexusformat.org/2014_How_to_find_default_data.html
    for a summary of the discussion.

  .. _/NXxraylens/lens_geometry-field:

  .. index:: lens_geometry (field)

  **lens_geometry**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Geometry of the lens

    Any of these values:

      * ``paraboloid``

      * ``spherical``

      * ``elliptical``

      * ``hyperbolical``


  .. _/NXxraylens/symmetric-field:

  .. index:: symmetric (field)

  **symmetric**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>`

    Is the device symmetric?

  .. _/NXxraylens/cylindrical-field:

  .. index:: cylindrical (field)

  **cylindrical**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>`

    Is the device cylindrical?

  .. _/NXxraylens/focus_type-field:

  .. index:: focus_type (field)

  **focus_type**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    The type of focus of the lens

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

  .. _/NXxraylens/lens_thickness-field:

  .. index:: lens_thickness (field)

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

    Thickness of the lens

  .. _/NXxraylens/lens_length-field:

  .. index:: lens_length (field)

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

    Length of the lens

  .. _/NXxraylens/curvature-field:

  .. index:: curvature (field)

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

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

  .. _/NXxraylens/aperture-field:

  .. index:: aperture (field)

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

    Diameter of the lens.

  .. _/NXxraylens/number_of_lenses-field:

  .. index:: number_of_lenses (field)

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

    Number of lenses that make up the compound lens.

  .. _/NXxraylens/lens_material-field:

  .. index:: lens_material (field)

  **lens_material**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Material used to make the lens.

  .. _/NXxraylens/gas-field:

  .. index:: gas (field)

  **gas**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Gas used to fill the lens

  .. _/NXxraylens/gas_pressure-field:

  .. index:: gas_pressure (field)

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

    Gas pressure in the lens

  .. _/NXxraylens/cylinder_orientation-group:

  **cylinder_orientation**: (optional) :ref:`NXnote`

    Orientation of the cylinder axis.


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:`/NXxraylens/aperture-field </NXxraylens/aperture-field>`                         :ref:`#nxxraylens-aperture-field </NXxraylens/aperture-field>`                        
:ref:`/NXxraylens/curvature-field </NXxraylens/curvature-field>`                       :ref:`#nxxraylens-curvature-field </NXxraylens/curvature-field>`                      
:ref:`/NXxraylens/cylinder_orientation-group </NXxraylens/cylinder_orientation-group>` :ref:`#nxxraylens-cylinder-orientation-group </NXxraylens/cylinder_orientation-group>`
:ref:`/NXxraylens/cylindrical-field </NXxraylens/cylindrical-field>`                   :ref:`#nxxraylens-cylindrical-field </NXxraylens/cylindrical-field>`                  
:ref:`/NXxraylens/focus_type-field </NXxraylens/focus_type-field>`                     :ref:`#nxxraylens-focus-type-field </NXxraylens/focus_type-field>`                    
:ref:`/NXxraylens/gas-field </NXxraylens/gas-field>`                                   :ref:`#nxxraylens-gas-field </NXxraylens/gas-field>`                                  
:ref:`/NXxraylens/gas_pressure-field </NXxraylens/gas_pressure-field>`                 :ref:`#nxxraylens-gas-pressure-field </NXxraylens/gas_pressure-field>`                
:ref:`/NXxraylens/lens_geometry-field </NXxraylens/lens_geometry-field>`               :ref:`#nxxraylens-lens-geometry-field </NXxraylens/lens_geometry-field>`              
:ref:`/NXxraylens/lens_length-field </NXxraylens/lens_length-field>`                   :ref:`#nxxraylens-lens-length-field </NXxraylens/lens_length-field>`                  
:ref:`/NXxraylens/lens_material-field </NXxraylens/lens_material-field>`               :ref:`#nxxraylens-lens-material-field </NXxraylens/lens_material-field>`              
:ref:`/NXxraylens/lens_thickness-field </NXxraylens/lens_thickness-field>`             :ref:`#nxxraylens-lens-thickness-field </NXxraylens/lens_thickness-field>`            
:ref:`/NXxraylens/number_of_lenses-field </NXxraylens/number_of_lenses-field>`         :ref:`#nxxraylens-number-of-lenses-field </NXxraylens/number_of_lenses-field>`        
:ref:`/NXxraylens/symmetric-field </NXxraylens/symmetric-field>`                       :ref:`#nxxraylens-symmetric-field </NXxraylens/symmetric-field>`                      
:ref:`/NXxraylens@default-attribute </NXxraylens@default-attribute>`                   :ref:`#nxxraylens-default-attribute </NXxraylens@default-attribute>`                  
====================================================================================== ======================================================================================


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