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

Add output spin state to sample log in PolarizationCorrectionWildes #38264

Open
rbauststfc opened this issue Oct 22, 2024 · 0 comments
Open

Add output spin state to sample log in PolarizationCorrectionWildes #38264

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

Comments

@rbauststfc
Copy link
Contributor

Part of #36685.

It would be good to optionally add the spin state to the sample log for the output workspaces in PolarizationCorrectionWildes. This will provide a reliable way of identifying the spin state of a workspace, which will make it easy to include this metadata in reduced data files. This has been requested by the ISIS Reflectometry Group and they have asked that we use the ORSO notation in the log. See linked issue for more details.

We should implement the following:

  • The log name should be spin_state_ORSO. I think this might be better than just spin_state because there seem to be a lot of different notations in use, so this makes it clear which one we're using.
  • PolarizationCorrectionWildes should expose a new parameter AddSpinStateToLog that defaults to False to maintain backwards compatibility. This means that users can choose whether to have the spin state log added. This new parameter would need to be exposed through PolarizationEfficiencyCor.
  • For PA, the output workspaces should be labelled as follows:
    • ++ = pp
    • +- = pm
    • -+ = mp
    • -- = mm
  • For PNR, the output workspaces should be labelled as follows:
    • ++ = po
    • -- = mo
@rbauststfc rbauststfc added Reflectometry Issues and pull requests related to reflectometry ISIS Team: LSS Issue and pull requests managed by the LSS subteam at ISIS labels Oct 22, 2024
@rbauststfc rbauststfc added this to the Release 6.12 milestone Oct 22, 2024
@rbauststfc rbauststfc self-assigned this Oct 22, 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 Reflectometry Issues and pull requests related to reflectometry
Projects
Status: In Progress
Development

No branches or pull requests

1 participant