Common code in IntegratePeaksSkew, IntegratePeaksShoeboxTOF, FindSXPeaksConvolve, IntegratePeaks1DProfile algorithms moved to a utility module #38789
+594
−477
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
, andIntegratePeaks1DProfile
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.
IntegratePeaksSkew
IntegratePeaksShoeboxTOF
FindSXPeaksConvolve
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
Functional Tests
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.