Improve output name in Container Subtraction algorithm (#41028)

Co-authored-by: Diaz Alvarez <twy67886@NDLT2054LINUX.Home>

Author: adriazalvarez

Framework/PythonInterface/plugins/algorithms/WorkflowAlgorithms/ApplyPaalmanPingsCorrection.py

@@ -9,6 +9,7 @@
 from mantid.api import (
     PythonAlgorithm,
     AlgorithmFactory,
+    AnalysisDataService as ads,
     MatrixWorkspaceProperty,
     WorkspaceGroupProperty,
     PropertyMode,
@@ -147,6 +148,10 @@ def PyExec(self):
         if output_workspace.name():
             RenameWorkspace(InputWorkspace=output_workspace, OutputWorkspace=self.getPropertyValue("OutputWorkspace"))
         self.setProperty("OutputWorkspace", output_workspace)
+
+        # Remove hidden workspaces
+        self._remove_hidden_ws()
+
         prog_wrkflow.report("Algorithm Complete")
 
     def validateInputs(self):
@@ -216,6 +221,7 @@ def _setup(self):
         self._shift_can = self._can_shift_factor != 0.0
 
         self._rebin_container_ws = self.getProperty("RebinCanToSample").value
+        self._hidden_ws_cache = {ws_name for ws_name in ads.getObjectNames() if ws_name.startswith("_")}
 
         if self._use_corrections:
             if self._corrections_workspace.size() == 1:
@@ -339,7 +345,7 @@ def _correct_sample(self, sample_workspace, a_ss_workspace):
         """
         logger.information("Correcting sample")
         correction_in_lambda = self._convert_units_wavelength(a_ss_workspace)
-        corrected = Divide(LHSWorkspace=sample_workspace, RHSWorkspace=correction_in_lambda)
+        corrected = Divide(LHSWorkspace=sample_workspace, RHSWorkspace=correction_in_lambda, OutputWorkspace="__corrected")
         return corrected
 
     def _correct_sample_can(self, sample_workspace, container_workspace, factor_workspaces):
@@ -379,6 +385,11 @@ def _two_factor_corrections_approximation(self, sample_workspace, container_work
         difference = Minus(minuend, subtrahend, OutputWorkspace="__difference")
         return difference
 
+    def _remove_hidden_ws(self):
+        hidden_ws_on_alg_end = {ws_name for ws_name in ads.getObjectNames() if ws_name.startswith("_")}
+        for ws_name in hidden_ws_on_alg_end.difference(self._hidden_ws_cache):
+            ads.remove(ws_name)
+
 
 # Register algorithm with Mantid
 AlgorithmFactory.subscribe(ApplyPaalmanPingsCorrection)

docs/source/release/v6.16.0/Indirect/Bugfixes/39416.rst

@@ -0,0 +1 @@
+- Fix a bug in the :ref:`Container Subtraction <container-subtraction>`  and :ref:`Apply Absorbtion corrections <apply_absorp_correct>` tabs of the :ref:`Corrections <interface-inelastic-corrections>` interface where the output name of the corrected workspace when a container with multiple runs is used contains commas.

qt/scientific_interfaces/Inelastic/Corrections/ApplyAbsorptionCorrections.cpp

@@ -234,17 +234,16 @@ void ApplyAbsorptionCorrections::handleRun() {
 
   const bool useCan = m_uiForm.ckUseCan->isChecked();
   // Get Can and Clone
-  MatrixWorkspace_sptr canClone;
   if (useCan) {
     const auto canName = m_uiForm.dsContainer->getCurrentDataName().toStdString();
     const auto cloneName = "__algorithm_can";
     IAlgorithm_sptr clone = AlgorithmManager::Instance().create("CloneWorkspace");
     clone->initialize();
     clone->setProperty("InputWorkspace", canName);
-    clone->setProperty("Outputworkspace", cloneName);
+    clone->setProperty("OutputWorkspace", cloneName);
     clone->execute();
 
-    canClone = getADSWorkspace(cloneName);
+    MatrixWorkspace_sptr canClone = getADSWorkspace(cloneName);
     // Check for same binning across sample and container
     if (!checkWorkspaceBinningMatches(sampleWs, canClone)) {
       const char *text = "Binning on sample and container does not match."
@@ -281,8 +280,6 @@ void ApplyAbsorptionCorrections::handleRun() {
     applyCorrAlg->setProperty("RebinCanToSample", rebinContainer);
   }
 
-  QString correctionsWsName = m_uiForm.dsCorrections->getCurrentDataName();
-
   bool interpolateAll = false;
   for (std::size_t i = 0; i < m_ppCorrectionsGp->size(); i++) {
     MatrixWorkspace_sptr factorWs = std::dynamic_pointer_cast<MatrixWorkspace>(m_ppCorrectionsGp->getItem(i));
@@ -321,13 +318,25 @@ void ApplyAbsorptionCorrections::handleRun() {
     applyCorrAlg->setProperty("CorrectionsWorkspace", m_correctionsGroupName);
   }
 
-  // Generate output workspace name
-  auto QStrSampleWsName = QString::fromStdString(m_sampleWorkspaceName);
-  int nameCutIndex = QStrSampleWsName.lastIndexOf("_");
-  if (nameCutIndex == -1)
-    nameCutIndex = QStrSampleWsName.length();
+  const auto outputWsName = createOutputName();
+  applyCorrAlg->setProperty("OutputWorkspace", outputWsName);
+
+  // Add corrections algorithm to queue
+  m_batchAlgoRunner->addAlgorithm(applyCorrAlg, std::move(absCorProps));
+
+  // Run algorithm queue
+  connect(m_batchAlgoRunner, &API::BatchAlgorithmRunner::batchComplete, this,
+          &ApplyAbsorptionCorrections::absCorComplete);
+  m_batchAlgoRunner->executeBatchAsync();
+
+  // Set the result workspace for Python script export
+  m_pythonExportWsName = outputWsName;
+}
 
-  QString geometryType;
+std::string ApplyAbsorptionCorrections::createOutputName() const {
+  // Find type of correction prefixes
+  QString correctionsWsName = m_uiForm.dsCorrections->getCurrentDataName();
+  std::string geometryType;
   if (correctionsWsName.contains("FlatPlate")) {
     geometryType = "_flt";
   } else if (correctionsWsName.contains("Annulus")) {
@@ -336,45 +345,21 @@ void ApplyAbsorptionCorrections::handleRun() {
     geometryType = "_cyl";
   }
 
-  QString correctionType;
+  std::string correctionType;
   if (correctionsWsName.contains("PP")) {
     correctionType = "_PP";
   } else if (correctionsWsName.contains("MC")) {
     correctionType = "_MC";
   }
 
-  QString outputWsName = QStrSampleWsName.left(nameCutIndex);
-  outputWsName += geometryType + correctionType + "_Corrected";
-
+  std::string outputName = m_sampleWorkspaceName.substr(0, m_sampleWorkspaceName.find_last_of("_"));
+  outputName += geometryType + correctionType + "_Corrected";
   // Using container
   if (m_uiForm.ckUseCan->isChecked()) {
-    auto const canName = m_uiForm.dsContainer->getCurrentDataName().toStdString();
-    auto const containerWs = getADSWorkspace(canName);
-    auto const &logs = containerWs->run();
-    if (logs.hasProperty("run_number")) {
-      outputWsName += "_" + QString::fromStdString(logs.getProperty("run_number")->value());
-    } else {
-      auto canCutIndex = QString::fromStdString(canName).indexOf("_");
-      outputWsName += "_" + QString::fromStdString(canName).left(canCutIndex);
-    }
+    outputName += "_" + prepareContainerName(m_uiForm.dsContainer->getCurrentDataName().toStdString());
   }
 
-  outputWsName += "_red";
-
-  applyCorrAlg->setProperty("OutputWorkspace", outputWsName.toStdString());
-
-  // Add corrections algorithm to queue
-  m_batchAlgoRunner->addAlgorithm(applyCorrAlg, std::move(absCorProps));
-
-  // Run algorithm queue
-  connect(m_batchAlgoRunner, &API::BatchAlgorithmRunner::batchComplete, this,
-          &ApplyAbsorptionCorrections::absCorComplete);
-  m_batchAlgoRunner->executeBatchAsync();
-
-  // Set the result workspace for Python script export
-  m_pythonExportWsName = outputWsName.toStdString();
-  // m_containerWorkspaceName = m_uiForm.dsContainer->getCurrentDataName();
-  // updateContainer();
+  return outputName + "_red";
 }
 
 /**

qt/scientific_interfaces/Inelastic/Corrections/ApplyAbsorptionCorrections.h

@@ -55,6 +55,7 @@ private slots:
   void plotInPreview(const QString &curveName, Mantid::API::MatrixWorkspace_sptr &ws, const QColor &curveColor);
 
   void setSaveResultEnabled(bool enabled);
+  std::string createOutputName() const;
 
   Ui::ApplyAbsorptionCorrections m_uiForm;
 

qt/scientific_interfaces/Inelastic/Corrections/ContainerSubtraction.cpp

@@ -154,31 +154,9 @@ void ContainerSubtraction::handleRun() {
 }
 
 std::string ContainerSubtraction::createOutputName() {
-  QString QStrContainerWs = QString::fromStdString(m_csContainerWS->getName());
-  auto QStrSampleWs = QString::fromStdString(m_csSampleWS->getName());
-  int sampleNameCutIndex = QStrSampleWs.lastIndexOf("_");
-  if (sampleNameCutIndex == -1)
-    sampleNameCutIndex = QStrSampleWs.length();
-
-  std::string runNum = "";
-  int containerNameCutIndex = 0;
-  if (m_csContainerWS->run().hasProperty("run_number")) {
-    runNum = m_csContainerWS->run().getProperty("run_number")->value();
-  } else {
-    containerNameCutIndex = QStrContainerWs.indexOf("_");
-    if (containerNameCutIndex == -1)
-      containerNameCutIndex = QStrContainerWs.length();
-  }
-
-  QString outputWsName = QStrSampleWs.left(sampleNameCutIndex) + "_Subtract_";
-  if (runNum.compare("") != 0) {
-    outputWsName += QString::fromStdString(runNum);
-  } else {
-    outputWsName += QStrContainerWs.left(containerNameCutIndex);
-  }
-
-  outputWsName += "_red";
-  return outputWsName.toStdString();
+  const auto &sampleName = m_csSampleWS->getName();
+  const auto containerName = prepareContainerName(m_csContainerWS->getName());
+  return sampleName.substr(0, sampleName.find_last_of("_")) + "_Subtract_" + containerName + "_red";
 }
 
 void ContainerSubtraction::loadSettings(const QSettings &settings) {

qt/scientific_interfaces/Inelastic/Corrections/CorrectionsTab.cpp

@@ -9,6 +9,7 @@
 #include "MantidAPI/WorkspaceGroup.h"
 #include "MantidQtWidgets/Common/WorkspaceUtils.h"
 
+#include <MantidAPI/Run.h>
 #include <QSettings>
 
 using namespace Mantid::API;
@@ -143,4 +144,18 @@ void CorrectionsTab::displayInvalidWorkspaceTypeError(const std::string &workspa
   emit showMessageBox(errorMessage);
 }
 
+std::string CorrectionsTab::prepareContainerName(const std::string &containerName) {
+  std::string runNum;
+  const auto containerWs = getADSWorkspace(containerName);
+  if (const auto &logs = containerWs->run(); logs.hasProperty("run_number")) {
+    runNum = logs.getProperty("run_number")->value();
+    if (const auto pos = runNum.find_first_of(","); pos != std::string::npos) {
+      runNum = runNum.substr(0, pos) + "-" + runNum.substr(runNum.find_last_of(",") + 1);
+    }
+  } else {
+    runNum = containerName.substr(0, containerName.find_first_of("_"));
+  }
+  return runNum;
+}
+
 } // namespace MantidQt::CustomInterfaces

qt/scientific_interfaces/Inelastic/Corrections/CorrectionsTab.h

@@ -89,6 +89,7 @@ class MANTIDQT_INELASTIC_DLL CorrectionsTab : public InelasticTab {
                                                  double eFixed = 0.0);
   /// Displays and logs the error for a workspace with an invalid type
   void displayInvalidWorkspaceTypeError(const std::string &workspaceName, Mantid::Kernel::Logger &log);
+  static std::string prepareContainerName(const std::string &containerName);
 
   /// DoubleEditorFactory
   DoubleEditorFactory *m_dblEdFac;