.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXcorrector_cs.nxdl.xml -- DO NOT EDIT .. index:: ! NXcorrector_cs (base class) ! corrector_cs (base class) see: corrector_cs (base class); NXcorrector_cs .. _NXcorrector_cs: ============== NXcorrector_cs ============== **Status**: base class, extends :ref:`NXcomponent` **Description**: .. collapse:: Base class for a corrector reducing (spherical) aberrations of an electron optic ... Base class for a corrector reducing (spherical) aberrations of an electron optical setup. Different technology partners use different conventions and models for quantifying the aberration coefficients. Aberration correction components are especially important for (scanning) transmission electron microscopy. Composed of multiple lenses and multipole stigmators, their technical details are specific for the technology partner as well as the microscope and instrument. Most technical details are proprietary knowledge. If one component corrects for multiple types of aberrations (like it is the case reported here `CEOS `_) follow this design when using corrector and monochromator in an application definition: * Use :ref:`NXcorrector_cs` for spherical aberration * Use :ref:`NXmonochromator` for energy filtering or chromatic aberration * Use the group corrector_ax in :ref:`NXem` for axial astigmatism aberration Although this base class currently provides concepts that are foremost used in the field of electron microscopy using this base class is not restricted to this research field. NXcorrector_cs can also serve as a container to detail, in combination with :ref:`NXaberration`, about measured aberrations in classical optics. In optics, though, the difference is that the design of the :ref:`NXoptical_lens` itself (e.g., using aspheric lenses or combinations of lenses) enables to reduce spherical aberrations. **Symbols**: The symbols used in the schema to specify e.g. dimensions of arrays. **n_img**: Number of images taken, at least one. **Groups cited**: :ref:`NXaberration`, :ref:`NXaperture`, :ref:`NXdeflector`, :ref:`NXelectromagnetic_lens`, :ref:`NXimage`, :ref:`NXoptical_lens`, :ref:`NXprocess` .. index:: NXprocess (base class); used in base class, NXimage (base class); used in base class, NXaberration (base class); used in base class, NXelectromagnetic_lens (base class); used in base class, NXoptical_lens (base class); used in base class, NXaperture (base class); used in base class, NXdeflector (base class); used in base class **Structure**: .. _/NXcorrector_cs/applied-field: .. index:: applied (field) **applied**: (optional) :ref:`NX_BOOLEAN ` :ref:`⤆ ` Was the corrector used? .. _/NXcorrector_cs/tableauID-group: **tableau**\ :bolditalic:`ID`: (optional) :ref:`NXprocess` .. collapse:: Specific information about the alignment procedure. This is a process during w ... Specific information about the alignment procedure. This is a process during which the corrector is configured to enable calibrated usage of the instrument. This :ref:`NXprocess` group should also be used when one describes in a computer simulation the specific details about the modeled or assumed aberrations. .. _/NXcorrector_cs/tableauID/description-field: .. index:: description (field) **description**: (optional) :ref:`NX_CHAR ` .. collapse:: Discouraged free-text field to add further details about the alignment ... Discouraged free-text field to add further details about the alignment procedure. .. _/NXcorrector_cs/tableauID/tilt_angle-field: .. index:: tilt_angle (field) **tilt_angle**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_img]) {units=\ :ref:`NX_ANGLE `} .. collapse:: The outer tilt angle of the beam in tableau acquisition. ... The outer tilt angle of the beam in tableau acquisition. TODO: The relevant axes which span the tilt_angle need a cleaner description. Suggestions from the community are welcome here for guiding an improvement of this base class. .. _/NXcorrector_cs/tableauID/exposure_time-field: .. index:: exposure_time (field) **exposure_time**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_img]) {units=\ :ref:`NX_TIME `} The exposure time of single tilt images. .. _/NXcorrector_cs/tableauID/magnification-field: .. index:: magnification (field) **magnification**: (optional) :ref:`NX_NUMBER ` (Rank: 1, Dimensions: [n_img]) {units=\ :ref:`NX_DIMENSIONLESS `} .. collapse:: The factor of enlargement of the apparent size, ... The factor of enlargement of the apparent size, not the physical size, of an object. .. _/NXcorrector_cs/tableauID/model-field: .. index:: model (field) **model**: (optional) :ref:`NX_CHAR ` .. collapse:: Convention used for storing measured or estimated aberrations (for each or t ... Convention used for storing measured or estimated aberrations (for each or the final image) via fields c_1, a_1, c_1_0, c_1_2_a, and so on and so forth. See `S. J. Pennycock and P. D. Nellist `_ (page 44ff, and page 118ff) for different definitions available and further details. Table 7-2 of Ibid. publication (page 305ff) documents how to convert from the Nion to the CEOS definitions. Conversion tables are also summarized by `Y. Liao `_. Any of these values: ``ceos`` | ``nion`` .. _/NXcorrector_cs/tableauID/imageID-group: **image**\ :bolditalic:`ID`: (optional) :ref:`NXimage` Image(s) taken during the alignment procedure .. _/NXcorrector_cs/tableauID/c_1-group: **c_1**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/a_1-group: **a_1**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/b_2-group: **b_2**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/a_2-group: **a_2**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_3-group: **c_3**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/s_3-group: **s_3**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/a_3-group: **a_3**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/b_4-group: **b_4**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/d_4-group: **d_4**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/a_4-group: **a_4**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5-group: **c_5**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/s_5-group: **s_5**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/r_5-group: **r_5**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/a_6-group: **a_6**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_1_0-group: **c_1_0**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_1_2_a-group: **c_1_2_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_1_2_b-group: **c_1_2_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_2_1_a-group: **c_2_1_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_2_1_b-group: **c_2_1_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_2_3_a-group: **c_2_3_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_2_3_b-group: **c_2_3_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_3_0-group: **c_3_0**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_3_2_a-group: **c_3_2_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_3_2_b-group: **c_3_2_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_3_4_a-group: **c_3_4_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_3_4_b-group: **c_3_4_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_4_1_a-group: **c_4_1_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_4_1_b-group: **c_4_1_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_4_3_a-group: **c_4_3_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_4_3_b-group: **c_4_3_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_4_5_a-group: **c_4_5_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_4_5_b-group: **c_4_5_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5_0-group: **c_5_0**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5_2_a-group: **c_5_2_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5_2_b-group: **c_5_2_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5_4_a-group: **c_5_4_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5_4_b-group: **c_5_4_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5_6_a-group: **c_5_6_a**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/tableauID/c_5_6_b-group: **c_5_6_b**: (optional) :ref:`NXaberration` .. _/NXcorrector_cs/ELECTROMAGNETIC_LENS-group: :bolditalic:`ELECTROMAGNETIC_LENS`: (optional) :ref:`NXelectromagnetic_lens` .. _/NXcorrector_cs/OPTICAL_LENS-group: :bolditalic:`OPTICAL_LENS`: (optional) :ref:`NXoptical_lens` .. _/NXcorrector_cs/APERTURE-group: :bolditalic:`APERTURE`: (optional) :ref:`NXaperture` .. _/NXcorrector_cs/DEFLECTOR-group: :bolditalic:`DEFLECTOR`: (optional) :ref:`NXdeflector` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXcorrector_cs/APERTURE-group ` * :ref:`/NXcorrector_cs/applied-field ` * :ref:`/NXcorrector_cs/DEFLECTOR-group ` * :ref:`/NXcorrector_cs/ELECTROMAGNETIC_LENS-group ` * :ref:`/NXcorrector_cs/OPTICAL_LENS-group ` * :ref:`/NXcorrector_cs/tableauID-group ` * :ref:`/NXcorrector_cs/tableauID/a_1-group ` * :ref:`/NXcorrector_cs/tableauID/a_2-group ` * :ref:`/NXcorrector_cs/tableauID/a_3-group ` * :ref:`/NXcorrector_cs/tableauID/a_4-group ` * :ref:`/NXcorrector_cs/tableauID/a_6-group ` * :ref:`/NXcorrector_cs/tableauID/b_2-group ` * :ref:`/NXcorrector_cs/tableauID/b_4-group ` * :ref:`/NXcorrector_cs/tableauID/c_1-group ` * :ref:`/NXcorrector_cs/tableauID/c_1_0-group ` * :ref:`/NXcorrector_cs/tableauID/c_1_2_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_1_2_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_2_1_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_2_1_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_2_3_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_2_3_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_3-group ` * :ref:`/NXcorrector_cs/tableauID/c_3_0-group ` * :ref:`/NXcorrector_cs/tableauID/c_3_2_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_3_2_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_3_4_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_3_4_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_4_1_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_4_1_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_4_3_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_4_3_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_4_5_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_4_5_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_5-group ` * :ref:`/NXcorrector_cs/tableauID/c_5_0-group ` * :ref:`/NXcorrector_cs/tableauID/c_5_2_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_5_2_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_5_4_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_5_4_b-group ` * :ref:`/NXcorrector_cs/tableauID/c_5_6_a-group ` * :ref:`/NXcorrector_cs/tableauID/c_5_6_b-group ` * :ref:`/NXcorrector_cs/tableauID/d_4-group ` * :ref:`/NXcorrector_cs/tableauID/description-field ` * :ref:`/NXcorrector_cs/tableauID/exposure_time-field ` * :ref:`/NXcorrector_cs/tableauID/imageID-group ` * :ref:`/NXcorrector_cs/tableauID/magnification-field ` * :ref:`/NXcorrector_cs/tableauID/model-field ` * :ref:`/NXcorrector_cs/tableauID/r_5-group ` * :ref:`/NXcorrector_cs/tableauID/s_3-group ` * :ref:`/NXcorrector_cs/tableauID/s_5-group ` * :ref:`/NXcorrector_cs/tableauID/tilt_angle-field ` **NXDL Source**: https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXcorrector_cs.nxdl.xml