Skip to content

Commit

Permalink
NXbeam: clarify how beams can be in either sample or instrument groups (
Browse files Browse the repository at this point in the history
#1283)

Add documentation about cases where NXbeam is defined as a subgroup directly inside a NXinstruments group.
  • Loading branch information
Gigarrum committed Jun 21, 2023
1 parent 00ac614 commit 83221cc
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion base_classes/NXbeam.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@
especially valuable in storing the results of instrument simulations in which it is useful
to specify the beam profile, time distribution etc. at each beamline component. Otherwise,
its most likely use is in the :ref:`NXsample` group in which it defines the results of the neutron
scattering by the sample, e.g., energy transfer, polarizations.
scattering by the sample, e.g., energy transfer, polarizations. Finally, There are cases where the beam is
considered as a beamline component and this group may be defined as a subgroup directly inside
:ref:`NXinstrument`, in which case it is recommended that the position of the beam is specified by an
:ref:`NXtransformations` group, unless the beam is at the origin (which is the sample).

Note that incident_wavelength and related fields can be a scalar values or arrays, depending on the use case.
To support these use cases, the explicit dimensionality of these fields is not specified, but it can be inferred
Expand Down

0 comments on commit 83221cc

Please sign in to comment.