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

.. index::
    ! NXcapillary (base class)
    ! capillary (base class)
    see: capillary (base class); NXcapillary

.. _NXcapillary:

===========
NXcapillary
===========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  .. collapse:: A capillary lens to focus the X-ray beam. ...

      A capillary lens to focus the X-ray beam.

      Based on information provided by Gerd Wellenreuther (DESY).

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdata`

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

**Structure**:

  .. _/NXcapillary/type-field:

  .. index:: type (field)

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

    .. collapse:: Type of the capillary ...

        Type of the capillary

        Any of these values:

          * ``single_bounce``

          * ``polycapillary``

          * ``conical_capillary``


  .. _/NXcapillary/manufacturer-field:

  .. index:: manufacturer (field)

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

    .. collapse:: The manufacturer of the capillary. This is actually important as  ...

        The manufacturer of the capillary. This is actually important as 
        it may have an impact on performance.

  .. _/NXcapillary/maximum_incident_angle-field:

  .. index:: maximum_incident_angle (field)

  **maximum_incident_angle**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 


  .. _/NXcapillary/accepting_aperture-field:

  .. index:: accepting_aperture (field)

  **accepting_aperture**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 


  .. _/NXcapillary/working_distance-field:

  .. index:: working_distance (field)

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


  .. _/NXcapillary/focal_size-field:

  .. index:: focal_size (field)

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

    The focal size in FWHM

  .. _/NXcapillary/depends_on-field:

  .. index:: depends_on (field)

  **depends_on**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/depends_on-field>`

    .. collapse::     Add a definition for the reference point of a capillary lens. ...

        .. todo::
            Add a definition for the reference point of a capillary lens.

  .. _/NXcapillary/gain-group:

  **gain**: (optional) :ref:`NXdata` :ref:`⤆ </NXobject/DATA-group>`

    The gain of the capillary as a function of energy

  .. _/NXcapillary/transmission-group:

  **transmission**: (optional) :ref:`NXdata` :ref:`⤆ </NXobject/DATA-group>`

    The transmission of the capillary as a function of energy


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

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


* :ref:`/NXcapillary/accepting_aperture-field </NXcapillary/accepting_aperture-field>`
* :ref:`/NXcapillary/depends_on-field </NXcapillary/depends_on-field>`
* :ref:`/NXcapillary/focal_size-field </NXcapillary/focal_size-field>`
* :ref:`/NXcapillary/gain-group </NXcapillary/gain-group>`
* :ref:`/NXcapillary/manufacturer-field </NXcapillary/manufacturer-field>`
* :ref:`/NXcapillary/maximum_incident_angle-field </NXcapillary/maximum_incident_angle-field>`
* :ref:`/NXcapillary/transmission-group </NXcapillary/transmission-group>`
* :ref:`/NXcapillary/type-field </NXcapillary/type-field>`
* :ref:`/NXcapillary/working_distance-field </NXcapillary/working_distance-field>`

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