.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXcorrector_cs.nxdl.xml

.. 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:`NXobject`

**Description**:

  Corrector for aberrations in an electron microscope.

  Different vendors use a different naming schemes for aberration coefficients.
  It is the users responsibility to map to the best matching values.

  In transmission electron microscopes the spherical aberration corrector is
  a component that is controlled via instructing the microscope to achieve
  set point values. The corrector is composed of multiple lenses and other
  parts with vendor-specific details which are often undisclosed.

  In the case of Nion Co. microscopes the coefficients of the corrector can be
  retrieved via NionSwift, which is why currently the Nion convention for the
  aberration coefficients is used.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXaberration`, :ref:`NXfabrication`, :ref:`NXlens_em`, :ref:`NXtransformations`

.. index:: NXfabrication (base class); used in base class, NXaberration (base class); used in base class, NXlens_em (base class); used in base class, NXtransformations (base class); used in base class

**Structure**:

  .. _/NXcorrector_cs/applied-field:

  .. index:: applied (field)

  **applied**: (optional) :ref:`NX_BOOLEAN <NX_BOOLEAN>`

    Was the corrector used?

  .. _/NXcorrector_cs/name-field:

  .. index:: name (field)

  **name**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Given name/alias.

  .. _/NXcorrector_cs/description-field:

  .. index:: description (field)

  **description**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Ideally, a (globally) unique persistent identifier, link,
    or text to a resource which gives further details. If this does not exist
    a free-text field to report further details about the corrector.

  .. _/NXcorrector_cs/FABRICATION-group:

  **FABRICATION**: (optional) :ref:`NXfabrication`


  .. _/NXcorrector_cs/ABERRATION-group:

  **ABERRATION**: (optional) :ref:`NXaberration`


  .. _/NXcorrector_cs/LENS_EM-group:

  **LENS_EM**: (optional) :ref:`NXlens_em`


  .. _/NXcorrector_cs/TRANSFORMATIONS-group:

  **TRANSFORMATIONS**: (optional) :ref:`NXtransformations`



Hypertext Anchors
-----------------

List of hypertext anchors for all groups, fields,
attributes, and links defined in this class.


* :ref:`/NXcorrector_cs/ABERRATION-group </NXcorrector_cs/ABERRATION-group>`
* :ref:`/NXcorrector_cs/applied-field </NXcorrector_cs/applied-field>`
* :ref:`/NXcorrector_cs/description-field </NXcorrector_cs/description-field>`
* :ref:`/NXcorrector_cs/FABRICATION-group </NXcorrector_cs/FABRICATION-group>`
* :ref:`/NXcorrector_cs/LENS_EM-group </NXcorrector_cs/LENS_EM-group>`
* :ref:`/NXcorrector_cs/name-field </NXcorrector_cs/name-field>`
* :ref:`/NXcorrector_cs/TRANSFORMATIONS-group </NXcorrector_cs/TRANSFORMATIONS-group>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/base_classes/NXcorrector_cs.nxdl.xml