diff --git a/base_classes/NXbeam.nxdl.xml b/base_classes/NXbeam.nxdl.xml index 68d589274e..fde50c66be 100644 --- a/base_classes/NXbeam.nxdl.xml +++ b/base_classes/NXbeam.nxdl.xml @@ -63,11 +63,11 @@ Energy carried by each particle of the beam on entering the beamline location. - + In the case of a monochromatic beam this is the scalar energy. Several other use cases are permitted, depending on the presence of other ``incident_energy_X`` fields. - + * In the case of a polychromatic beam this is an array of length m of energies, with the relative weights in ``incident_energy_weights``. * In the case of a monochromatic beam that varies shot-to-shot, this is an array of energies, one for each recorded shot. Here, ``incident_energy_weights`` and ``incident_energy_spread`` are not set. @@ -75,7 +75,7 @@ this is an array of length m with the relative weights in ``incident_energy_weights`` as a 2D array. * In the case of a polychromatic beam that varies shot-to-shot and where the channels also vary, this is a 2D array of dimensions nP by m (slow to fast) with the relative weights in ``incident_energy_weights`` as a 2D array. - + Note, variants are a good way to represent several of these use cases in a single dataset, e.g. if a calibrated, single-value energy value is available along with the original spectrum from which it was calibrated. @@ -195,9 +195,9 @@ Size of the beam entering this component. Note this represents a rectangular beam aperture, and values represent FWHM. - If applicable, the first dimension shall represent the extent - in the direction parallel to the azimuthal reference plane - (by default it is [1,0,0]), and the second dimension shall be + If applicable, the first dimension shall represent the extent + in the direction parallel to the azimuthal reference plane + (by default it is [1,0,0]), and the second dimension shall be the normal to the reference plane (by default it it [0,1,0]). @@ -357,97 +357,6 @@ Group delay dispersion of the pulse for linear chirp - - - Distribution of beam with respect to relevant variable e.g. wavelength. This is mainly - useful for simulations which need to store plottable information at each beamline - component. - - - - - .. 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. - - - - - The NeXus coordinate system defines the Z axis to be along the nominal beam - direction. This is the same as the McStas coordinate system (see :ref:`Design-CoordinateSystem`). - However, the additional transformations needed to represent an altered beam - direction can be provided using this depends_on field that contains the path - to a NXtransformations group. This could represent redirection of the beam, - or a refined beam direction. - - - - - Direction (and location) for the beam. The location of the beam can be given by - any point which it passes through as its offset attribute. - - - - Direction of beam vector, its value is ignored. If missing, then the beam direction is defined as [0,0,1] - and passes through the origin - - - - - - - - - Three values that define the direction of beam vector - - - - - Three values that define the location of a point through which the beam passes - - - - - Points to the path to a field defining the location on which this - depends or the string "." for origin. - - - - - - Direction of normal to reference plane used to measure azimuth relative to the beam, its value is ignored. - This also defines the parallel and perpendicular components of the beam's polarization. - If missing, then the reference plane normal is defined as [0,1,0] and passes through the origin - - - - - - - - - Three values that define the direction of reference plane normal - - - - - Not required as beam direction offset locates the plane - - - - - Points to the path to a field defining the location on which this - depends or the string "." for origin. - - - - Indicates the beam device from which this beam originates. @@ -522,7 +431,7 @@ - + Direction of normal to reference plane used to measure azimuth relative to the beam, its value is ignored. This also defines the parallel and perpendicular components of the beam's polarization. @@ -551,4 +460,4 @@ - + \ No newline at end of file