Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate IntegratePeakTimeSlices #38133

Merged
merged 1 commit into from
Oct 4, 2024

Conversation

KyleQianliMa
Copy link
Contributor

@KyleQianliMa KyleQianliMa commented Oct 2, 2024

Description of work

Deprecate the IntegreatePeakTimeSlices function.
story 7438

Summary of work

Further detail of work

To test:

Load a SCD data set from systemtests Data and find the peaks

TOPAZ_3132_event.nxs is located in mantid/Testing/Data/SystemTest

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')
IndexPeaks(PeaksWorkspace='peaks')
peak0,int,sig = IntegratePeakTimeSlices(InputWorkspace='TOPAZ_3132_nxs', Peaks='peaks', Intensity=4580.8587719746683, SigmaIntensity=190.21154129339735)
print("Intensity and SigmaIntensity of peak 0  = {} {}".format(int, sig))

This code should produce a message that indicate IntegreatePeakTimeSlices has been deprecated.


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.

@KyleQianliMa KyleQianliMa force-pushed the deprecate_IntegratePeakTimeSlices branch 6 times, most recently from cd1dc07 to 8fe4a81 Compare October 3, 2024 14:21
added release note

cppcheck

fix cppcheck line numbers

cpp check line number edit

remove 'public'

updated time
@KyleQianliMa KyleQianliMa force-pushed the deprecate_IntegratePeakTimeSlices branch from 8fe4a81 to 205ff81 Compare October 3, 2024 14:23
@KyleQianliMa KyleQianliMa added the ORNL Team Issues and pull requests managed by the ORNL development team label Oct 4, 2024
@KyleQianliMa KyleQianliMa added this to the Release 6.12 milestone Oct 4, 2024
@SilkeSchomann SilkeSchomann self-assigned this Oct 4, 2024
@SilkeSchomann SilkeSchomann merged commit 53b8e49 into main Oct 4, 2024
10 checks passed
@SilkeSchomann SilkeSchomann deleted the deprecate_IntegratePeakTimeSlices branch October 4, 2024 06:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ORNL Team Issues and pull requests managed by the ORNL development team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants