Add Output SpinState to SampleLog in PolarizationCorrectionFredrikze Algorithm

[yusufjimoh]

Description of work

• Added functions to include spin state information in the PolarizationCorrectionFredrikZe algorithm.
• Modified mapOutputWorkspaceToSpinState to append output spin states to the sample log when requested.
• Updated unit tests to verify that the order of output workspaces aligns with the specified output spin states and that spin state information is correctly recorded in the sample log.
• Updated documentation to reflect the new functionality and clarify its usage

Fixes #38265

To test:

Test for PA

1. Run the following script. It will output a group of workspaces called "out". Check that the sample log of each child workspace does not contain an entry with the name spin_state_ORSO.

run1 = Load("POLREF00004699.nxs")
run2 = run1 * 1.2
run = GroupWorkspaces([run1, run2])
ws1 = CreateWorkspace([0.01, 17.0, 34.0], [50000, 50000])
eff = JoinISISPolarizationEfficiencies(Pp=ws1,   Rho=ws1, Ap=ws1, Alpha=ws1)
run = ConvertUnits(run, "Wavelength")
eff = ConvertUnits(eff, "Wavelength")
eff = RebinToWorkspace(eff, run.getItem(0), True)

out = PolarizationCorrectionFredrikze(run, eff, "PA", InputSpinStates="pp, pa, ap, aa", OutputSpinStates="pp, pa, ap, aa")

2. Without clearing any of your workspaces, run the following:

with_log = PolarizationCorrectionFredrikze(run, eff, "PA", InputSpinStates="pp, pa, ap, aa", OutputSpinStates="pp, pa, ap, aa", AddSpinStateToLog=True)

Check that the sample log of each child workspace in the "with_log" group does contain an entry with the name spin_state_ORSO. The log values should be as follows:

• with_log_1 workspace has value pp
• with_log_2 workspace has value pm
• with_log_3 workspace has value mp
• with_log_4 workspace has value mm

3. Test the functionality on the GUI using the same input workspaces and spinstates

• when AddSpinStateToLog checkbox is not enabled: Check that the sample log of each child workspace does not contain an entry with the name spin_state_ORSO.

• when addSpinStateToLog checkbox is enabled: Check that the sample log of each child workspace in the "with_log" group does contain an entry with the name spin_state_ORSO. The log values should be as follows:

• with_log_1 workspace has value pp

• with_log_2 workspace has value pm

• with_log_3 workspace has value mp

• with_log_4 workspace has value mm

Test for PNR

1. clear your workspaces and run the following script. It will output a group of workspaces called "out". Check that the sample log of each child workspace does not contain an entry with the name spin_state_ORSO.

run = Load("POLREF00004699.nxs")
ws1 = CreateWorkspace([0.01, 17.0, 34.0], [50000, 50000])
eff = JoinISISPolarizationEfficiencies(Pp=ws1,   Rho=ws1, Ap=ws1, Alpha=ws1)
run = ConvertUnits(run, "Wavelength")
eff = ConvertUnits(eff, "Wavelength")
eff = RebinToWorkspace(eff, run.getItem(0), True)

out = PolarizationCorrectionFredrikze(run, eff, "PNR", InputSpinStates="p, a", OutputSpinStates="p, a")

2. Without clearing any of your workspaces, run the following:

with_log = out = PolarizationCorrectionFredrikze(run, eff, "PNR", InputSpinStates="p, a", OutputSpinStates="p, a", AddSpinStateToLog=True)

Check that the sample log of each child workspace in the "with_log" group does contain an entry with the name spin_state_ORSO. The log values should be as follows:

• with_log_1 workspace has value po
• with_log_2 workspace has value mo

3. Test the functionality on the GUI using the same input workspaces and spinstates

• when AddSpinStateToLog checkbox is not enabled: Check that the sample log of each child workspace does not contain an entry with the name spin_state_ORSO.

• when addSpinStateToLog checkbox is enabled: Check that the sample log of each child workspace in the "with_log" group does contain an entry with the name spin_state_ORSO. The log values should be as follows:

• with_log_1 workspace has value po

• with_log_2 workspace has value mo