.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXlens_em.nxdl.xml -- DO NOT EDIT .. index:: ! NXlens_em (base class) ! lens_em (base class) see: lens_em (base class); NXlens_em .. _NXlens_em: ========= NXlens_em ========= **Status**: base class, extends :ref:`NXobject` **Description**: .. collapse:: Base class for an electro-magnetic lens or a compound lens. ... Base class for an electro-magnetic lens or a compound lens. For :ref:`NXtransformations` the origin of the coordinate system is placed in the center of the lens (its polepiece, pinhole, or another point of reference). The origin should be specified in the :ref:`NXtransformations`. For details of electro-magnetic lenses in the literature see e.g. `L. Reimer `_ **Symbols**: No symbol table **Groups cited**: :ref:`NXfabrication`, :ref:`NXtransformations` .. index:: NXfabrication (base class); used in base class, NXtransformations (base class); used in base class **Structure**: .. _/NXlens_em@depends_on-attribute: .. index:: depends_on (file attribute) **@depends_on**: (optional) :ref:`NX_CHAR ` .. collapse:: Specifies the position of the lens by pointing to the last transformation in t ... Specifies the position of the lens by pointing to the last transformation in the transformation chain in the NXtransformations group. .. _/NXlens_em/type-field: .. index:: type (field) **type**: (optional) :ref:`NX_CHAR ` .. collapse:: Qualitative type of lens with respect to the number of pole pieces. ... Qualitative type of lens with respect to the number of pole pieces. Any of these values: * ``single`` * ``double`` * ``quadrupole`` * ``hexapole`` * ``octupole`` .. _/NXlens_em/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` .. collapse:: Given name, alias, colloquial, or short name for the lens. ... Given name, alias, colloquial, or short name for the lens. For manufacturer names and identifiers use respective manufacturer fields. .. _/NXlens_em/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` .. collapse:: Ideally an identifier, persistent link, or free text which ... Ideally an identifier, persistent link, or free text which gives further details about the lens. .. _/NXlens_em/voltage-field: .. index:: voltage (field) **voltage**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_VOLTAGE `} .. collapse:: Excitation voltage of the lens. ... Excitation voltage of the lens. For dipoles it is a single number. For higher order multipoles, it is an array. .. _/NXlens_em/current-field: .. index:: current (field) **current**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_CURRENT `} .. collapse:: Excitation current of the lens. ... Excitation current of the lens. For dipoles it is a single number. For higher order multipoles, it is an array. .. _/NXlens_em/value-field: .. index:: value (field) **value**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_ANY `} .. collapse:: This field should be used when the exact voltage or current of the lens is not ... This field should be used when the exact voltage or current of the lens is not directly controllable as the control software of the microscope does not enable or was not configured to display these values (for end users). In this case this value field should be used and the value from the control software stored as is. Although this value does not document the exact physical voltage or excitation, it can still give useful context to reproduce the lens setting, provided a properly working instrument and software sets the lens into a similar state to the technical level possible when no more information is available physically or accessible legally. .. _/NXlens_em/mode-field: .. index:: mode (field) **mode**: (optional) :ref:`NX_CHAR ` .. collapse:: This field should be used when the exact operation mode of the lens ... This field should be used when the exact operation mode of the lens is not directly controllable as the control software of the microscope does not enable or was not configured to display these values. Like value the mode can only be interpreted for a specific microscope but can still be useful to guide users as to how to repeat the measurement. .. _/NXlens_em/FABRICATION-group: **FABRICATION**: (optional) :ref:`NXfabrication` .. _/NXlens_em/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` .. collapse:: Collection of axis-based translations and rotations to describe the ... Collection of axis-based translations and rotations to describe the location and geometry of the lens as a component in the instrument. Typically, the components of a system should all be related relative to each other and only one component should relate to the reference coordinate system. Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXlens_em/current-field ` * :ref:`/NXlens_em/description-field ` * :ref:`/NXlens_em/FABRICATION-group ` * :ref:`/NXlens_em/mode-field ` * :ref:`/NXlens_em/name-field ` * :ref:`/NXlens_em/TRANSFORMATIONS-group ` * :ref:`/NXlens_em/type-field ` * :ref:`/NXlens_em/value-field ` * :ref:`/NXlens_em/voltage-field ` * :ref:`/NXlens_em@depends_on-attribute ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXlens_em.nxdl.xml