Change results group workspace suffix for single fits in QENS Fitting interface #39067
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
Fixes #38827 .
This PR changes the suffix of the results output groups that are generated form the qens fitting interface after a fitting. When the fit involves more than one workspace (multifit), the results group has multiple workspaces, while when the fit contains only one single workspace (single fit) the results group has one workspace.
The group has the suffix
_Results
while the workspaces within the group have each suffix_Result
.This generates problems when mantid project is saved: The group workspaces containing one member are saved and reloaded as matrix workspaces instead of group workspaces, but with the name of the group (so that workspaces with groups ending in "_Result" will take the name of the group and end with "_Results" when loaded back). This is generally inconsequential for most Mantid workflows, but in the case of the Function Q tab of the QENS fitting interface, the load dialog seeks for a workspace or file ending with the suffix "_Result", and compatible files are not detected.
This is not really a bug in the Function Q interface, but rather a clash between two incompatible designs within Mantid.
Summary of work
What I have done in this PR is to choose a compromise solution, when the
_Results
group contains only one workspace member, the whole group will end with the suffix_Result
instead. This will prompt the project saver to save the file with the correct suffix so when the workspace is loaded as a matrix workspace, it will be detected by the function q interface.Additionally, Spencer made me aware of a bug that involved double plotting of some data from the output plot widget of the interfaces when the
Plot
button is clicked. As the solution for this was very simple, I have added it on this PR (and on release notes)Fixes #38827.
Further detail of work
Additionally, tests are added. I have slightly refactored the test suite, and also added type hints to
IndirectReplaceFit...
algorithm.To test:
_Result
._Result
and be detectable from the Function Q tab.Added release notes
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.