Refactor SaveNXcanSAS algorithm to support different variants #38582
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… inherit from saveNXcanSASBase
1. There were doxygen lines in add2DData function that needed to be escaped with \. to avoid a warning, this was not detected before as doxygen does not look in anonymous namespaces for mantid. 2. There was a doxygen comment missing input parameters to the function addInstrument.
|
Can we get a milestone on this please? |
GuiMacielPereira
approved these changes
Jan 13, 2025
There was a problem hiding this comment.
SaveNXcanSAS.cpp was split into SaveNXcanSASBase.cpp and NXcanSASHelper.cpp, to prepare the base class for creating another diverging algorithm as specified by the original issue. The code looks good and from what I can tell no major changes were introduced.
There was no change to the unit tests, so checking that they run is enough to check that these changes were not disruptive.
I searched the logs from the CI to check these tests ran without issues and confirmed this was the case 👍
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR refactors current implementation of the SaveNXcanSAS algorithm to allow multiple variants of algorithms saving in NXcanSAS format ( like polarized data). Explained in #38503
The refactoring has mainly reorganized the code, the
SaveNXcanSASalgorithm is now derived from a parentSaveNXcanSASBasewhich contains different initializers and validator functions that specialize the algorithm to support different kinds of data and metadata. At this moment, it validates and adds what is considered standard metadata for a NXcanSAS format.A helper file has been also created to place common functions that add different groups and data to the H5 file. These were previously stored in an anonymous namespace in the SaveNXcanSAS algorithm, and now are accessible to other algorithms through the NXcanSAS namespace.
Summary of work
Fixes #38503.
Further detail of work
To test:
this does not required release notes as it is an internal reorganization and does not affect the user experience
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/gatekeeperswill 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.