.. auto-generated by script ../../../../utils/nxdl2rst.py from the NXDL source NXcollectioncolumn.nxdl.xml

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

.. _NXcollectioncolumn:

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

**Status**:

  base class, extends :ref:`NXobject`

**Description**:

  Draft subclass of NXelectronanalyser to describe the electron collection column of a photoelectron analyser.

**Symbols**:

  The symbols used in the schema to specify e.g. dimensions of arrays

  **nl**

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

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

**Structure**:

  .. _/NXcollectioncolumn/scheme-field:

  .. index:: scheme (field)

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

    Scheme of the electron collection lens, i.e. standard, deflector, PEEM, momentum microscope, 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>`}

    Indicating 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_names-field:

  .. index:: lens_names (field)

  **lens_names[nl]**: (optional) :ref:`NX_CHAR <NX_CHAR>`

    Set of names of electron optic lenses

  .. _/NXcollectioncolumn/lens_voltages-field:

  .. index:: lens_voltages (field)

  **lens_voltages[nl]**: (optional) :ref:`NX_FLOAT <NX_FLOAT>` {units=\ :ref:`NX_VOLTAGE <NX_VOLTAGE>`}

    Array of corresponding voltages

  .. _/NXcollectioncolumn/projection-field:

  .. index:: projection (field)

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

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

  .. _/NXcollectioncolumn/magnification-field:

  .. index:: magnification (field)

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

    The magnification of the projected image in the angularly dispersive direction

  .. _/NXcollectioncolumn/field_aperture-group:

  **field_aperture**: (optional) :ref:`NXaperture`

    The size and position of the field aperture inserted in the column

  .. _/NXcollectioncolumn/contrast_aperture-group:

  **contrast_aperture**: (optional) :ref:`NXaperture`

    The size and postion of the contrast aperture inserted in the column.

  .. _/NXcollectioncolumn/DEFLECTOR-group:

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

    deflectors in the collection column section

  .. _/NXcollectioncolumn/LENS-group:

  **LENS**: (optional) :ref:`NXlens`

    Individual lenses in the collection column section


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

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


================================================================================================ ================================================================================================
documentation (reST source) anchor                                                               web page (HTML) anchor                                                                          
================================================================================================ ================================================================================================
:ref:`/NXcollectioncolumn/contrast_aperture-group </NXcollectioncolumn/contrast_aperture-group>` :ref:`#nxcollectioncolumn-contrast-aperture-group </NXcollectioncolumn/contrast_aperture-group>`
:ref:`/NXcollectioncolumn/DEFLECTOR-group </NXcollectioncolumn/DEFLECTOR-group>`                 :ref:`#nxcollectioncolumn-deflector-group </NXcollectioncolumn/DEFLECTOR-group>`                
:ref:`/NXcollectioncolumn/extractor_current-field </NXcollectioncolumn/extractor_current-field>` :ref:`#nxcollectioncolumn-extractor-current-field </NXcollectioncolumn/extractor_current-field>`
:ref:`/NXcollectioncolumn/extractor_voltage-field </NXcollectioncolumn/extractor_voltage-field>` :ref:`#nxcollectioncolumn-extractor-voltage-field </NXcollectioncolumn/extractor_voltage-field>`
:ref:`/NXcollectioncolumn/field_aperture-group </NXcollectioncolumn/field_aperture-group>`       :ref:`#nxcollectioncolumn-field-aperture-group </NXcollectioncolumn/field_aperture-group>`      
:ref:`/NXcollectioncolumn/LENS-group </NXcollectioncolumn/LENS-group>`                           :ref:`#nxcollectioncolumn-lens-group </NXcollectioncolumn/LENS-group>`                          
:ref:`/NXcollectioncolumn/lens_names-field </NXcollectioncolumn/lens_names-field>`               :ref:`#nxcollectioncolumn-lens-names-field </NXcollectioncolumn/lens_names-field>`              
:ref:`/NXcollectioncolumn/lens_voltages-field </NXcollectioncolumn/lens_voltages-field>`         :ref:`#nxcollectioncolumn-lens-voltages-field </NXcollectioncolumn/lens_voltages-field>`        
:ref:`/NXcollectioncolumn/magnification-field </NXcollectioncolumn/magnification-field>`         :ref:`#nxcollectioncolumn-magnification-field </NXcollectioncolumn/magnification-field>`        
:ref:`/NXcollectioncolumn/projection-field </NXcollectioncolumn/projection-field>`               :ref:`#nxcollectioncolumn-projection-field </NXcollectioncolumn/projection-field>`              
:ref:`/NXcollectioncolumn/scheme-field </NXcollectioncolumn/scheme-field>`                       :ref:`#nxcollectioncolumn-scheme-field </NXcollectioncolumn/scheme-field>`                      
:ref:`/NXcollectioncolumn/working_distance-field </NXcollectioncolumn/working_distance-field>`   :ref:`#nxcollectioncolumn-working-distance-field </NXcollectioncolumn/working_distance-field>`  
================================================================================================ ================================================================================================


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