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

.. index::
    ! NXpolarizer (base class)
    ! polarizer (base class)
    see: polarizer (base class); NXpolarizer

.. _NXpolarizer:

===========
NXpolarizer
===========

**Status**:

  base class, extends :ref:`NXcomponent`

**Description**:

  A spin polarizer.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. _/NXpolarizer/type-field:

  .. index:: type (field)

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

    one of these values: "crystal", "supermirror", "3He"

  .. _/NXpolarizer/composition-field:

  .. index:: composition (field)

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

    description of the composition of the polarizing material

  .. _/NXpolarizer/reflection-field:

  .. index:: reflection (field)

  **reflection**: (optional) :ref:`NX_INT <NX_INT>` (Rank: 1, Dimensions: [3]) {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`} 

    [hkl] values of nominal reflection

  .. _/NXpolarizer/efficiency-field:

  .. index:: efficiency (field)

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

    polarizing efficiency

  .. _/NXpolarizer/depends_on-field:

  .. index:: depends_on (field)

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

    .. collapse::   Add a definition for the reference point of a polarizer. ...

        .. todo::
          Add a definition for the reference point of a polarizer.


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

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


* :ref:`/NXpolarizer/composition-field </NXpolarizer/composition-field>`
* :ref:`/NXpolarizer/depends_on-field </NXpolarizer/depends_on-field>`
* :ref:`/NXpolarizer/efficiency-field </NXpolarizer/efficiency-field>`
* :ref:`/NXpolarizer/reflection-field </NXpolarizer/reflection-field>`
* :ref:`/NXpolarizer/type-field </NXpolarizer/type-field>`

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