Enable changing of wildes flipper config via the ISIS Reflectometry GUI by MialLewis · Pull Request #41353 · mantidproject/mantid

MialLewis · 2026-05-05T17:50:47Z

Description of work

Generalised the ISIS Reflectometry polarization input spin-state order so the GUI value can be used for both Fredrikze and Wildes corrections.
Reused SpinStateValidator for spin-state family validation. This is used to check if Wildes flipper config is being used for a Fredrikze correction and vice-versa.
Added warnings when Fredrikze or Wildes spin-state defaults are missing from the instrument parameter file and algorithm defaults are used.
Added/updated tests covering GUI propagation, Fredrikze/Wildes validation, IPF defaults, and fallback behaviour.
Extracted polarization correction code out of ReflectometryReductionOneAuto to a helper class ReflectometryPolarizationCorrectionISIS to aid readability.

To test:

Follow test instructions on this PR:
#38783

Ensure to test the different errors expected when you use Wildes correction for Fredriekze, 2 spin states inputs when 4 is expected etc.

Also test changing the defaults in the instrument parameter files, ensure those values are pulled through correctly.

To test a realistic polarised reduction:

from mantid.simpleapi import *

Load(Filename='/Users/mial.lewis/data/PNR/POLREF00047039.nxs', OutputWorkspace='POLREF00047039')
Load(Filename='/Users/mial.lewis/data/PNR/POLREF00047041.nxs', OutputWorkspace='POLREF00047041')
Load(Filename='/Users/mial.lewis/data/PNR/polref_pol_corr_05_03_26.nxs', OutputWorkspace='polref_pol_corr_05_03_26')
LoadInstrument(Workspace='POLREF00047039', InstrumentName='POLREF', RewriteSpectraMap=False)
LoadInstrument(Workspace='POLREF00047041', InstrumentName='POLREF', RewriteSpectraMap=False)
LoadInstrument(Workspace='polref_pol_corr_05_03_26', InstrumentName='POLREF', RewriteSpectraMap=False)
ReflectometryReductionOneAuto(InputWorkspace='POLREF00047041',
                          ThetaIn=0.4, ProcessingInstructions='272-288',
                          WavelengthMin=1, WavelengthMax=15, I0MonitorIndex=2, MonitorBackgroundWavelengthMin=15,
                          MonitorBackgroundWavelengthMax=16, MonitorIntegrationWavelengthMin=4, MonitorIntegrationWavelengthMax=10,
                          SubtractBackground=True, BackgroundProcessingInstructions='360-450', FirstTransmissionRun='POLREF00047039', PolarizationAnalysis=True, PolarizationEfficiencies='polref_pol_corr_05_03_26')

Reviewer

Your comments will be used as part of the gatekeeper process. Comment clearly on what you have checked and tested during your review. Provide an audit trail for any changes requested.

As per the review guidelines:

Is the code of an acceptable quality? (Code standards/GUI standards)
Has a thorough functional test been performed? Do the changes handle unexpected input/situations?
Are appropriately scoped unit and/or system tests provided?
Do the release notes conform to the guidelines and describe the changes appropriately?
Has the relevant (user and developer) documentation been added/updated?
If the PR author isn’t in the mantid-developers or mantid-contributors teams, add a review comment rerun ci to authorize/rerun the CI

Gatekeeper

As per the gatekeeping guidelines:

Has a thorough first line review been conducted, including functional testing?
At a high-level, is the code quality sufficient?
Are the base, milestone and labels correct?

github-actions · 2026-05-06T12:30:42Z

System test results

810 tests 792 ✅ 2h 13m 52s ⏱️
48 suites 17 💤
48 files 1 ❌

Results for commit 0572532.

github-actions · 2026-05-14T10:35:44Z

👋 Hi, @MialLewis,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

github-actions · 2026-05-20T14:30:10Z

👋 Hi, @MialLewis,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

github-actions · 2026-05-20T20:30:36Z

Unit test results (Linux)

