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

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

.. _NXdeflector:

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

..
    Contributors List

    .. |contrib_name| replace:: Rubel|RubelMozumder|https://avatars.githubusercontent.com/u/32923026?v=4|2023-06-14

    .. |contrib_name| replace:: Domna|domna|https://avatars.githubusercontent.com/u/1014422?v=4|2022-06-21

    .. |contrib_name| replace:: Kuehbachm|mkuehbach|https://avatars.githubusercontent.com/u/14091504?v=4|2022-03-31

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Deflectors as they are used e.g. in an electron analyser.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXtransformations`

.. index:: NXtransformations (base class); used in base class

**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>` 

    .. 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 respective manufacturer fields.

  .. _/NXdeflector/manufacturer_name-field:

  .. index:: manufacturer_name (field)

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

    Name of the manufacturer who built/constructed the deflector.

  .. _/NXdeflector/manufacturer_model-field:

  .. index:: manufacturer_model (field)

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

    .. collapse:: Hardware name, hash identifier, or serial number that was given by the ...

        Hardware name, hash identifier, or serial number that was given by the
        manufacturer to identify the deflector.

  .. _/NXdeflector/description-field:

  .. index:: description (field)

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

    .. collapse:: Ideally an identifier, persistent link, or free text which gives further detai ...

        Ideally an identifier, persistent link, or free text which gives further details
        about the deflector.

  .. _/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. For ...

        Excitation voltage of the deflector. For dipoles it is a single number. For
        higher orders, 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/depends_on-field:

  .. index:: depends_on (field)

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

    .. collapse:: Specifies the position of the deflector by pointing to the last transformation ...

        Specifies the position of the deflector by pointing to the last transformation
        in the transformation chain in the NXtransformations group.

  .. _/NXdeflector/TRANSFORMATIONS-group:

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

    .. collapse:: Collection of axis-based translations and rotations to describe the location a ...

        Collection of axis-based translations and rotations to describe the location and
        geometry of the deflector as a component in the instrument. Conventions from the
        NXtransformations base class are used. In principle, the McStas coordinate
        system is used. The first transformation has to point either to another
        component of the system or . (for pointing to the reference frame) to relate it
        relative to the experimental setup. Typically, the components of a system should
        all be related relative to each other and only one component should relate to
        the reference coordinate system.


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/depends_on-field </NXdeflector/depends_on-field>`
* :ref:`/NXdeflector/description-field </NXdeflector/description-field>`
* :ref:`/NXdeflector/manufacturer_model-field </NXdeflector/manufacturer_model-field>`
* :ref:`/NXdeflector/manufacturer_name-field </NXdeflector/manufacturer_name-field>`
* :ref:`/NXdeflector/name-field </NXdeflector/name-field>`
* :ref:`/NXdeflector/TRANSFORMATIONS-group </NXdeflector/TRANSFORMATIONS-group>`
* :ref:`/NXdeflector/type-field </NXdeflector/type-field>`
* :ref:`/NXdeflector/voltage-field </NXdeflector/voltage-field>`

**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/main/contributed_definitions/NXdeflector.nxdl.xml