NXlens¶
Status:
base class, extends NXobject
Description:
Draft class definition for electro-static lenses as they are used e.g. in an electron analyser.
Symbols:
No symbol table
- Groups cited:
Structure:
type: (optional) NX_CHAR
Qualitative type of lens with respect to the number of pole pieces
Any of these values:
single
double
quadrupole
hexapole
octupolename: (optional) NX_CHAR
Colloquial or short name for the lens. For manufacturer names and identifiers use respective manufacturer fields.
manufacturer_name: (optional) NX_CHAR
Name of the manufacturer who built/constructed the lens.
manufacturer_model: (optional) NX_CHAR
Hardware name, hash identifier, or serial number that was given by the manufacturer to identify the lens.
description: (optional) NX_CHAR
Ideally an identifier, persistent link, or free text which gives further details about the lens.
voltage: (optional) NX_NUMBER {units=NX_VOLTAGE}
Excitation voltage of the lens. For dipoles it is a single number. For higher orders, it is an array.
current: (optional) NX_NUMBER {units=NX_CURRENT}
Excitation current of the lens. For dipoles it is a single number. For higher orders, it is an array.
TRANSFORMATIONS: (optional) NXtransformations
Collection of axis-based translations and rotations to describe the location and geometry of the corrector as a component in the instrument. Conventions from the NXtransformations base class are used. In principle, the McStas coordinate system is used. The origin of the coordinate system is placed in the center of the gun pinhole as the virtual point-like assumed source of the electron beam. A right-handed coordinate system is assumed whose positive z-axis points in the direction of the propagating electron beam.
position: (optional) NX_CHAR
@transformation_type: (optional) NX_CHAR
Following transformation_type argument of NXtranslations but allowed value is only translation.
@vector: (optional) NX_NUMBER
Following vector argument of NXtranslations. The translation actively brings the coordinate system under depends_on into registration with a coordinate system in the center of the lens.
@depends_on: (optional) NX_CHAR
Enter the path where the reference coordinate system for the instrument is defined.
Hypertext Anchors¶
Table of hypertext anchors for all groups, fields, attributes, and links defined in this class.
documentation (reST source) anchor |
web page (HTML) anchor |
|---|---|
/NXlens/TRANSFORMATIONS/position@transformation_type-attribute |
#nxlens-transformations-position-transformation-type-attribute |
