EvaluateFunction.cpp

Go to the documentation of this file.

// 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 +
#include "MantidCurveFitting/Algorithms/EvaluateFunction.h"
#include "MantidAPI/IFunction.h"
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/Workspace.h"
 
namespace Mantid::CurveFitting::Algorithms {
 
using namespace Mantid::Kernel;
using namespace Mantid::API;
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(EvaluateFunction)
 
//----------------------------------------------------------------------------------------------
 
 
const std::string EvaluateFunction::name() const { return "EvaluateFunction"; }
 
int EvaluateFunction::version() const { return 1; }
 
const std::string EvaluateFunction::summary() const { return "Evaluate a function on a workspace."; }
 
//----------------------------------------------------------------------------------------------
void EvaluateFunction::initConcrete() {
  declareProperty(std::make_unique<WorkspaceProperty<API::Workspace>>("OutputWorkspace", "", Direction::Output),
                  "An output workspace.");
}
 
//----------------------------------------------------------------------------------------------
void EvaluateFunction::execConcrete() {
 
  // Function may need some preparation.
  m_function->setUpForFit();
 
  API::FunctionDomain_sptr domain;
  API::FunctionValues_sptr values;
  m_domainCreator->createDomain(domain, values);
 
  // Do something with the function which may depend on workspace.
  m_domainCreator->initFunction(m_function);
 
  // Apply any ties.
  m_function->applyTies();
 
  // Calculate function values.
  m_function->function(*domain, *values);
 
  // Gnegerate the output workspace
  auto outputWS = m_domainCreator->createOutputWorkspace("", m_function, domain, values, "");
 
  // Store the result.
  setProperty("OutputWorkspace", outputWS);
}
 
} // namespace Mantid::CurveFitting::Algorithms