nexusformat / definitions

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

Sample temperature and magnetic_field #1340

Open g-guenther opened 8 months ago

g-guenther commented 8 months ago

Currently, in the documentation temperature is of type field while magnetic_field exists as type field and as group NXlog. According to #816, I guess:

mkoennecke commented 8 months ago

No, this is something which NeXus introduced with streaming support. Any field can either be a single number or array or a NXlog. The single number or array is applicable when there is only a single value per scan point. However if you do event streaming and the field is changing during data acquisition then it becomes a NXlog. Consider a fast tomography experiment where you move the sample rotation while collecting images and trying to associate sample positions with images through time later on. In this case both the sample rotation and the detector images live in NXlog's.

Od you want to monitor temperature through a long running data acquisition.

g-guenther commented 8 months ago

Thanks for the explanation. If I understand you correctly, some corresponding NXlog classes are missing in the current documentation: temperature, electric_field, stress field, and pressure should be listed as NXlog, as well. Is this what you mean?

mkoennecke commented 8 months ago

Well, this is documented at https://manual.nexusformat.org/rules.html under the heading Streaming Data Acquisition and Logging as a general rule. IMHO, this is enough and may not need to be repeated in the base classes.