.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXxraylens.nxdl.xml -- DO NOT EDIT .. index:: ! NXxraylens (base class) ! xraylens (base class) see: xraylens (base class); NXxraylens .. _NXxraylens: ========== NXxraylens ========== .. 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 **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: An X-ray lens, typically at a synchrotron X-ray beam line. ... 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`, :ref:`NXoff_geometry`, :ref:`NXtransformations` .. index:: NXnote (base class); used in base class, NXoff_geometry (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXxraylens@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. .. _/NXxraylens/lens_geometry-field: .. index:: lens_geometry (field) **lens_geometry**: (optional) :ref:`NX_CHAR ` .. collapse:: Geometry of the lens ... Geometry of the lens Any of these values: * ``paraboloid`` * ``spherical`` * ``elliptical`` * ``hyperbolical`` .. _/NXxraylens/symmetric-field: .. index:: symmetric (field) **symmetric**: (optional) :ref:`NX_BOOLEAN ` Is the device symmetric? .. _/NXxraylens/cylindrical-field: .. index:: cylindrical (field) **cylindrical**: (optional) :ref:`NX_BOOLEAN ` Is the device cylindrical? .. _/NXxraylens/focus_type-field: .. index:: focus_type (field) **focus_type**: (optional) :ref:`NX_CHAR ` .. collapse:: The type of focus of the lens ... 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 ` {units=\ :ref:`NX_LENGTH `} Thickness of the lens .. _/NXxraylens/lens_length-field: .. index:: lens_length (field) **lens_length**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_LENGTH `} Length of the lens .. _/NXxraylens/curvature-field: .. index:: curvature (field) **curvature**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`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 ` {units=\ :ref:`NX_LENGTH `} Diameter of the lens. .. _/NXxraylens/number_of_lenses-field: .. index:: number_of_lenses (field) **number_of_lenses**: (optional) :ref:`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 ` Material used to make the lens. .. _/NXxraylens/gas-field: .. index:: gas (field) **gas**: (optional) :ref:`NX_CHAR ` Gas used to fill the lens .. _/NXxraylens/gas_pressure-field: .. index:: gas_pressure (field) **gas_pressure**: (optional) :ref:`NX_FLOAT ` {units=\ :ref:`NX_PRESSURE `} Gas pressure in the lens .. _/NXxraylens/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 x-ray lens. .. _/NXxraylens/cylinder_orientation-group: **cylinder_orientation**: (optional) :ref:`NXnote` Orientation of the cylinder axis. .. _/NXxraylens/OFF_GEOMETRY-group: **OFF_GEOMETRY**: (optional) :ref:`NXoff_geometry` This group describes the shape of the beam line component .. _/NXxraylens/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:`/NXxraylens/aperture-field ` * :ref:`/NXxraylens/curvature-field ` * :ref:`/NXxraylens/cylinder_orientation-group ` * :ref:`/NXxraylens/cylindrical-field ` * :ref:`/NXxraylens/depends_on-field ` * :ref:`/NXxraylens/focus_type-field ` * :ref:`/NXxraylens/gas-field ` * :ref:`/NXxraylens/gas_pressure-field ` * :ref:`/NXxraylens/lens_geometry-field ` * :ref:`/NXxraylens/lens_length-field ` * :ref:`/NXxraylens/lens_material-field ` * :ref:`/NXxraylens/lens_thickness-field ` * :ref:`/NXxraylens/number_of_lenses-field ` * :ref:`/NXxraylens/OFF_GEOMETRY-group ` * :ref:`/NXxraylens/symmetric-field ` * :ref:`/NXxraylens/TRANSFORMATIONS-group ` * :ref:`/NXxraylens@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXxraylens.nxdl.xml