nexusformat / definitions

Definitions of the NeXus Standard File Structure and Contents
https://manual.nexusformat.org/
Other
26 stars 55 forks source link

Unclear relationship between `NXenvironment` and devices/apparatus #1362

Open paulmillar opened 4 months ago

paulmillar commented 4 months ago

The current description of NXenvironment is

<doc>Parameters for controlling external conditions</doc>

This leaves completely unspecified the relationship between a NXenvironment and the physical devices that were employed during the experiment.

However, from the various fields and groups, it seems that an NXenvironment is intended to describe a single, physical device. Many groups and fields are described in terms of "the apparatus" (in particular, note the use of "the"); e.g.,

<field name="name">
    <doc>Apparatus identification code/model number; e.g. OC100 011</doc>
</field>
<field name="program">
    <doc>Program controlling the apparatus; e.g. LabView VI name</doc>
</field>
    <group name="position" type="NXgeometry">
        <doc>
             The position and orientation of the apparatus.
             Note, it is recommended to use NXtransformations instead.
        </doc>
    </group>

It would be helpful if the documentation for NXenvironment were updated to make it clear what is the relationship between NXenvironment groups and the physical devices involved in the experiment.