Additions to NXmpes/NXinstrument

[domna]

There are some alterations desired for NXmpes/NXinstrument:

• [x] Add an NXtransformation to NXenergydispersion
• [x] Allow for torroidal analyzers
• [x] Allow for multiple angular resolutions (possibly already solved by NXresolution?)
• [x] Is there a type in NXbeam? If so rename/remove it so we only have probe.
• [x] Refactor NXsource docstring (there is no ring or facility!) #83

Meeting ref

[lukaspie]

Allow for torroidal analyzers

Is this only in NXenergydispersion? I.e. just extending the scheme enumeration?

[lukaspie]

Allow for multiple angular resolutions (possibly already solved by NXresolution?)

I guess one could just use the resolution(NXdata) field in NXresolution to have multiple values (e.g., in different momentum directions)

[lukaspie]

Is there a type in NXbeam? If so rename/remove it so we only have probe.

These fields only exists in NXsource, with type indicating the physical type and probe the actually emitted element. Currently, the base class is limited like this:

NXsource(NXobject):
  type:
    doc: |
      type of radiation source (pick one from the enumerated list and spell exactly)
    enumeration: [Spallation Neutron Source, Pulsed Reactor Neutron Source, Reactor Neutron Source, Synchrotron X-ray Source, Pulsed Muon Source, Rotating Anode X-ray, Fixed Tube X-ray, UV Laser, Free-Electron Laser, Optical Laser, Ion Source, UV Plasma Source, Metal Jet X-ray]
  probe:
    doc: |
      type of radiation probe (pick one from the enumerated list and spell exactly)
    enumeration: [neutron, photon, x-ray, muon, electron, ultraviolet, visible light, positron, proton]

And in MPES, we are restricting to:

source_TYPE(NXsource):
  type:
    enumeration: [Synchrotron X-ray Source, Rotating Anode X-ray, Fixed Tube X-ray, UV Laser, Free-Electron Laser, Optical Laser, UV Plasma Source, Metal Jet X-ray, HHG laser, UV lamp, Monochromatized electron source, other]
  type_other:
    exists: optional
    doc: |
      Specification of type, may also go to name.
    probe:
      doc: |
        Type of probe. In photoemission it's always photons, so the full NIAC list is
        restricted.
      exists: optional
      enumeration: [photon, x-ray, visible light, ultraviolet]

I don't think we need to change anything here for the current proposal, we may want to later use base class inheritance for different types of sources.

[lukaspie]

@domna is there anything you wanted to add here? If not, I will close.

[domna]

I left a comment in #52. I think the depends_on should be listed directly under NXenergydispersion and not under another NXtransformations.

Is there a type in NXbeam? If so rename/remove it so we only have probe.

Wasn't there anything duplicate? Or was it just the photon / x-ray ambiguity?