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

.. index::
    ! NXinstrument (base class)
    ! instrument (base class)
    see: instrument (base class); NXinstrument

.. _NXinstrument:

============
NXinstrument
============

**Status**:

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

**Description**:

  Collection of the components of the instrument or beamline.

  Template of instrument descriptions comprising various beamline components. 
  Each component will also be a NeXus group defined by its distance from the 
  sample. Negative distances represent beamline components that are before the 
  sample while positive distances represent components that are after the sample. 
  This device allows the unique identification of beamline components in a way 
  that is valid for both reactor and pulsed instrumentation.

**Symbols**:

  No symbol table

**Groups cited**:
  :ref:`NXaperture`, :ref:`NXattenuator`, :ref:`NXbeam_stop`, :ref:`NXbeam`, :ref:`NXbending_magnet`, :ref:`NXcapillary`, :ref:`NXcollection`, :ref:`NXcollimator`, :ref:`NXcrystal`, :ref:`NXdetector_group`, :ref:`NXdetector`, :ref:`NXdisk_chopper`, :ref:`NXevent_data`, :ref:`NXfermi_chopper`, :ref:`NXfilter`, :ref:`NXflipper`, :ref:`NXguide`, :ref:`NXinsertion_device`, :ref:`NXmirror`, :ref:`NXmoderator`, :ref:`NXmonochromator`, :ref:`NXpolarizer`, :ref:`NXpositioner`, :ref:`NXsource`, :ref:`NXvelocity_selector`, :ref:`NXxraylens`

.. index:: NXaperture (base class); used in base class, NXattenuator (base class); used in base class, NXbeam (base class); used in base class, NXbeam_stop (base class); used in base class, NXbending_magnet (base class); used in base class, NXcollimator (base class); used in base class, NXcollection (base class); used in base class, NXcapillary (base class); used in base class, NXcrystal (base class); used in base class, NXdetector (base class); used in base class, NXdetector_group (base class); used in base class, NXdisk_chopper (base class); used in base class, NXevent_data (base class); used in base class, NXfermi_chopper (base class); used in base class, NXfilter (base class); used in base class, NXflipper (base class); used in base class, NXguide (base class); used in base class, NXinsertion_device (base class); used in base class, NXmirror (base class); used in base class, NXmoderator (base class); used in base class, NXmonochromator (base class); used in base class, NXpolarizer (base class); used in base class, NXpositioner (base class); used in base class, NXsource (base class); used in base class, NXvelocity_selector (base class); used in base class, NXxraylens (base class); used in base class

**Structure**:

  .. index:: name (field)

  **name**: :ref:`NX_CHAR <NX_CHAR>`

    Name of instrument

    .. index:: short name (field attribute)

    **@short_name**: :ref:`NX_CHAR <NX_CHAR>`

      short name for instrument, perhaps the acronym

  **(aperture)**: :ref:`NXaperture`


  **(attenuator)**: :ref:`NXattenuator`


  **(beam)**: :ref:`NXbeam`


  **(beam_stop)**: :ref:`NXbeam_stop`


  **(bending_magnet)**: :ref:`NXbending_magnet`


  **(collimator)**: :ref:`NXcollimator`


  **(collection)**: :ref:`NXcollection`


  **(capillary)**: :ref:`NXcapillary`


  **(crystal)**: :ref:`NXcrystal`


  **(detector)**: :ref:`NXdetector`


  **(detector_group)**: :ref:`NXdetector_group`


  **(disk_chopper)**: :ref:`NXdisk_chopper`


  **(event_data)**: :ref:`NXevent_data`


  **(fermi_chopper)**: :ref:`NXfermi_chopper`


  **(filter)**: :ref:`NXfilter`


  **(flipper)**: :ref:`NXflipper`


  **(guide)**: :ref:`NXguide`


  **(insertion_device)**: :ref:`NXinsertion_device`


  **(mirror)**: :ref:`NXmirror`


  **(moderator)**: :ref:`NXmoderator`


  **(monochromator)**: :ref:`NXmonochromator`


  **(polarizer)**: :ref:`NXpolarizer`


  **(positioner)**: :ref:`NXpositioner`


  **(source)**: :ref:`NXsource`


  **(velocity_selector)**: :ref:`NXvelocity_selector`


  **(xraylens)**: :ref:`NXxraylens`


**NXDL Source**:
  https://github.com/nexusformat/definitions/blob/master/base_classes/NXinstrument.nxdl.xml