2 870 tests 2 869 ✅ 13h 41m 25s ⏱️
1 suites 0 💤
1 files 1 ❌

Results for commit 3c6cc3a.

MialLewis · 2026-05-21T08:45:55Z

       </property>
       <property name="text">
-        <string>Fredrikze Input SpinState Order</string>
+        <string>Input SpinState Order</string>


I plan to change this to Input Flipper/SpinState order, I'll make the change when addressing review comments.

cailafinn

Functionally tested according to instructions, getting good error messages for wrong correction alg type (p,a vs 0, 1) and for numbers of spin states. But there is a slightly unexpected one for if the wrong form is used. E.g Wildes PNR & (00, 11):

Error in execution of algorithm ReflectometryISISLoadAndProcess:
Add Data Object with empty name
  at line 111 in '/Users/caila.finn/repos/mantid-r/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py'
  caused by line 656 in '/Users/caila.finn/repos/mantid-r/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py'

Just one note on the release note and the GUI change that you'd already spotted.

cailafinn · 2026-05-21T12:49:37Z

+- The ISIS Reflectometry GUI polarization input spin state order field can now be used to specify the Wildes flipper
+  configuration as well as the Fredrikze input spin state order. Leaving the field empty continues to use the defaults
+  from the instrument parameter file or correction algorithm.
+- The reduction now reports when a Fredrikze spin state order is supplied for a Wildes correction, or a Wildes flipper
+  configuration is supplied for a Fredrikze correction.


Are there docs links we could be including here?

MialLewis · 2026-05-21T14:19:48Z

Functionally tested according to instructions, getting good error messages for wrong correction alg type (p,a vs 0, 1) and for numbers of spin states. But there is a slightly unexpected one for if the wrong form is used. E.g Wildes PNR & (00, 11):
Error in execution of algorithm ReflectometryISISLoadAndProcess:
Add Data Object with empty name
  at line 111 in '/Users/caila.finn/repos/mantid-r/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py'
  caused by line 656 in '/Users/caila.finn/repos/mantid-r/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py'
Just one note on the release note and the GUI change that you'd already spotted.

Good spot, I didn't consider this case

github-actions · 2026-05-22T11:04:55Z

👋 Hi, @MialLewis,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

github-actions · 2026-05-22T11:08:53Z

👋 Hi, @MialLewis,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

Improve polarization spin state validation refactor to utilise existing spin state validation Improve Fredrikze spin state count validation Refactor reflectometry polarization correction handling Address reflectometry polarization review comments

remove accidentally included test

MialLewis · 2026-05-22T12:41:45Z

Functionally tested according to instructions, getting good error messages for wrong correction alg type (p,a vs 0, 1) and for numbers of spin states. But there is a slightly unexpected one for if the wrong form is used. E.g Wildes PNR & (00, 11):
Error in execution of algorithm ReflectometryISISLoadAndProcess:
Add Data Object with empty name
  at line 111 in '/Users/caila.finn/repos/mantid-r/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py'
  caused by line 656 in '/Users/caila.finn/repos/mantid-r/Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ReflectometryISISLoadAndProcess.py'
Just one note on the release note and the GUI change that you'd already spotted.
Good spot, I didn't consider this case

I didn't make a change with regards to this. It turns out that 00, 11 is a valid input spin states to PolarizationCorrectionWildes, which deals with the validation: https://docs.mantidproject.org/v6.15.0/algorithms/PolarizationCorrectionWildes-v1.html

It has always been possible to encounter this error so it's not a regression, though one would have had to previously edit the parameters file.

I'll need to discuss how this should behave in the context of the Polarised Reflectivity workflow with the Reflectometry scientists.

Issue: #41469

github-actions · 2026-05-22T14:04:38Z

👋 Hi, @MialLewis,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

github-actions Bot added this to the Release 6.16 milestone May 5, 2026

MialLewis marked this pull request as ready for review May 6, 2026 12:33

github-actions Bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label May 14, 2026

