.. auto-generated by dev_tools.docs.nxdl from the NXDL source contributed_definitions/NXebeam_column.nxdl.xml -- DO NOT EDIT .. index:: ! NXebeam_column (base class) ! ebeam_column (base class) see: ebeam_column (base class); NXebeam_column .. _NXebeam_column: ============== NXebeam_column ============== **Status**: base class, extends :ref:`NXobject` **Description**: Base class for a set of components providing a controllable electron beam. **Symbols**: No symbol table **Groups cited**: :ref:`NXaperture_em`, :ref:`NXbeam`, :ref:`NXchamber`, :ref:`NXcorrector_cs`, :ref:`NXdeflector`, :ref:`NXfabrication`, :ref:`NXlens_em`, :ref:`NXsensor`, :ref:`NXsource`, :ref:`NXtransformations` .. index:: NXchamber (base class); used in base class, NXfabrication (base class); used in base class, NXsource (base class); used in base class, NXtransformations (base class); used in base class, NXaperture_em (base class); used in base class, NXlens_em (base class); used in base class, NXcorrector_cs (base class); used in base class, NXsensor (base class); used in base class, NXbeam (base class); used in base class, NXdeflector (base class); used in base class **Structure**: .. _/NXebeam_column/operation_mode-field: .. index:: operation_mode (field) **operation_mode**: (optional) :ref:`NX_CHAR ` .. collapse:: Typically tech-partner, microscope-, and control software-specific ... Typically tech-partner, microscope-, and control software-specific name of the specific operation mode how the ebeam_column and its components are controlled to achieve a specific illumination condition. In most cases users do not know, have to care, or are able to disentangle the details of the spatiotemporal dynamics of the components of the microscope. Instead, they rely on the assumption that the microscope and control software work as expected. Selecting then a specific operation_mode assures some level of reproducibility in the illumination conditions. .. _/NXebeam_column/CHAMBER-group: **CHAMBER**: (optional) :ref:`NXchamber` .. _/NXebeam_column/FABRICATION-group: **FABRICATION**: (optional) :ref:`NXfabrication` .. _/NXebeam_column/electron_source-group: **electron_source**: (optional) :ref:`NXsource` The source which creates the electron beam. .. _/NXebeam_column/electron_source/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` Given name/alias. .. _/NXebeam_column/electron_source/voltage-field: .. index:: voltage (field) **voltage**: (optional) :ref:`NX_NUMBER ` {units=\ :ref:`NX_VOLTAGE `} .. collapse:: Voltage relevant to compute the energy of the electrons ... Voltage relevant to compute the energy of the electrons immediately after they left the gun. .. _/NXebeam_column/electron_source/probe-field: .. index:: probe (field) **probe**: (optional) :ref:`NX_CHAR ` :ref:`⤆ ` .. collapse:: Type of radiation. ... Type of radiation. Obligatory value: ``electron`` .. _/NXebeam_column/electron_source/emitter_type-field: .. index:: emitter_type (field) **emitter_type**: (optional) :ref:`NX_CHAR ` .. collapse:: Emitter type used to create the beam. ... Emitter type used to create the beam. If the emitter type is other, give further details in the description field. .. _/NXebeam_column/electron_source/emitter_material-field: .. index:: emitter_material (field) **emitter_material**: (optional) :ref:`NX_CHAR ` Material of which the emitter is build, e.g. the filament material. .. _/NXebeam_column/electron_source/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` .. collapse:: Ideally, a (globally) unique persistent identifier, link, ... Ideally, a (globally) unique persistent identifier, link, or text to a resource which gives further details. .. _/NXebeam_column/electron_source/FABRICATION-group: **FABRICATION**: (optional) :ref:`NXfabrication` :ref:`⤆ ` .. _/NXebeam_column/electron_source/TRANSFORMATIONS-group: **TRANSFORMATIONS**: (optional) :ref:`NXtransformations` :ref:`⤆ ` .. 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 component in the instrument. .. _/NXebeam_column/APERTURE_EM-group: **APERTURE_EM**: (optional) :ref:`NXaperture_em` .. _/NXebeam_column/LENS_EM-group: **LENS_EM**: (optional) :ref:`NXlens_em` .. _/NXebeam_column/CORRECTOR_CS-group: **CORRECTOR_CS**: (optional) :ref:`NXcorrector_cs` .. _/NXebeam_column/SENSOR-group: **SENSOR**: (optional) :ref:`NXsensor` .. _/NXebeam_column/BEAM-group: **BEAM**: (optional) :ref:`NXbeam` .. collapse:: Individual characterization results for the position, shape, ... Individual characterization results for the position, shape, and characteristics of the electron beam. :ref:`NXtransformations` should be used to specify the location of the position at which the beam was probed. .. _/NXebeam_column/DEFLECTOR-group: **DEFLECTOR**: (optional) :ref:`NXdeflector` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXebeam_column/APERTURE_EM-group ` * :ref:`/NXebeam_column/BEAM-group ` * :ref:`/NXebeam_column/CHAMBER-group ` * :ref:`/NXebeam_column/CORRECTOR_CS-group ` * :ref:`/NXebeam_column/DEFLECTOR-group ` * :ref:`/NXebeam_column/electron_source-group ` * :ref:`/NXebeam_column/electron_source/description-field ` * :ref:`/NXebeam_column/electron_source/emitter_material-field ` * :ref:`/NXebeam_column/electron_source/emitter_type-field ` * :ref:`/NXebeam_column/electron_source/FABRICATION-group ` * :ref:`/NXebeam_column/electron_source/name-field ` * :ref:`/NXebeam_column/electron_source/probe-field ` * :ref:`/NXebeam_column/electron_source/TRANSFORMATIONS-group ` * :ref:`/NXebeam_column/electron_source/voltage-field ` * :ref:`/NXebeam_column/FABRICATION-group ` * :ref:`/NXebeam_column/LENS_EM-group ` * :ref:`/NXebeam_column/operation_mode-field ` * :ref:`/NXebeam_column/SENSOR-group ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/contributed_definitions/NXebeam_column.nxdl.xml