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

.. index::
    ! NXscanbox_em (base class)
    ! scanbox_em (base class)
    see: scanbox_em (base class); NXscanbox_em

.. _NXscanbox_em:

============
NXscanbox_em
============

**Status**:

  base class, extends :ref:`NXcomponent_em`

**Description**:

  .. collapse:: Scan box and coils which deflect a beam of charged particles in a controlled man ...

      Scan box and coils which deflect a beam of charged particles in a controlled manner.

      The scan box is instructed by an instance of :ref:`NXprogram`, some control software,
      which is not necessarily the same program as for all components of a microscope.

      The scanbox directs the probe of charged particles (electrons, ions)
      to controlled locations according to a scan scheme and plan.

      To achieve this task, the scanbox typically contains deflection coils,
      which should be modelled as instances of :ref:`NXdeflector`.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXdeflector`

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

**Structure**:

  .. _/NXscanbox_em/scan_schema-field:

  .. index:: scan_schema (field)

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

    .. collapse:: Name of the typically tech-partner-specific term that specifies ...

        Name of the typically tech-partner-specific term that specifies
        an automated protocol which controls the details how the components
        of the microscope work together to achieve a controlled scanning of the
        beam over the sample surface.

        In most cases users do not know, have to care, or are able to disentangle the
        details of the spatiotemporal dynamics of the components of the microscope.
        Instead, they rely on the assumption that the microscope and control software
        work as expected. Selecting then a specific scan_schema assures some level
        of reproducibility in the way how the beam is scanned over the surface.

  .. _/NXscanbox_em/calibration_style-field:

  .. index:: calibration_style (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/center-field:

  .. index:: center (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/flyback_time-field:

  .. index:: flyback_time (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/line_time-field:

  .. index:: line_time (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/dwell_time-field:

  .. index:: dwell_time (field)

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

    Time period during which the beam remains at one position.

  .. _/NXscanbox_em/pixel_time-field:

  .. index:: pixel_time (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/requested_pixel_time-field:

  .. index:: requested_pixel_time (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/rotation-field:

  .. index:: rotation (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/ac_line_sync-field:

  .. index:: ac_line_sync (field)

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

    TODO discuss with the electron microscopists.

  .. _/NXscanbox_em/DEFLECTOR-group:

  **DEFLECTOR**: (optional) :ref:`NXdeflector` 



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

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


* :ref:`/NXscanbox_em/ac_line_sync-field </NXscanbox_em/ac_line_sync-field>`
* :ref:`/NXscanbox_em/calibration_style-field </NXscanbox_em/calibration_style-field>`
* :ref:`/NXscanbox_em/center-field </NXscanbox_em/center-field>`
* :ref:`/NXscanbox_em/DEFLECTOR-group </NXscanbox_em/DEFLECTOR-group>`
* :ref:`/NXscanbox_em/dwell_time-field </NXscanbox_em/dwell_time-field>`
* :ref:`/NXscanbox_em/flyback_time-field </NXscanbox_em/flyback_time-field>`
* :ref:`/NXscanbox_em/line_time-field </NXscanbox_em/line_time-field>`
* :ref:`/NXscanbox_em/pixel_time-field </NXscanbox_em/pixel_time-field>`
* :ref:`/NXscanbox_em/requested_pixel_time-field </NXscanbox_em/requested_pixel_time-field>`
* :ref:`/NXscanbox_em/rotation-field </NXscanbox_em/rotation-field>`
* :ref:`/NXscanbox_em/scan_schema-field </NXscanbox_em/scan_schema-field>`

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