.. 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` **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:`NXenvironment`, :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:`NXtransformations`, :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, NXtransformations (base class); used in base class, NXvelocity_selector (base class); used in base class, NXxraylens (base class); used in base class, NXenvironment (base class); used in base class **Structure**: .. _/NXinstrument@default-attribute: .. index:: default (file attribute) **@default**: (optional) :ref:`NX_CHAR ` .. index:: plotting Declares which child group contains a path leading to a :ref:`NXdata` group. It is recommended (as of NIAC2014) to use this attribute to help define the path to the default dataset to be plotted. See https://www.nexusformat.org/2014_How_to_find_default_data.html for a summary of the discussion. .. _/NXinstrument/name-field: .. index:: name (field) **name**: (optional) :ref:`NX_CHAR ` Name of instrument .. _/NXinstrument/name@short_name-attribute: .. index:: short_name (field attribute) **@short_name**: (optional) :ref:`NX_CHAR ` short name for instrument, perhaps the acronym .. _/NXinstrument/APERTURE-group: **APERTURE**: (optional) :ref:`NXaperture` .. _/NXinstrument/ATTENUATOR-group: **ATTENUATOR**: (optional) :ref:`NXattenuator` .. _/NXinstrument/BEAM-group: **BEAM**: (optional) :ref:`NXbeam` .. _/NXinstrument/BEAM_STOP-group: **BEAM_STOP**: (optional) :ref:`NXbeam_stop` .. _/NXinstrument/BENDING_MAGNET-group: **BENDING_MAGNET**: (optional) :ref:`NXbending_magnet` .. _/NXinstrument/COLLIMATOR-group: **COLLIMATOR**: (optional) :ref:`NXcollimator` .. _/NXinstrument/COLLECTION-group: **COLLECTION**: (optional) :ref:`NXcollection` .. _/NXinstrument/CAPILLARY-group: **CAPILLARY**: (optional) :ref:`NXcapillary` .. _/NXinstrument/CRYSTAL-group: **CRYSTAL**: (optional) :ref:`NXcrystal` .. _/NXinstrument/DETECTOR-group: **DETECTOR**: (optional) :ref:`NXdetector` .. _/NXinstrument/DETECTOR_GROUP-group: **DETECTOR_GROUP**: (optional) :ref:`NXdetector_group` .. _/NXinstrument/DISK_CHOPPER-group: **DISK_CHOPPER**: (optional) :ref:`NXdisk_chopper` .. _/NXinstrument/EVENT_DATA-group: **EVENT_DATA**: (optional) :ref:`NXevent_data` .. _/NXinstrument/FERMI_CHOPPER-group: **FERMI_CHOPPER**: (optional) :ref:`NXfermi_chopper` .. _/NXinstrument/FILTER-group: **FILTER**: (optional) :ref:`NXfilter` .. _/NXinstrument/FLIPPER-group: **FLIPPER**: (optional) :ref:`NXflipper` .. _/NXinstrument/GUIDE-group: **GUIDE**: (optional) :ref:`NXguide` .. _/NXinstrument/INSERTION_DEVICE-group: **INSERTION_DEVICE**: (optional) :ref:`NXinsertion_device` .. _/NXinstrument/MIRROR-group: **MIRROR**: (optional) :ref:`NXmirror` .. _/NXinstrument/MODERATOR-group: **MODERATOR**: (optional) :ref:`NXmoderator` .. _/NXinstrument/MONOCHROMATOR-group: **MONOCHROMATOR**: (optional) :ref:`NXmonochromator` .. _/NXinstrument/POLARIZER-group: **POLARIZER**: (optional) :ref:`NXpolarizer` .. _/NXinstrument/POSITIONER-group: **POSITIONER**: (optional) :ref:`NXpositioner` .. _/NXinstrument/SOURCE-group: **SOURCE**: (optional) :ref:`NXsource` .. _/NXinstrument/DIFFRACTOMETER-group: **DIFFRACTOMETER**: (optional) :ref:`NXtransformations` .. _/NXinstrument/VELOCITY_SELECTOR-group: **VELOCITY_SELECTOR**: (optional) :ref:`NXvelocity_selector` .. _/NXinstrument/XRAYLENS-group: **XRAYLENS**: (optional) :ref:`NXxraylens` .. _/NXinstrument/ENVIRONMENT-group: **ENVIRONMENT**: (optional) :ref:`NXenvironment` Hypertext Anchors ----------------- List of hypertext anchors for all groups, fields, attributes, and links defined in this class. * :ref:`/NXinstrument/APERTURE-group ` * :ref:`/NXinstrument/ATTENUATOR-group ` * :ref:`/NXinstrument/BEAM-group ` * :ref:`/NXinstrument/BEAM_STOP-group ` * :ref:`/NXinstrument/BENDING_MAGNET-group ` * :ref:`/NXinstrument/CAPILLARY-group ` * :ref:`/NXinstrument/COLLECTION-group ` * :ref:`/NXinstrument/COLLIMATOR-group ` * :ref:`/NXinstrument/CRYSTAL-group ` * :ref:`/NXinstrument/DETECTOR-group ` * :ref:`/NXinstrument/DETECTOR_GROUP-group ` * :ref:`/NXinstrument/DIFFRACTOMETER-group ` * :ref:`/NXinstrument/DISK_CHOPPER-group ` * :ref:`/NXinstrument/ENVIRONMENT-group ` * :ref:`/NXinstrument/EVENT_DATA-group ` * :ref:`/NXinstrument/FERMI_CHOPPER-group ` * :ref:`/NXinstrument/FILTER-group ` * :ref:`/NXinstrument/FLIPPER-group ` * :ref:`/NXinstrument/GUIDE-group ` * :ref:`/NXinstrument/INSERTION_DEVICE-group ` * :ref:`/NXinstrument/MIRROR-group ` * :ref:`/NXinstrument/MODERATOR-group ` * :ref:`/NXinstrument/MONOCHROMATOR-group ` * :ref:`/NXinstrument/name-field ` * :ref:`/NXinstrument/name@short_name-attribute ` * :ref:`/NXinstrument/POLARIZER-group ` * :ref:`/NXinstrument/POSITIONER-group ` * :ref:`/NXinstrument/SOURCE-group ` * :ref:`/NXinstrument/VELOCITY_SELECTOR-group ` * :ref:`/NXinstrument/XRAYLENS-group ` * :ref:`/NXinstrument@default-attribute ` **NXDL Source**: https://github.com/nexusformat/definitions/blob/main/base_classes/NXinstrument.nxdl.xml