Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NXbeam: clarify how beams can be in either sample or instrument groups #1283

Merged
merged 2 commits into from
Jun 21, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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