MialLewis force-pushed the enable_changing_of_wildes_flipper_config branch from 0572532 to 4bb2aba Compare May 20, 2026 12:57

github-actions Bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label May 20, 2026

MialLewis changed the base branch from main to group_workspace_history_change May 20, 2026 12:59

Base automatically changed from group_workspace_history_change to main May 20, 2026 14:29

github-actions Bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label May 20, 2026

github-actions Bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label May 20, 2026

MialLewis requested a review from cailafinn May 21, 2026 08:44

MialLewis commented May 21, 2026

View reviewed changes

cailafinn requested changes May 21, 2026

View reviewed changes

samtygier-stfc changed the base branch from main to release-next May 21, 2026 15:48

sf1919 added this to v6.16.0 release May 22, 2026

sf1919 moved this to Ready for Review in v6.16.0 release May 22, 2026

sf1919 removed this from v6.16.0 release May 22, 2026

MialLewis force-pushed the enable_changing_of_wildes_flipper_config branch from 3c6cc3a to 9966697 Compare May 22, 2026 11:04

github-actions Bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label May 22, 2026

github-actions Bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label May 22, 2026

MialLewis force-pushed the enable_changing_of_wildes_flipper_config branch from a8cc46f to 1473807 Compare May 22, 2026 11:08

github-actions Bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label May 22, 2026

MialLewis added 2 commits May 22, 2026 13:34

correct merge issues

abe8199

MialLewis added 2 commits May 22, 2026 13:34

respond to review comments

f7578a0

remove accidentally included test

remove accidently included helper

b40613d

MialLewis force-pushed the enable_changing_of_wildes_flipper_config branch from 1473807 to b40613d Compare May 22, 2026 12:34

github-actions Bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label May 22, 2026

MialLewis requested a review from cailafinn May 22, 2026 12:39

MialLewis mentioned this pull request May 22, 2026

Polarization correction fails with valid, but incorrect wildes spin states #41469

Open

MialLewis modified the milestones: Release 6.16, Release 6.17 May 22, 2026

MialLewis changed the base branch from release-next to main May 22, 2026 13:35

fix the worse merge ever undertaken again

aab892a

MialLewis force-pushed the enable_changing_of_wildes_flipper_config branch from db9333d to aab892a Compare May 22, 2026 14:04

github-actions Bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label May 22, 2026

Merge branch 'main' into enable_changing_of_wildes_flipper_config

6f75d87

github-actions Bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label May 22, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable changing of wildes flipper config via the ISIS Reflectometry GUI#41353

Enable changing of wildes flipper config via the ISIS Reflectometry GUI#41353
MialLewis wants to merge 6 commits into
mainfrom
enable_changing_of_wildes_flipper_config

MialLewis commented May 5, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 6, 2026

Uh oh!

github-actions Bot commented May 14, 2026

Uh oh!

github-actions Bot commented May 20, 2026

Uh oh!

github-actions Bot commented May 20, 2026

Uh oh!

MialLewis May 21, 2026

Uh oh!

cailafinn left a comment

Uh oh!

cailafinn May 21, 2026

Uh oh!

MialLewis commented May 21, 2026

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

MialLewis commented May 22, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

MialLewis commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of work

To test:

Reviewer

Gatekeeper

Uh oh!

github-actions Bot commented May 6, 2026

System test results

Uh oh!

github-actions Bot commented May 14, 2026

Uh oh!

github-actions Bot commented May 20, 2026

Uh oh!

github-actions Bot commented May 20, 2026

Unit test results (Linux)

Uh oh!

MialLewis May 21, 2026

Choose a reason for hiding this comment

Uh oh!

cailafinn left a comment

Choose a reason for hiding this comment

Uh oh!

cailafinn May 21, 2026

Choose a reason for hiding this comment

Uh oh!

MialLewis commented May 21, 2026

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

MialLewis commented May 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented May 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

MialLewis commented May 5, 2026 •

edited

Loading

MialLewis commented May 22, 2026 •

edited

Loading