Skip to content

Conversation

rosswhitfield
Copy link
Member

@rosswhitfield rosswhitfield commented May 5, 2025

Description of work

The algorithm description describes this algorithm as deprecated, this officially marks it as such.

Summary of work

Fixes 10035: Deprecate IntegratePeaksMD v1

Further detail of work

To test:

If you build the docs you should see the deprecated message.

Also running the algorithm will create the error message "IntegratePeaksMD is deprecated (on 2025-05-05). Use IntegratePeaksMD version 2 instead.". e.g.

LoadEventNexus(Filename=r'TOPAZ_3132_event.nxs',OutputWorkspace='TOPAZ_3132_nxs')
ConvertToDiffractionMDWorkspace(InputWorkspace='TOPAZ_3132_nxs',OutputWorkspace='TOPAZ_3132_md',LorentzCorrection='1')
FindPeaksMD(InputWorkspace='TOPAZ_3132_md',PeakDistanceThreshold='0.15',MaxPeaks='100',OutputWorkspace='peaks')
FindUBUsingFFT(PeaksWorkspace='peaks',MinD='2',MaxD='16')
peaks= IntegratePeaksMD(InputWorkspace='TOPAZ_3132_md', PeaksWorkspace='peaks',
     PeakRadius=0.12, BackgroundOuterRadius=0.2, BackgroundInnerRadius=0.16,
     OutputWorkspace='peaks', Version=1)

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.

@rosswhitfield rosswhitfield marked this pull request as ready for review May 5, 2025 06:36
Copy link
Member

@peterfpeterson peterfpeterson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Version 1 of the algorithm has been deprectated.

@peterfpeterson peterfpeterson added this to the Release 6.13 milestone May 5, 2025
@SilkeSchomann SilkeSchomann self-assigned this May 6, 2025
@SilkeSchomann SilkeSchomann merged commit bc57cb2 into mantidproject:main May 6, 2025
10 checks passed
rosswhitfield added a commit that referenced this pull request May 6, 2025
@rosswhitfield rosswhitfield deleted the deprecate_IntegratePeaksMD_V1 branch May 6, 2025 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants