ConvolveWorkspaces.cpp

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidCurveFitting/Algorithms/ConvolveWorkspaces.h"
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidCurveFitting/Functions/Convolution.h"
#include "MantidCurveFitting/Functions/TabulatedFunction.h"

#include <gsl/gsl_errno.h>
#include <gsl/gsl_fft_halfcomplex.h>
#include <gsl/gsl_fft_real.h>

#include <sstream>

namespace Mantid {
namespace CurveFitting {
namespace Algorithms {

// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(ConvolveWorkspaces)

using namespace Kernel;
using namespace API;
using namespace DataObjects;
using namespace Geometry;
using namespace Functions;

void ConvolveWorkspaces::init() {
  declareProperty(std::make_unique<WorkspaceProperty<Workspace2D>>(
                      "Workspace1", "", Direction::Input),
                  "The name of the first input workspace.");
  declareProperty(std::make_unique<WorkspaceProperty<Workspace2D>>(
                      "Workspace2", "", Direction::Input),
                  "The name of the second input workspace.");

  declareProperty(std::make_unique<WorkspaceProperty<Workspace2D>>(
                      "OutputWorkspace", "", Direction::Output),
                  "The name of the output workspace.");
}

void ConvolveWorkspaces::exec() {
  std::string ws1name = getProperty("Workspace1");
  std::string ws2name = getProperty("Workspace2");
  Workspace2D_sptr ws1 = getProperty("Workspace1");
  Workspace2D_sptr ws2 = getProperty("Workspace2");

  // Cache a few things for later use
  const size_t numHists = ws1->getNumberHistograms();
  Workspace2D_sptr outputWS = std::dynamic_pointer_cast<Workspace2D>(
      WorkspaceFactory::Instance().create(ws1));

  // First check that the workspace are the same size
  if (numHists != ws2->getNumberHistograms()) {
    throw std::runtime_error("Size mismatch");
  }

  m_progress = std::make_unique<Progress>(this, 0.0, 1.0, numHists);
  // Now convolve the histograms
  PARALLEL_FOR_IF(Kernel::threadSafe(*ws1, *ws2, *outputWS))
  for (int i = 0; i < static_cast<int>(numHists); ++i) {
    PARALLEL_START_INTERUPT_REGION
    m_progress->report();
    outputWS->setSharedX(i, ws1->sharedX(i));
    auto &Yout = outputWS->mutableY(i);
    Convolution conv;

    auto res = std::make_shared<TabulatedFunction>();
    res->setAttributeValue("Workspace", ws1name);
    res->setAttributeValue("WorkspaceIndex", i);

    conv.addFunction(res);

    auto fun = std::make_shared<TabulatedFunction>();
    fun->setAttributeValue("Workspace", ws2name);
    fun->setAttributeValue("WorkspaceIndex", i);

    conv.addFunction(fun);
    size_t N = Yout.size();
    const double *firstX = &outputWS->mutableX(i)[0];
    FunctionDomain1DView xView(firstX, N);
    FunctionValues out(xView);
    conv.function(xView, out);

    for (size_t j = 0; j < N; j++) {
      Yout[j] = out.getCalculated(j);
    }
    PARALLEL_END_INTERUPT_REGION
  }
  PARALLEL_CHECK_INTERUPT_REGION
  // Assign it to the output workspace property
  setProperty("OutputWorkspace", outputWS);
}

} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid