.. auto-generated by dev_tools.docs.nxdl from the NXDL source base_classes/NXaberration.nxdl.xml -- DO NOT EDIT

.. index::
    ! NXaberration (base class)
    ! aberration (base class)
    see: aberration (base class); NXaberration

.. _NXaberration:

============
NXaberration
============

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  .. collapse:: Quantified aberration coefficient in an aberration_model. ...

      Quantified aberration coefficient in an aberration_model.

      For an introduction in the details about aberrations with relevance for electron microscopy
      see `R. Dunin-Borkowski et al. <https://doi.org/10.1017/9781316337455.022>`_ and
      `S. J. Pennycock and P. D. Nellist <https://doi.org/10.1007/978-1-4419-7200-2>`_ (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 <https://www.globalsino.com/EM/page3740.html>`_ an introduction.

      The use of the base class is not restricted to electron microscopy but can also be useful for classical optics.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXaberration/magnitude-field:

  .. index:: magnitude (field)

  **magnitude**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    Magnitude of the aberration

  .. _/NXaberration/magnitude_errors-field:

  .. index:: magnitude_errors (field)

  **magnitude_errors**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} :ref:`⤆ </NXobject/FIELDNAME_errors-field>`

    Uncertainty of the magnitude of the aberration

  .. _/NXaberration/magnitude_errors_model-field:

  .. index:: magnitude_errors_model (field)

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

    .. collapse:: Free-text description how magnitude_errors was quantified ...

        Free-text description how magnitude_errors was quantified
        e.g. via the 95% confidence interval, variance, standard deviation,
        using which algorithm or statistical model.

  .. _/NXaberration/delta_time-field:

  .. index:: delta_time (field)

  **delta_time**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_TIME <NX_TIME>`} 

    Time elapsed since the last measurement.

  .. _/NXaberration/angle-field:

  .. index:: angle (field)

  **angle**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 

    .. collapse:: For the CEOS definitions the C aberrations are radial-symmetric and have ...

        For the CEOS definitions the C aberrations are radial-symmetric and have
        no angle entry, while the A, B, D, S, or R aberrations are n-fold
        symmetric and have an angle entry.
        For the NION definitions the coordinate system differs to the one
        used in CEOS and instead two aberration coefficients a and b are used.

  .. _/NXaberration/name-field:

  .. index:: name (field)

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

    Given name to this aberration.

  .. _/NXaberration/alias-field:

  .. index:: alias (field)

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

    Alias to name or refer to this specific type of aberration.


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

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


* :ref:`/NXaberration/alias-field </NXaberration/alias-field>`
* :ref:`/NXaberration/angle-field </NXaberration/angle-field>`
* :ref:`/NXaberration/delta_time-field </NXaberration/delta_time-field>`
* :ref:`/NXaberration/magnitude-field </NXaberration/magnitude-field>`
* :ref:`/NXaberration/magnitude_errors-field </NXaberration/magnitude_errors-field>`
* :ref:`/NXaberration/magnitude_errors_model-field </NXaberration/magnitude_errors_model-field>`
* :ref:`/NXaberration/name-field </NXaberration/name-field>`

**NXDL Source**:
  https://github.com/FAIRmat-NFDI/nexus_definitions/tree/fairmat/base_classes/NXaberration.nxdl.xml