Deprecate UnwrapSNS (#39097)

* deprecate algorithm UnwrapSNS

* deprecate AlignAndFocusPowder property UnwrapRef

* deprecate AlignAndFocusPowderFromFiles property UnwrapRef

* deprecate SNSPowderReduction property UnwrapRef

* update AlignAndFocusPowder docs

* remove deprecated parameter UnwrapRef from the Powder Diffraction Reduction Interface

* add release notes

* remove unused field

* Update docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39097.rst

Co-authored-by: Pete Peterson <petersonpf@ornl.gov>

---------

Co-authored-by: Pete Peterson <petersonpf@ornl.gov>

Author: backmari

Framework/Algorithms/inc/MantidAlgorithms/UnwrapSNS.h

@@ -10,6 +10,7 @@
 // Includes
 //----------------------------------------------------------------------
 #include "MantidAPI/Algorithm.h"
+#include "MantidAPI/DeprecatedAlgorithm.h"
 #include "MantidAlgorithms/DllConfig.h"
 #include "MantidDataObjects/EventWorkspace.h"
 
@@ -31,7 +32,7 @@ namespace Algorithms {
     @author Russell Taylor, Tessella Support Services plc
     @date 25/07/2008
 */
-class MANTID_ALGORITHMS_DLL UnwrapSNS final : public API::Algorithm {
+class MANTID_ALGORITHMS_DLL UnwrapSNS final : public API::Algorithm, public API::DeprecatedAlgorithm {
 public:
   UnwrapSNS();
   ~UnwrapSNS() override = default;

Framework/Algorithms/src/UnwrapSNS.cpp

@@ -32,7 +32,9 @@ using std::size_t;
 /// Default constructor
 UnwrapSNS::UnwrapSNS()
     : m_conversionConstant(0.), m_inputWS(), m_inputEvWS(), m_LRef(0.), m_Tmin(0.), m_Tmax(0.), m_frameWidth(0.),
-      m_numberOfSpectra(0), m_XSize(0) {}
+      m_numberOfSpectra(0), m_XSize(0) {
+  deprecatedDate("2025-03-24");
+}
 
 /// Initialisation method
 void UnwrapSNS::init() {

Framework/PythonInterface/plugins/algorithms/AlignAndFocusPowderFromFiles.py

@@ -195,6 +195,8 @@ def validateInputs(self):
         if (not self.getProperty("LogAllowList").isDefault) and (not self.getProperty("LogBlockList").isDefault):
             errors["LogAllowList"] = "Cannot specify with LogBlockList"
             errors["LogBlockList"] = "Cannot specify with LogAllowList"
+        if not self.getProperty("UnwrapRef").isDefault:
+            errors["UnwrapRef"] = "AlignAndFocusPowderFromFiles property UnwrapRef is deprecated since 2025-03-24."
 
         return errors
 

Framework/PythonInterface/plugins/algorithms/SNSPowderReduction.py

@@ -136,7 +136,6 @@ class SNSPowderReduction(DataProcessorAlgorithm):
     _instrument = None
     _filterBadPulses = None
     _removePromptPulseWidth = None
-    _LRef = None
     _DIFCref = None
     _wavelengthMin = None
     _wavelengthMax = None
@@ -392,6 +391,10 @@ def validateInputs(self):
 
         if self.getProperty("InterpolateTargetTemp").value > 0.0 and not len(self.getProperty("BackgroundNumber").value) == 2:
             issues["InterpolateTargetTemp"] = "If InterpolateTargetTemp specified, you must provide two background run numbers"
+
+        # Deprecated properties
+        if not self.getProperty("UnwrapRef").isDefault:
+            issues["UnwrapRef"] = "SNSPowderReduction property UnwrapRef is deprecated since 2025-03-24."
         return issues
 
     # pylint: disable=too-many-locals,too-many-branches,too-many-statements
@@ -413,7 +416,6 @@ def PyExec(self):  # noqa
         self._filterBadPulses = self.getProperty("FilterBadPulses").value
         self._removePromptPulseWidth = self.getProperty("RemovePromptPulseWidth").value
         self._lorentz = self.getProperty("LorentzCorrection").value
-        self._LRef = self.getProperty("UnwrapRef").value
         self._DIFCref = self.getProperty("LowResRef").value
         self._wavelengthMin = self.getProperty("CropWavelengthMin").value
         self._wavelengthMax = self.getProperty("CropWavelengthMax").value
@@ -944,7 +946,6 @@ def _focusAndSum(self, filenames, preserveEvents=True, final_name=None, absorpti
             CompressTolerance=self.COMPRESS_TOL_TOF,
             CompressBinningMode=self._compressBinningMode,
             LorentzCorrection=self._lorentz,
-            UnwrapRef=self._LRef,
             LowResRef=self._DIFCref,
             LowResSpectrumOffset=self._lowResTOFoffset,
             CropWavelengthMin=self._wavelengthMin,
@@ -1060,7 +1061,6 @@ def _focusChunks(self, filename, filter_wall=(0.0, 0.0), splitwksp=None, preserv
                     CompressTolerance=self.COMPRESS_TOL_TOF,
                     CompressBinningMode=self._compressBinningMode,
                     LorentzCorrection=self._lorentz,
-                    UnwrapRef=self._LRef,
                     LowResRef=self._DIFCref,
                     LowResSpectrumOffset=self._lowResTOFoffset,
                     CropWavelengthMin=self._wavelengthMin,

Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/AlignAndFocusPowder.h

@@ -97,7 +97,6 @@ class DLLExport AlignAndFocusPowder : public API::DataProcessorAlgorithm {
   bool binInDspace{false};
   double xmin{0.0};
   double xmax{0.0};
-  double LRef{0.0};
   double DIFCref{0.0};
   double minwl{0.0};
   double maxwl{0.0};

Framework/WorkflowAlgorithms/src/AlignAndFocusPowder.cpp

@@ -215,9 +215,7 @@ void AlignAndFocusPowder::init() {
                   "Multiply each spectrum by "
                   "sin(theta) where theta is "
                   "half of the Bragg angle");
-  declareProperty(PropertyNames::UNWRAP_REF, 0.,
-                  "Reference total flight path for frame "
-                  "unwrapping. Zero skips the correction");
+  declareProperty(PropertyNames::UNWRAP_REF, 0., "This property is deprecated (since v6.13).");
   declareProperty(PropertyNames::LOWRES_REF, 0., "Reference DIFC for resolution removal. Zero skips the correction");
   declareProperty("CropWavelengthMin", 0., "Crop the data at this minimum wavelength. Overrides LowResRef.");
   mapPropertyName(PropertyNames::WL_MIN, "wavelength_min");
@@ -294,6 +292,11 @@ std::map<std::string, std::string> AlignAndFocusPowder::validateInputs() {
         "Must have same number of values as " + PropertyNames::RESONANCE_LOWER_LIMITS;
   }
 
+  // Deprecated properties
+  if (!isDefault(PropertyNames::UNWRAP_REF)) {
+    g_log.error("AlignAndFocusPowder property UnwrapRef is deprecated since 2025-03-24.");
+  }
+
   return result;
 }
 
@@ -378,7 +381,6 @@ void AlignAndFocusPowder::exec() {
   auto dmin = getVecPropertyFromPmOrSelf(PropertyNames::D_MINS, m_dmins);
   auto dmax = getVecPropertyFromPmOrSelf(PropertyNames::D_MAXS, m_dmaxs);
   this->getVecPropertyFromPmOrSelf(PropertyNames::RAGGED_DELTA, m_delta_ragged);
-  LRef = getProperty(PropertyNames::UNWRAP_REF);
   DIFCref = getProperty(PropertyNames::LOWRES_REF);
   const bool applyLorentz = getProperty(PropertyNames::LORENTZ);
   minwl = getProperty(PropertyNames::WL_MIN);
@@ -491,7 +493,7 @@ void AlignAndFocusPowder::exec() {
   }
 
   // set up a progress bar with the "correct" number of steps
-  m_progress = std::make_unique<Progress>(this, 0., 1., 22);
+  m_progress = std::make_unique<Progress>(this, 0., 1., 21);
 
   if (m_maskWS) {
     g_log.information() << "running MaskDetectors started at " << Types::Core::DateAndTime::getCurrentTime() << "\n";
@@ -651,26 +653,6 @@ void AlignAndFocusPowder::exec() {
   m_progress->report();
 
   // Beyond this point, low resolution TOF workspace is considered.
-  if (LRef > 0.) {
-    // this algorithm was originally created for POWGEN before issues in the DAS were fixed
-    // it is not used in any current reduction and remains for legacy data processing
-    m_outputW = convertUnits(m_outputW, "TOF");
-
-    g_log.information() << "running UnwrapSNS(LRef=" << LRef << ",Tmin=" << tmin << ",Tmax=" << tmax << ") started at "
-                        << Types::Core::DateAndTime::getCurrentTime() << "\n";
-    API::IAlgorithm_sptr removeAlg = createChildAlgorithm("UnwrapSNS");
-    removeAlg->setProperty("InputWorkspace", m_outputW);
-    removeAlg->setProperty("OutputWorkspace", m_outputW);
-    removeAlg->setProperty("LRef", LRef);
-    if (tmin > 0.)
-      removeAlg->setProperty("Tmin", tmin);
-    if (tmax > tmin)
-      removeAlg->setProperty("Tmax", tmax);
-    removeAlg->executeAsChildAlg();
-    m_outputW = removeAlg->getProperty("OutputWorkspace");
-  }
-  m_progress->report();
-
   if (minwl > 0. || (!isEmpty(maxwl))) { // just crop the workspace
     // turn off the low res stuff
     m_processLowResTOF = false;
@@ -735,7 +717,7 @@ void AlignAndFocusPowder::exec() {
   m_progress->report();
 
   // Convert units
-  if (LRef > 0. || minwl > 0. || DIFCref > 0. || (!isEmpty(maxwl))) {
+  if (minwl > 0. || DIFCref > 0. || (!isEmpty(maxwl))) {
     m_outputW = convertUnits(m_outputW, "dSpacing");
     if (m_processLowResTOF)
       m_lowResW = convertUnits(m_lowResW, "dSpacing");

docs/source/algorithms/AlignAndFocusPowder-v1.rst

@@ -32,7 +32,6 @@ The way that algorithms are connected together is better described in the workfl
 - :ref:`algm-RemoveLowResTOF` ``CropWavelengthMin`` and ``CropWavelengthMax`` are prefered
 - :ref:`algm-RemovePromptPulse`
 - :ref:`algm-SortEvents` (event workspace only)
-- :ref:`algm-UnwrapSNS`
 
 
 

docs/source/diagrams/AlignAndFocusPowder-v1_wkflw.dot

@@ -13,7 +13,6 @@ digraph AlignAndFocusPowder {
     MaskBinTable
     CalibrationWorkspace
     GroupingWorkspace
-    UnwrapRef
     LowResRef
     params1 [label="Params"]
     params2 [label="Params"]
@@ -25,7 +24,6 @@ digraph AlignAndFocusPowder {
     clearDiffCal      [label="ApplyDiffCal v1\nClear parameters"]
     compressEvents    [label="CompressEvents v1"]
     compressEvents2   [label="CompressEvents v1"]
-    convertUnitsTof1     [label="ConvertUnits v1\nTime-of-Flight"]
     convertUnitsTof2     [label="ConvertUnits v1\nTime-of-Flight"]
     convertUnitsD1     [label="ConvertUnits v1\nd-spacing"]
     convertUnitsD2     [label="ConvertUnits v1\nd-spacing"]
@@ -46,7 +44,6 @@ digraph AlignAndFocusPowder {
     rebinRagged       [label="RebinRagged v1"]
     removeLowResTOF   [label="RemoveLowResTOF v1"]
     removePromptPulse [label="RemovePromptPulse v1"]
-    unwrapSNS         [label="UnwrapSNS v1"]
   }
 
   subgraph decisions {
@@ -58,7 +55,6 @@ digraph AlignAndFocusPowder {
     isDspace1         [label="Is d-space binning?"]
     isDspace2         [label="Is d-space binning?"]
     isDspace3         [label="Is d-space binning?"]
-    ifLref          [label="LRef specified?"]
     ifDIFCref          [label="DIFCref specified?"]
     ifRaggedTof       [label="ragged rebin\nand tof binning"]
   }
@@ -98,26 +94,19 @@ digraph AlignAndFocusPowder {
   maskBins               -> convertUnitsD3
   convertUnitsD3          -> lorentz
 
-  lorentz                -> ifLref
+  lorentz                -> ifDIFCref
 
-  ifLref               -> convertUnitsWL2            [label="No"]
-  cropWorkspaceWL        -> convertUnitsD1
-
-  convertUnitsD1          -> isDspace2
-
-  ifLref               -> convertUnitsTof1        [label="Yes"]
-  convertUnitsTof1          -> unwrapSNS
-  UnwrapRef              -> unwrapSNS
-  unwrapSNS              -> convertUnitsWL2
-  convertUnitsWL2 -> ifDIFCref
-
-
-  ifDIFCref -> cropWorkspaceWL  [label="No"]
+  ifDIFCref -> convertUnitsWL2  [label="No"]
   ifDIFCref -> removeLowResTOF  [label="Yes"]
 
   LowResRef              -> removeLowResTOF
   removeLowResTOF        -> convertUnitsD1
 
+  convertUnitsWL2        -> cropWorkspaceWL
+  cropWorkspaceWL        -> convertUnitsD1
+
+  convertUnitsD1          -> isDspace2
+
   isDspace2              -> diffFocus            [label="No"]
   isDspace2              -> rebin2               [label="Yes"]
   params2                -> rebin2

docs/source/release/v6.13.0/Framework/Algorithms/Deprecated/39097.rst

@@ -0,0 +1,6 @@
+- :ref:`UnwrapSNS <algm-UnwrapSNS>` has been deprecated. There is no replacement.
+- Property ``UnwrapRef`` has been deprecated for algorithms that previously
+  called deprecated algorithm :ref:`UnwrapSNS <algm-UnwrapSNS>`:
+  :ref:`AlignAndFocusPowder <algm-AlignAndFocusPowder>`,
+  :ref:`AlignAndFocusPowderFromFiles <algm-AlignAndFocusPowderFromFiles>`
+  and :ref:`SNSPowderReduction <algm-SNSPowderReduction>`.

docs/source/release/v6.13.0/Workbench/New_features/39097.rst

@@ -0,0 +1,2 @@
+- Deprecated parameter ``Unwrap Ref`` has been removed from the Powder
+  Diffraction Reduction Interface.