Merge pull request #32508 from mantidproject/spec117_deprecate_v620_ornl

Merged as #32500 has been approved and merged.

Framework/Algorithms/inc/MantidAlgorithms/GetDetOffsetsMultiPeaks.h

@@ -7,6 +7,7 @@
 #pragma once
 
 #include "MantidAPI/Algorithm.h"
+#include "MantidAPI/DeprecatedAlgorithm.h"
 #include "MantidAPI/MatrixWorkspace_fwd.h"
 #include "MantidAlgorithms/DllConfig.h"
 #include "MantidDataObjects/EventWorkspace.h"
@@ -46,7 +47,7 @@ struct FitPeakOffsetResult {
  @author Vickie Lynch, SNS
  @date 12/12/2011
  */
-class MANTID_ALGORITHMS_DLL GetDetOffsetsMultiPeaks : public API::Algorithm {
+class MANTID_ALGORITHMS_DLL GetDetOffsetsMultiPeaks : public API::Algorithm, public API::DeprecatedAlgorithm {
 public:
   /// Default constructorMatrix
   GetDetOffsetsMultiPeaks();

Framework/PythonInterface/plugins/algorithms/CalibrateRectangularDetectors.py

@@ -15,6 +15,9 @@ from mantid.kernel import Direction
 COMPRESS_TOL_TOF = .01
 EXTENSIONS_NXS = ["_event.nxs", ".nxs.h5"]
 
+DEPRECATION_NOTICE = """CalibrateRectangularDetectors is deprecated from v6.2.0.
+Instead, use PDCalibration."""
+
 
 def getBasename(filename):
     name = os.path.split(filename)[-1]
@@ -54,7 +57,7 @@ class CalibrateRectangularDetectors(PythonAlgorithm):
     _binning = None
 
     def category(self):
-        return "Diffraction\\Calibration"
+        return "Diffraction\\Calibration;Deprecated"
 
     def seeAlso(self):
         return [ "GetDetectorOffsets" ]
@@ -62,8 +65,11 @@ class CalibrateRectangularDetectors(PythonAlgorithm):
     def name(self):
         return "CalibrateRectangularDetectors"
 
+    # def summary(self):
+    #     return "Calibrate the detector pixels and write a calibration file"
+    @classmethod
     def summary(self):
-        return "Calibrate the detector pixels and write a calibration file"
+        return DEPRECATION_NOTICE
 
     def PyInit(self):
         self.declareProperty(MultipleFileProperty(name="RunNumber",
@@ -423,6 +429,10 @@ class CalibrateRectangularDetectors(PythonAlgorithm):
 
     #pylint: disable=too-many-branches
     def PyExec(self):
+
+        # Exit with deprecation notice
+        self.log().error(DEPRECATION_NOTICE)
+
         # get generic information
         self._binning = self.getProperty("Binning").value
         if len(self._binning) != 1 and len(self._binning) != 3:

Testing/SystemTests/tests/framework/SphinxWarnings.py

@@ -22,6 +22,7 @@ class SphinxWarnings(systemtesting.MantidSystemTest):
                                 'CorrectionFunctions',
                                 'Crystal',
                                 'DataHandling',
+                                'Deprecated',
                                 'Diagnostics',
                                 'Diffraction',
                                 'Events',

docs/source/release/v6.2.0/diffraction.rst

@@ -53,6 +53,13 @@ Bugfixes
 - Fixed a bug when converting TOF to d-spacing using diffractometer constants with non-zero DIFA when a parabolic model is selected.
 - Corrected the equation for pseudo-voigt FWHM and mixing parameter in peak profile function :ref:`Bk2BkExpConvPV <func-Bk2BkExpConvPV>`.
 
+
+Deprecation
+###########
+- Existing :ref:`CalibrateRectangularDetectors <algm-CalibrateRectangularDetectors>` is deprecated.
+- Existing :ref:`GetDetOffsetsMultiPeaks <algm-GetDetOffsetsMultiPeaks>` is deprecated.
+
+
 Engineering Diffraction
 -----------------------
 New features