Merge In Updated Tube Calib Scripts

[DavidFair]

Original reporter: ISIS/Richard

Richard has been recently working on a local copy of the tube calibration scripts (scripts/calibration) and would like the changes merged back in and tidied up.

Specifically, these changes work better where the resolution is bad. However, it has been changed with the horizontal tubes of SANS2D rather than the existing tubes (horizontal on MERLIN) in mind. So we need to check that it still produces sane results on instruments with horizontal tubes.

60330front_TEST_SCRIPT.py - Exercises the two below scripts tube_calib_RKH.py.txt tube_RKH.py.txt

[smk78]

NB: Richard says start with the Direct Beam iterator script first (https://github.com/mantidproject/mantid/issues/28986) as it will be easier!

[gemmaguest]

See also #10892

[stale[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you feel this is incorrect please comment to keep it alive, with a reason why.

To prevent closure, e.g. for long-term planning issues, add the "Never Stale" label.

[stale[bot]]

This issue has been automatically marked as stale because it has not had activity in 6 months. It will be closed in 7 days if no further activity occurs. Allowing issues to close as stale helps us filter out issues which can wait for future development time. All issues closed by stale bot act like normal issues; they can be searched for, commented on or reopened at any point. If you'd like a closed stale issue to be considered, feel free to either re-open the issue directly or contact a developer. To extend the lifetime of an issue please comment below, it helps us see that this is still affecting you and you want it fixed in the near-future. Extending the lifetime of an issue may cause the development team to prioritise it over other issues, which may be closed as stale instead.

[stale[bot]]

This issue has been closed automatically. If this still affects you please re-open this issue with a comment or contact us so we can look into resolving it.

[rbauststfc]

Outstanding tasks as of 14/03/2023:

• [x] Once we are sure that the algorithm is producing a correct result, we should add some automated tests and merge the script into the Mantid codebase. This will allow us to make further changes while remaining confident that functionality hasn't been broken.
• [ ] Check the handling of skipped tubes in the diagnostic output that is created after the calibration has finished. Should we still be outputting something here for tubes that have been skipped? Think this isn't required.
• [x] Tidy up Background parameter code - this parameter value is actually not used at all. In the code, the FlatTopPeak algorithm is used for the peak fitting and this algorithm uses a hard-coded value as the background. We need to confirm what this parameter is actually doing and it's likely we should make this use the value passed in via the Background parameter. The other place in the code that uses a background value is if a Gaussian function is used to fit the peak, in which case another hard-coded value is used. However, while the code for Gaussian fitting is still in the script, we’re not actually using it so I think we could remove it.
• [ ] Calibrations for both Larmor and Zoom need to be supported by the script. Both Larmor and Zoom have only rear detectors. Not currently a requirement - a new issue will be opened in future if this is still needed.
• [x] Refactor the code. In particular it looks like there could be quite a bit of unused code in the script. It would be good to merge it all in initially so that we have a copy of the original working version, but then we should remove unused blocks of code and streamline where possible to improve readability and maintainability.
• [x] Improve error handling in the code.
• [x] Add documentation for the new algorithms.

Other outstanding tasks have been moved to the following separate issues:

• 35980

• 35981

• 35982

• 35983