NXinstrument

Status:

base class, extends 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:

NXaperture, NXattenuator, NXbeam_stop, NXbeam, NXbending_magnet, NXcapillary, NXcollection, NXcollimator, NXcrystal, NXdetector_group, NXdetector, NXdisk_chopper, NXevent_data, NXfermi_chopper, NXfilter, NXflipper, NXguide, NXinsertion_device, NXmirror, NXmoderator, NXmonochromator, NXpolarizer, NXpositioner, NXsource, NXtransformations, NXvelocity_selector, NXxraylens

Structure:

@default: (optional) NX_CHAR

Declares which child group contains a path leading to a 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.

name: (optional) NX_CHAR

Name of instrument

@short_name: (optional) NX_CHAR

short name for instrument, perhaps the acronym

energy_resolution: (optional) NX_FLOAT {units=NX_ENERGY}

Energy resolution of the experiment (FWHM or gaussian broadening)

momentum_resolution: (optional) NX_FLOAT {units=NX_WAVENUMBER}

Momentum resolution of the experiment (FWHM)

angular_resolution: (optional) NX_FLOAT {units=NX_ANGLE}

Angular resolution of the experiment (FWHM)

spatial_resolution: (optional) NX_FLOAT {units=NX_LENGTH}

Spatial resolution of the experiment (Airy disk radius)

temporal_resolution: (optional) NX_FLOAT {units=NX_TIME}

Temporal resolution of the experiment (FWHM)

APERTURE: (optional) NXaperture

ATTENUATOR: (optional) NXattenuator

BEAM: (optional) NXbeam

BEAM_STOP: (optional) NXbeam_stop

BENDING_MAGNET: (optional) NXbending_magnet

COLLIMATOR: (optional) NXcollimator

COLLECTION: (optional) NXcollection

CAPILLARY: (optional) NXcapillary

CRYSTAL: (optional) NXcrystal

DETECTOR: (optional) NXdetector

DETECTOR_GROUP: (optional) NXdetector_group

DISK_CHOPPER: (optional) NXdisk_chopper

EVENT_DATA: (optional) NXevent_data

FERMI_CHOPPER: (optional) NXfermi_chopper

FILTER: (optional) NXfilter

FLIPPER: (optional) NXflipper

GUIDE: (optional) NXguide

INSERTION_DEVICE: (optional) NXinsertion_device

MIRROR: (optional) NXmirror

MODERATOR: (optional) NXmoderator

MONOCHROMATOR: (optional) NXmonochromator

POLARIZER: (optional) NXpolarizer

POSITIONER: (optional) NXpositioner

SOURCE: (optional) NXsource

DIFFRACTOMETER: (optional) NXtransformations

VELOCITY_SELECTOR: (optional) NXvelocity_selector

XRAYLENS: (optional) NXxraylens

Hypertext Anchors

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

NXDL Source:

https://github.com/FAIRmat-Experimental/nexus_definitions/tree/fairmat/contributed_definitions/NXinstrument.nxdl.xml