Common code in IntegratePeaksSkew, IntegratePeaksShoeboxTOF, FindSXPeaksConvolve, IntegratePeaks1DProfile algorithms moved to a utility module

[warunawickramasingha]

Description of work

A code refactoring was performed by extracting a bunch of common code inside a few peak integration algorithms into a common module named peakdata_utils.

Now those algorithms can import such utility code from the new module rather than importing directly from other algorithms. This PR makes sure that code inside IntegratePeaksSkew, IntegratePeaksShoeboxTOF, FindSXPeaksConvolve, and IntegratePeaks1DProfile would only contain the code specific to each algorithm and utility functions related to peak integration would be imported from the newly introduced utility module.

Fixes #36989.

Further detail of work

To test:

There should be NO functional changes in the below peak integration algorithms and they should work exactly as they did before.

1. IntegratePeaksSkew
2. IntegratePeaksShoeboxTOF
3. FindSXPeaksConvolve
4. IntegratePeaks1DProfile

A release note was added to notify about the update required in import paths in any external scripts if those utility classes are being used directly.

---

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

• Is the code of an acceptable quality?
• Does the code conform to the coding standards?
• Are the unit tests small and test the class in isolation?
• If there is GUI work does it follow the GUI standards?
• If there are changes in the release notes then do they describe the changes appropriately?
• Do the release notes conform to the release notes guide?

Functional Tests

• Do changes function as described? Add comments below that describe the tests performed?
• Do the changes handle unexpected situations, e.g. bad input?
• Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

[RichardWaiteSTFC]

Thanks for this, really appreciate it, been on the backlog for a while!
No unit test5s required changing so that's promising!
Just a couple of suggestions:

• I wonder whether it would be possible to have the IntegratePeaksSkew method have a PeakDataSkew class that inherits from PeakData and then has additional skew-specific methods associated with it (e.g. plot_integrated_peak) - such that only the methods common to all algorithms are in the peakdata_utils does that make sense?
• There's some InstrumentArrayConverter tests in unit tests for IntegratePeaksSkew e.g.
  

  mantid/Framework/PythonInterface/test/python/plugins/algorithms/IntegratePeaksSkewTest.py

  Line 439 in 024daa6

  def test_array_converter_finds_adjacent_banks_to_left_for_component_array_detectors(self):

  
  would it be possible to move these to a unit test file for peakdata_utils?

[RichardWaiteSTFC]

Looks good to me thanks for the changes! I tested all the algorithms touched by this and everything works. Do you need to update any of the CNN stuff in the script repo after this gets merged?

[warunawickramasingha]

Looks good to me thanks for the changes! I tested all the algorithms touched by this and everything works. Do you need to update any of the CNN stuff in the script repo after this gets merged?

Thanks for checking!
Related changes in the script repository are listed in this PR: mantidproject/scriptrepository#19

For the CNN work, required changes(when data is simulated) are in a sub branch and not in master.

[jclarkeSTFC]

Looks good to go, I just suggested a small fix for the release note.

[warunawickramasingha]

Looks good to go, I just suggested a small fix for the release note.

Many thanks for noting this!