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

.. index::
    ! NXelectromagnetic_lens (base class)
    ! electromagnetic_lens (base class)
    see: electromagnetic_lens (base class); NXelectromagnetic_lens

.. _NXelectromagnetic_lens:

======================
NXelectromagnetic_lens
======================

**Status**:

  base class, extends :ref:`NXcomponent`

**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 pole piece, 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: Scanning Electron Microscopy <https://doi.org/10.1007/978-3-540-38967-5>`_
      * `P. Hawkes: Magnetic Electron Lenses <https://link.springer.com/book/10.1007/978-3-642-81516-4>`_
      * `Y. Liao: Practical Electron Microscopy and Database <https://www.globalsino.com/EM/>`_

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXelectromagnetic_lens/name-field:

  .. index:: name (field)

  **name**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/name-field>`

    Name of the lens.

  .. _/NXelectromagnetic_lens/description-field:

  .. index:: description (field)

  **description**: (optional) :ref:`NX_CHAR <NX_CHAR>` :ref:`⤆ </NXcomponent/description-field>`

    .. collapse:: Ideally, use instances of ``identifierNAME`` to point to a resource ...

        Ideally, use instances of ``identifierNAME`` to point to a resource
        that provides further details.

        If such a resource does not exist or should not be used, use this free text,
        although it is not recommended.

  .. _/NXelectromagnetic_lens/power_setting-field:

  .. index:: power_setting (field)

  **power_setting**: (optional) :ref:`NX_CHAR_OR_NUMBER <NX_CHAR_OR_NUMBER>` {units=\ :ref:`NX_ANY <NX_ANY>`} 

    .. collapse:: Descriptor for the lens excitation when the exact technical details ...

        Descriptor for the lens excitation when the exact technical details
        are unknown or not directly controllable as the control software of
        the microscope does not enable or was not configured to display these
        values for users.

        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.

  .. _/NXelectromagnetic_lens/mode-field:

  .. index:: mode (field)

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

    .. collapse:: Descriptor for the operation mode of the lens when other details are not ...

        Descriptor for the operation mode of the lens when other details are not
        directly controllable as the control software of the microscope
        does not enable or is 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.

  .. _/NXelectromagnetic_lens/voltage-field:

  .. index:: voltage (field)

  **voltage**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_VOLTAGE <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.

  .. _/NXelectromagnetic_lens/current-field:

  .. index:: current (field)

  **current**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_CURRENT <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.

  .. _/NXelectromagnetic_lens/type-field:

  .. index:: type (field)

  **type**: (optional) :ref:`NX_CHAR <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``

          * ``dodecapole``


  .. _/NXelectromagnetic_lens/number_of_poles-field:

  .. index:: number_of_poles (field)

  **number_of_poles**: (optional) :ref:`NX_UINT <NX_UINT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    Qualitative description of the lens based on the number of pole pieces.


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

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


* :ref:`/NXelectromagnetic_lens/current-field </NXelectromagnetic_lens/current-field>`
* :ref:`/NXelectromagnetic_lens/description-field </NXelectromagnetic_lens/description-field>`
* :ref:`/NXelectromagnetic_lens/mode-field </NXelectromagnetic_lens/mode-field>`
* :ref:`/NXelectromagnetic_lens/name-field </NXelectromagnetic_lens/name-field>`
* :ref:`/NXelectromagnetic_lens/number_of_poles-field </NXelectromagnetic_lens/number_of_poles-field>`
* :ref:`/NXelectromagnetic_lens/power_setting-field </NXelectromagnetic_lens/power_setting-field>`
* :ref:`/NXelectromagnetic_lens/type-field </NXelectromagnetic_lens/type-field>`
* :ref:`/NXelectromagnetic_lens/voltage-field </NXelectromagnetic_lens/voltage-field>`

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