.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXlens_opt.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXlens_opt (base class)
    ! lens_opt (base class)
    see: lens_opt (base class); NXlens_opt

.. _NXlens_opt:

==========
NXlens_opt
==========

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Description of an optical lens.

**Symbols**:


  **N_spectrum**: Size of the wavelength array for which the refractive index of the material is given.

  **N_spectrum_coating**: Size of the wavelength array for which the refractive index of the coating is given.

  **N_spectrum_RT**: Size of the wavelength array for which the reflectance or transmission of the lens is given.

**Groups cited**:
  :ref:`NXsample`

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

**Structure**:

  .. _/NXlens_opt/type-field:

  .. index:: type (field)

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

    .. collapse:: Type of the lens (e.g. concave, convex etc.). ...

        Type of the lens (e.g. concave, convex etc.).

        Any of these values:

          * ``biconcave``

          * ``plano-concave``

          * ``convexo-concave``

          * ``biconvex``

          * ``plano-convex``

          * ``concavo-convex``

          * ``Fresnel lens``

          * ``other``


  .. _/NXlens_opt/other_type-field:

  .. index:: other_type (field)

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

    If you chose 'other' as type specify what it is.

  .. _/NXlens_opt/chromatic-field:

  .. index:: chromatic (field)

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

    Is it a chromatic lens?

  .. _/NXlens_opt/lens_diameter-field:

  .. index:: lens_diameter (field)

  **lens_diameter**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    Diameter of the lens.

  .. _/NXlens_opt/reflectance-field:

  .. index:: reflectance (field)

  **reflectance**: (optional) :ref:`NX_CHAR <NX_CHAR>` (Rank: 1, Dimensions: [N_spectrum_RT]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    Reflectance of the lens at given spectral values.

  .. _/NXlens_opt/transmission-field:

  .. index:: transmission (field)

  **transmission**: (optional) :ref:`NX_CHAR <NX_CHAR>` (Rank: 1, Dimensions: [N_spectrum_RT]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    Transmission of the lens at given spectral values.

  .. _/NXlens_opt/focal_length-field:

  .. index:: focal_length (field)

  **focal_length**: (recommended) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 1, Dimensions: [2]) {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: Focal length of the lens on the front side (first value), i.e. where the ...

        Focal length of the lens on the front side (first value), i.e. where the
        beam is incident, and on the back side (second value).

  .. _/NXlens_opt/curvature_radius_FACE-field:

  .. index:: curvature_radius_FACE (field)

  **curvature_radius_FACE**: (recommended) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: Curvature radius of the lens. ...

        Curvature radius of the lens.
        Instead of 'FACE' in the name of this field, the user is advised to
        specify for which surface (e.g. front or back) the curvature is provided:
        e.g. curvature_front or curvature_back. The front face is the surface on
        which the light beam is incident, while the back face is the one from
        which the light beam exits the lens.

  .. _/NXlens_opt/Abbe_number-field:

  .. index:: Abbe_number (field)

  **Abbe_number**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    Abbe number (or V-number) of the lens.

  .. _/NXlens_opt/numerical_aperture-field:

  .. index:: numerical_aperture (field)

  **numerical_aperture**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` 

    The numerical aperture of the used incident light optics.

  .. _/NXlens_opt/magnification-field:

  .. index:: magnification (field)

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


  .. _/NXlens_opt/substrate-group:

  **substrate**: (optional) :ref:`NXsample` 

    .. collapse:: Properties of the substrate material of the lens. If the lens has a ...

        Properties of the substrate material of the lens. If the lens has a
        coating specify the coating material and its properties in 'coating'.

    .. _/NXlens_opt/substrate/substrate_material-field:

    .. index:: substrate_material (field)

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

      Specify the substrate material of the lens.

    .. _/NXlens_opt/substrate/substrate_thickness-field:

    .. index:: substrate_thickness (field)

    **substrate_thickness**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

      Thickness of the lens substrate at the optical axis.

    .. _/NXlens_opt/substrate/index_of_refraction-field:

    .. index:: index_of_refraction (field)

    **index_of_refraction**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [2, N_spectrum]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

      .. collapse:: Complex index of refraction of the lens material. Specify at given ...

          Complex index of refraction of the lens material. Specify at given
          wavelength (or energy, wavenumber etc.) values.

  .. _/NXlens_opt/COATING-group:

  **COATING**: (optional) :ref:`NXsample` 

    .. collapse:: If the lens has a coating describe the material and its properties. ...

        If the lens has a coating describe the material and its properties.
        Some basic information can be found e.g. [here]
        (https://www.opto-e.com/basics/reflection-transmission-and-coatings).
        If the back and front side of the lens are coated with different
        materials, use separate COATING(NXsample) fields to describe the coatings
        on the front and back side, respectively. For example:
        coating_front(NXsample) and coating_back(NXsample).

    .. _/NXlens_opt/COATING/coating_type-field:

    .. index:: coating_type (field)

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

      .. collapse:: Specify the coating type (e.g. dielectric, anti-reflection (AR), ...

          Specify the coating type (e.g. dielectric, anti-reflection (AR),
          multilayer coating etc.).

    .. _/NXlens_opt/COATING/coating_material-field:

    .. index:: coating_material (field)

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

      Describe the coating material (e.g. MgF2).

    .. _/NXlens_opt/COATING/coating_thickness-field:

    .. index:: coating_thickness (field)

    **coating_thickness**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

      Thickness of the coating.

    .. _/NXlens_opt/COATING/index_of_refraction_coating-field:

    .. index:: index_of_refraction_coating (field)

    **index_of_refraction_coating**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` (Rank: 2, Dimensions: [2, N_spectrum_coating]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

      .. collapse:: Complex index of refraction of the coating. Specify at given spectral ...

          Complex index of refraction of the coating. Specify at given spectral
          values (wavelength, energy, wavenumber etc.).


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

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


* :ref:`/NXlens_opt/Abbe_number-field </NXlens_opt/Abbe_number-field>`
* :ref:`/NXlens_opt/chromatic-field </NXlens_opt/chromatic-field>`
* :ref:`/NXlens_opt/COATING-group </NXlens_opt/COATING-group>`
* :ref:`/NXlens_opt/COATING/coating_material-field </NXlens_opt/COATING/coating_material-field>`
* :ref:`/NXlens_opt/COATING/coating_thickness-field </NXlens_opt/COATING/coating_thickness-field>`
* :ref:`/NXlens_opt/COATING/coating_type-field </NXlens_opt/COATING/coating_type-field>`
* :ref:`/NXlens_opt/COATING/index_of_refraction_coating-field </NXlens_opt/COATING/index_of_refraction_coating-field>`
* :ref:`/NXlens_opt/curvature_radius_FACE-field </NXlens_opt/curvature_radius_FACE-field>`
* :ref:`/NXlens_opt/focal_length-field </NXlens_opt/focal_length-field>`
* :ref:`/NXlens_opt/lens_diameter-field </NXlens_opt/lens_diameter-field>`
* :ref:`/NXlens_opt/magnification-field </NXlens_opt/magnification-field>`
* :ref:`/NXlens_opt/numerical_aperture-field </NXlens_opt/numerical_aperture-field>`
* :ref:`/NXlens_opt/other_type-field </NXlens_opt/other_type-field>`
* :ref:`/NXlens_opt/reflectance-field </NXlens_opt/reflectance-field>`
* :ref:`/NXlens_opt/substrate-group </NXlens_opt/substrate-group>`
* :ref:`/NXlens_opt/substrate/index_of_refraction-field </NXlens_opt/substrate/index_of_refraction-field>`
* :ref:`/NXlens_opt/substrate/substrate_material-field </NXlens_opt/substrate/substrate_material-field>`
* :ref:`/NXlens_opt/substrate/substrate_thickness-field </NXlens_opt/substrate/substrate_thickness-field>`
* :ref:`/NXlens_opt/transmission-field </NXlens_opt/transmission-field>`
* :ref:`/NXlens_opt/type-field </NXlens_opt/type-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXlens_opt.nxdl.xml