.. 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 =========== .. Contributors List .. |contrib_name| replace:: Aaron Brewster|phyy-nx|https://avatars.githubusercontent.com/u/13471434?v=4|2022-06-15 .. |contrib_name| replace:: Pete R Jemian|prjemian|https://avatars.githubusercontent.com/u/2279984?v=4|2022-01-28 .. |contrib_name| replace:: Peter Chang|PeterC-DLS|https://avatars.githubusercontent.com/u/1381719?v=4|2020-10-20 .. |contrib_name| replace:: Tobias Richter|zjttoefs|https://avatars.githubusercontent.com/u/856440?v=4|2018-05-15 .. |contrib_name| replace:: Joachim Wuttke (l)|jwuttke|https://avatars.githubusercontent.com/u/5262000?v=4|2014-08-26 **Status**: base class, extends :ref:`NXobject` **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`, :ref:`NXtransformations` .. index:: NXdata (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXcapillary@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. collapse:: Declares which child group contains a path leading ... .. 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. .. _/NXcapillary/type-field: .. index:: type (field) **type**: (optional) :ref:`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 ` .. 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 ` {units=\ :ref:`NX_ANGLE `} .. _/NXcapillary/accepting_aperture-field: .. index:: accepting_aperture (field) **accepting_aperture**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_ANGLE `} .. _/NXcapillary/working_distance-field: .. index:: working_distance (field) **working_distance**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} .. _/NXcapillary/focal_size-field: .. index:: focal_size (field) **focal_size**: (optional) :ref:`NX_FLOAT ` The focal size in FWHM .. _/NXcapillary/depends_on-field: .. index:: depends_on (field) **depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: NeXus positions components by applying a set of translations and rotations ... NeXus positions components by applying a set of translations and rotations to apply to the component starting from 0, 0, 0. The order of these operations is critical and forms what NeXus calls a dependency chain. The depends_on field defines the path to the top most operation of the dependency chain or the string "." if located in the origin. Usually these operations are stored in a NXtransformations group. But NeXus allows them to be stored anywhere. .. todo:: Add a definition for the reference point of a capillary lens. .. _/NXcapillary/gain-group: **gain**: (optional) :ref:`NXdata` The gain of the capillary as a function of energy .. _/NXcapillary/transmission-group: **transmission**: (optional) :ref:`NXdata` The transmission of the capillary as a function of energy .. _/NXcapillary/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: This is the group recommended for holding the chain of translation ... This is the group recommended for holding the chain of translation and rotation operations necessary to position the component within the instrument. The dependency chain may however traverse similar groups in other component groups. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXcapillary/accepting_aperture-field ` * :ref:`/NXcapillary/depends_on-field ` * :ref:`/NXcapillary/focal_size-field ` * :ref:`/NXcapillary/gain-group ` * :ref:`/NXcapillary/manufacturer-field ` * :ref:`/NXcapillary/maximum_incident_angle-field ` * :ref:`/NXcapillary/TRANSFORMATIONS-group ` * :ref:`/NXcapillary/transmission-group ` * :ref:`/NXcapillary/type-field ` * :ref:`/NXcapillary/working_distance-field ` * :ref:`/NXcapillary@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXcapillary.nxdl.xml