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

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

.. _NXcapillary:

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

**Status**:

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

**Description**:

  This is a dictionary of field names to use for describing a capillary as used 
  in X-ray beamlines. Based on information provided by Gerd Wellenreuther.

**Symbols**:

  No symbol table

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

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

**Structure**:

  .. index:: type (data field)

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

    Type of the capillary

    Any of these values:

      * ``single_bounce``

      * ``polycapillary``

      * ``conical_capillary``


  .. index:: manufacturer (data field)

  **manufacturer**: :ref:`NX_CHAR <NX_CHAR>`

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

  .. index:: maximum_incident_angle (data field)

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


  .. index:: accepting_aperture (data field)

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


  .. index:: working_distance (data field)

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


  .. index:: focal_size (data field)

  **focal_size**: :ref:`NX_FLOAT <NX_FLOAT>`

    The focal size in FWHM

  **gain**: :ref:`NXdata`

    The gain of the capillary as a function of energy

  **transmission**: :ref:`NXdata`

    The transmission of the capillary as a function of energy

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