Skip to content

Commit

Permalink
Apply consistent double backticks
Browse files Browse the repository at this point in the history
Co-authored-by: RubelMozumder <[email protected]>
  • Loading branch information
lukaspie and RubelMozumder authored Oct 9, 2024
1 parent 767eeb3 commit 2529db0
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions base_classes/NXbeam.nxdl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@
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 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.
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.
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.
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.
Expand All @@ -88,16 +88,16 @@
The energy spread FWHM for the corresponding energy(ies) in incident_energy. In the case of shot-to-shot variation in
the energy spread, this is a 2D array of dimension nP by m
(slow to fast) of the spreads of the corresponding
wavelength in incident_wavelength.
wavelength in ``incident_wavelength``.
</doc>
</field>
<field name="incident_energy_weights" type="NX_NUMBER" units="NX_ENERGY">
<doc>
In the case of a polychromatic beam this is an array of length m of the relative
weights of the corresponding energies in incident_energy. In the case of a
weights of the corresponding energies in ``incident_energy``. In the case of a
polychromatic beam that varies shot-to-shot, this is a 2D array of dimensions np
by m (slow to fast) of the relative weights of the corresponding energies in
incident_energy.
by m (slow to fast) of the relative weights of the corresponding energies of
``incident_energy``.
</doc>
</field>
<field name="final_energy" type="NX_FLOAT" units="NX_ENERGY">
Expand Down

0 comments on commit 2529db0

Please sign in to comment.