nexusformat / definitions

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

Detector channels #1252

Closed phyy-nx closed 8 months ago

phyy-nx commented 1 year ago

This PR adds NXdetector_channel as a base class and adds it as optional for NXmx. @soph-dec and @kalcutter I put in placeholder documentation. Can you review and comment?

See original Dectris proposal: https://github.com/dectris/documentation/tree/main/filewriter_v2#user-content-multi-channel-data

Closes #940 Requires #1246 to be merged first

Co-authored-by: Sophie Hotz sophie.hotz@dectris.com

soph-dec commented 1 year ago

Thank you for the PR Aaron! First glance is looking good, I will review everything in detail next week.

phyy-nx commented 1 year ago

I think we should mention NXdetector_channel in NXdetector as well. I guess something like this might do?

  <group name="CHANNELNAME_channel" type="NXdetector_channel">
      <doc>
          Group containing the description and metadata for a single channel from a multi-channel
          detector.

          Given an :ref:`NXdata` group linked as part of an NXdetector group that has an axis with
          named channels (see the example in :ref:`NXdata &lt;/NXdata@default_slice-attribute&gt;`),
          the NXdetector will have a series of NXdetector_channel groups, one for each channel,
          named CHANNELNAME_channel.
      </doc>
  </group>

Done! Also added to NXmx

phyy-nx commented 9 months ago

Conflicts fixed, no changes to this branch.

Reviewers might find it easier to use this link to compare the detector_channel branch to the dimension_as_char branch until #1246 is merged: https://github.com/nexusformat/definitions/compare/dimension_as_char...detector_channel

phyy-nx commented 8 months ago

This PR is ready for a NIAC vote. Please vote with an emoji on this comment. Options include thumbs up for yes, thumbs down for no, and anything else to abstain. Thank you. Voting will close in two weeks.

phyy-nx commented 8 months ago

Vote has passed. Thanks all.