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

.. index::
    ! NXdeflector (base class)
    ! deflector (base class)
    see: deflector (base class); NXdeflector

.. _NXdeflector:

===========
NXdeflector
===========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  Component of an electron analyzer that deflects the paths of electrons. This includes electrostatic and electromagnetic deflectors.


**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXdeflector/type-field:

  .. index:: type (field)

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

    .. collapse:: Qualitative type of deflector with respect to the number of pole pieces. ...

        Qualitative type of deflector with respect to the number of pole pieces.

        Any of these values: ``dipole`` | ``quadrupole`` | ``hexapole`` | ``octupole``

  .. _/NXdeflector/name-field:

  .. index:: name (field)

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

    .. collapse:: Colloquial or short name for the deflector. For manufacturer names and ...

        Colloquial or short name for the deflector. For manufacturer names and
        identifiers use ``NXfabrication`` and ``identifierNAME``.

  .. _/NXdeflector/voltage-field:

  .. index:: voltage (field)

  **voltage**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`} 

    .. collapse:: Excitation voltage of the deflector. For dipoles it is a single number. ...

        Excitation voltage of the deflector. For dipoles it is a single number.
        For higher order multipoles, it is an array.

  .. _/NXdeflector/current-field:

  .. index:: current (field)

  **current**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`} 

    .. collapse:: Excitation current of the deflector. For dipoles it is a single number. For ...

        Excitation current of the deflector. For dipoles it is a single number. For
        higher orders, it is an array.

  .. _/NXdeflector/offset_x-field:

  .. index:: offset_x (field)

  **offset_x**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: Spatial offset of the deflector in x direction (perpendicular to ...

        Spatial offset of the deflector in x direction (perpendicular to
        ```offset_y```).

  .. _/NXdeflector/offset_y-field:

  .. index:: offset_y (field)

  **offset_y**: (optional) :ref:`NX_NUMBER <NX_NUMBER>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    .. collapse:: Spatial offset of the deflector in y direction (perpendicular to ...

        Spatial offset of the deflector in y direction (perpendicular to
        ```offset_x```).


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

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


* :ref:`/NXdeflector/current-field </NXdeflector/current-field>`
* :ref:`/NXdeflector/name-field </NXdeflector/name-field>`
* :ref:`/NXdeflector/offset_x-field </NXdeflector/offset_x-field>`
* :ref:`/NXdeflector/offset_y-field </NXdeflector/offset_y-field>`
* :ref:`/NXdeflector/type-field </NXdeflector/type-field>`
* :ref:`/NXdeflector/voltage-field </NXdeflector/voltage-field>`

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