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

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

.. _NXpolarizer:

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

**Status**:

  base class, extends :ref:`NXobject`, version 1.0

**Description**:

  Template of a beamline spin polarizer.
  This is a draft and is subject to revision.

**Symbols**:

  No symbol table

**Groups cited**:
  none

**Structure**:

  .. index:: type (data field)

  **type**: :ref:`NX_CHAR <NX_CHAR>`

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

  .. index:: composition (data field)

  **composition**: :ref:`NX_CHAR <NX_CHAR>`

    description of the composition of the polarizing material

  .. index:: reflection (data field)

  **reflection[3]**: :ref:`NX_INT <NX_INT>` {units=\ :ref:`NX_UNITLESS <NX_UNITLESS>`}

    [hkl] values of nominal reflection

  .. index:: efficiency (data field)

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

    polarizing efficiency

**Source**:
  Automatically generated from https://github.com/nexusformat/definitions/blob/master/base_classes/NXpolarizer.nxdl.xml