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

.. index::
    ! NXcollectioncolumn (base class)
    ! collectioncolumn (base class)
    see: collectioncolumn (base class); NXcollectioncolumn

.. _NXcollectioncolumn:

==================
NXcollectioncolumn
==================

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  Electron collection column of an electron analyzer.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXaperture`, :ref:`NXdeflector`, :ref:`NXelectromagnetic_lens`

.. index:: NXaperture (base class); used in base class, NXdeflector (base class); used in base class, NXelectromagnetic_lens (base class); used in base class

**Structure**:

  .. _/NXcollectioncolumn/scheme-field:

  .. index:: scheme (field)

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

    .. collapse:: Scheme of the electron collection lens, i.e. angular dispersive, ...

        Scheme of the electron collection lens, i.e. angular dispersive,
        spatial dispersive, momentum dispersive, non-dispersive, etc.

  .. _/NXcollectioncolumn/extractor_voltage-field:

  .. index:: extractor_voltage (field)

  **extractor_voltage**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`} 

    Voltage applied to the extractor lens

  .. _/NXcollectioncolumn/extractor_current-field:

  .. index:: extractor_current (field)

  **extractor_current**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_CURRENT <NX_CURRENT>`} 

    .. collapse:: Current necessary to keep the extractor lens at a set voltage. Variations ...

        Current necessary to keep the extractor lens at a set voltage. Variations
        indicate leakage, field emission or arc currents to the extractor lens.

  .. _/NXcollectioncolumn/working_distance-field:

  .. index:: working_distance (field)

  **working_distance**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    Distance between sample and detector entrance

  .. _/NXcollectioncolumn/lens_mode-field:

  .. index:: lens_mode (field)

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

    Labelling of the lens setting in use.

  .. _/NXcollectioncolumn/projection-field:

  .. index:: projection (field)

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

    .. collapse:: The space projected in the angularly dispersive directions, real or reciprocal ...

        The space projected in the angularly dispersive directions, real or reciprocal

        Any of these values: ``real`` | ``reciprocal``

  .. _/NXcollectioncolumn/angular_acceptance-field:

  .. index:: angular_acceptance (field)

  **angular_acceptance**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_ANGLE <NX_ANGLE>`} 

    .. collapse:: Acceptance angle of the collection column. ...

        Acceptance angle of the collection column.

        This concept is related to term `7.4`_ of the ISO 18115-1:2023 standard.

        .. _7.4: https://www.iso.org/obp/ui/en/#iso:std:iso:18115:-1:ed-3:v1:en:term:7.4

  .. _/NXcollectioncolumn/spatial_acceptance-field:

  .. index:: spatial_acceptance (field)

  **spatial_acceptance**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_LENGTH <NX_LENGTH>`} 

    Acceptance length or area of the collection column.

  .. _/NXcollectioncolumn/magnification-field:

  .. index:: magnification (field)

  **magnification**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_DIMENSIONLESS <NX_DIMENSIONLESS>`} 

    The magnification of the electron lens assembly.

  .. _/NXcollectioncolumn/APERTURE-group:

  :bolditalic:`APERTURE`: (optional) :ref:`NXaperture` 

    .. collapse:: The size and position of an aperture inserted in the column, e.g. field apertu ...

        The size and position of an aperture inserted in the column, e.g. field aperture
        or contrast aperture

  .. _/NXcollectioncolumn/DEFLECTOR-group:

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

    Deflectors in the collection column section

  .. _/NXcollectioncolumn/ELECTROMAGNETIC_LENS-group:

  :bolditalic:`ELECTROMAGNETIC_LENS`: (optional) :ref:`NXelectromagnetic_lens` 

    Individual lenses in the collection column section


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

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


* :ref:`/NXcollectioncolumn/angular_acceptance-field </NXcollectioncolumn/angular_acceptance-field>`
* :ref:`/NXcollectioncolumn/APERTURE-group </NXcollectioncolumn/APERTURE-group>`
* :ref:`/NXcollectioncolumn/DEFLECTOR-group </NXcollectioncolumn/DEFLECTOR-group>`
* :ref:`/NXcollectioncolumn/ELECTROMAGNETIC_LENS-group </NXcollectioncolumn/ELECTROMAGNETIC_LENS-group>`
* :ref:`/NXcollectioncolumn/extractor_current-field </NXcollectioncolumn/extractor_current-field>`
* :ref:`/NXcollectioncolumn/extractor_voltage-field </NXcollectioncolumn/extractor_voltage-field>`
* :ref:`/NXcollectioncolumn/lens_mode-field </NXcollectioncolumn/lens_mode-field>`
* :ref:`/NXcollectioncolumn/magnification-field </NXcollectioncolumn/magnification-field>`
* :ref:`/NXcollectioncolumn/projection-field </NXcollectioncolumn/projection-field>`
* :ref:`/NXcollectioncolumn/scheme-field </NXcollectioncolumn/scheme-field>`
* :ref:`/NXcollectioncolumn/spatial_acceptance-field </NXcollectioncolumn/spatial_acceptance-field>`
* :ref:`/NXcollectioncolumn/working_distance-field </NXcollectioncolumn/working_distance-field>`

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