Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polarized SANS metadata: update instrument IDFs #38501

Open
rbauststfc opened this issue Dec 12, 2024 · 0 comments
Open

Polarized SANS metadata: update instrument IDFs #38501

rbauststfc opened this issue Dec 12, 2024 · 0 comments
Assignees
Labels
ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS SANS Issues and pull requests related to SANS
Milestone

Comments

@rbauststfc
Copy link
Contributor

Part of #36147. See the design and requirements documents that are linked on that issue for more context.

The SANS IDFs should be updated to include the polarizing components that they would like to save metadata about. As per the design document, we have agreed that this should be done as follows:

For polarizers

  <component type="polarizer" name=”supermirror-polarizer”>
      <location y="0.0" x="1.0" z="0.0"/>
      <parameter name="device-name" type="string"> <value val="Supermirror polarizer" /> </parameter>
      <parameter name="device-type" type="string"> <value val="supermirror" /> </parameter>
  </component>
  <type name="polarizer" />

For analysers:

  <component type="analyzer" name=”helium-analyzer”>
      <location y="0.0" x="1.0" z="0.0"/>
      <parameter name="device-name" type="string"> <value val="3He Analyser" /> </parameter>
      <parameter name="device-type" type="string"> <value val="3He" /> </parameter>
     <parameter name="cell-length"> <value val="0.005” /> </parameter>
  </component>
  <type name="analyzer" />

For flippers (includes anything like spin-rotators that will also be recorded as a flipper in the NXcanSAS file):

  <component type="flipper" name=”polarizing-flipper”>
      <location y="0.0" x="1.0" z="0.0"/>
      <parameter name="device-name" type="string"> <value val="Polarizing flipper" /> </parameter>
      <parameter name="device-type" type="string"> <value val="coil" /> </parameter>
  </component>
  <type name="flipper" />

In each case, the device-name parameter is optional. If used it will be the name used for the component in the NXcanSAS file. If omitted, the component name will be used instead.

Depending on what is useful for our scientists, further information could be added, and the components could be given appropriate shapes, etc. However, the parameters shown above are the things that must be included in the definition (the location must also be included, but I believe that is already mandatory as part of defining any component).

@rbauststfc rbauststfc added SANS Issues and pull requests related to SANS ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS labels Dec 12, 2024
@rbauststfc rbauststfc added this to the Release 6.12 milestone Dec 12, 2024
@rbauststfc rbauststfc moved this to Gathering Requirements in ISIS Polarised SANS Reduction Dec 12, 2024
@rbauststfc rbauststfc moved this from New to Backlog in ISIS LSS Sprint Planning Dec 12, 2024
@rbauststfc rbauststfc changed the title Saving polarized SANS metadata: update instrument IDFs Polarized SANS metadata: update instrument IDFs Dec 12, 2024
@rbauststfc rbauststfc self-assigned this Dec 13, 2024
@rbauststfc rbauststfc moved this from Gathering Requirements to Ready for Development in ISIS Polarised SANS Reduction Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS SANS Issues and pull requests related to SANS
Projects
Status: Backlog
Status: Ready for Development
Development

No branches or pull requests

1 participant