Skip to content

Commit

Permalink
fix rebase issues
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukaspie
lukaspie committed Oct 16, 2024
1 parent d49e89c commit c75d5c2
Showing 1 changed file with 8 additions and 99 deletions.
107 changes: 8 additions & 99 deletions base_classes/NXbeam.nxdl.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,19 +63,19 @@
<field name="incident_energy" type="NX_FLOAT" units="NX_ENERGY">
<doc>
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.
* In the case of a polychromatic beam that varies shot-to-shot,
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.
</doc>
Expand Down Expand Up @@ -195,9 +195,9 @@
<doc>
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]).
</doc>
<dimensions rank="2">
Expand Down Expand Up @@ -357,97 +357,6 @@
Group delay dispersion of the pulse for linear chirp
</doc>
</field>
<group type="NXdata">
<doc>
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.
</doc>
</group>
<attribute name="default">
<doc>
.. 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.
</doc>
</attribute>
<field name="depends_on" type="NX_CHAR" minOccurs="0">
<doc>
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.
</doc>
</field>
<group type="NXtransformations" minOccurs="0">
<doc>
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.
</doc>
<field name="DIRECTION" type="NX_NUMBER" nameType="any" units="NX_TRANSFORMATION">
<doc>
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
</doc>
<attribute name="transformation_type">
<enumeration>
<item value="translation"/>
</enumeration>
</attribute>
<attribute name="vector" type="NX_NUMBER">
<doc>
Three values that define the direction of beam vector
</doc>
</attribute>
<attribute name="offset" type="NX_NUMBER">
<doc>
Three values that define the location of a point through which the beam passes
</doc>
</attribute>
<attribute name="depends_on" type="NX_CHAR">
<doc>
Points to the path to a field defining the location on which this
depends or the string "." for origin.
</doc>
</attribute>
</field>
<field name="reference_plane" units="NX_TRANSFORMATION" type="NX_NUMBER">
<doc>
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
</doc>
<attribute name="transformation_type">
<enumeration>
<item value="translation"/>
</enumeration>
</attribute>
<attribute name="vector" type="NX_NUMBER">
<doc>
Three values that define the direction of reference plane normal
</doc>
</attribute>
<attribute name="offset" type="NX_NUMBER">
<doc>
Not required as beam direction offset locates the plane
</doc>
</attribute>
<attribute name="depends_on" type="NX_CHAR">
<doc>
Points to the path to a field defining the location on which this
depends or the string "." for origin.
</doc>
</attribute>
</field>
</group>
<field name="previous_device">
<doc>
Indicates the beam device from which this beam originates.
Expand Down Expand Up @@ -522,7 +431,7 @@
</doc>
</attribute>
</field>
<field name="reference_plane" nameType="any" units="NX_TRANSFORMATION" type="NX_NUMBER">
<field name="reference_plane" units="NX_TRANSFORMATION" type="NX_NUMBER">
<doc>
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.
Expand Down Expand Up @@ -551,4 +460,4 @@
</attribute>
</field>
</group>
</definition>
</definition>

0 comments on commit c75d5c2

Please sign in to comment.