IMWDomainCreator.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/IDomainCreator.h"
#include "MantidCurveFitting/DllConfig.h"
#include "MantidKernel/cow_ptr.h"
 
#include <list>
#include <memory>
#include <utility>
 
namespace Mantid {
namespace API {
class FunctionDomain;
class FunctionDomain1D;
class FunctionValues;
class MatrixWorkspace;
} // namespace API
 
namespace CurveFitting {
 
class MANTID_CURVEFITTING_DLL IMWDomainCreator : public API::IDomainCreator {
public:
  IMWDomainCreator(Kernel::IPropertyManager *fit, const std::string &workspacePropertyName,
                   DomainType domainType = Simple);
  void declareDatasetProperties(const std::string &suffix = "", bool addProp = true) override;
  std::shared_ptr<API::Workspace> createOutputWorkspace(const std::string &baseName, API::IFunction_sptr function,
                                                        std::shared_ptr<API::FunctionDomain> domain,
                                                        std::shared_ptr<API::FunctionValues> values,
                                                        const std::string &outputWorkspacePropertyName) override;
  size_t getDomainSize() const override;
  void initFunction(API::IFunction_sptr function) override;
  void setWorkspace(std::shared_ptr<API::MatrixWorkspace> ws) { m_matrixWorkspace = std::move(ws); }
  void setWorkspaceIndex(size_t wi) { m_workspaceIndex = wi; }
  void setRange(double startX, double endX) {
    m_startX = startX;
    m_endX = endX;
  }
 
protected:
  std::pair<size_t, size_t> getXInterval() const;
  virtual void setParameters() const;
 
  std::shared_ptr<API::MatrixWorkspace> createEmptyResultWS(const size_t nhistograms, const size_t nyvalues);
  void setInitialValues(API::IFunction &function);
  // Unrolls function into its constituent parts if it is a composite and adds
  // it to the list. Note this is recursive
  void appendCompositeFunctionMembers(std::list<API::IFunction_sptr> &functionList,
                                      const API::IFunction_sptr &function) const;
  // Create separate Convolutions for each component of the model of a
  // convolution
  void appendConvolvedCompositeFunctionMembers(std::list<API::IFunction_sptr> &functionList,
                                               const API::IFunction_sptr &function) const;
  void addFunctionValuesToWS(const API::IFunction_sptr &function, std::shared_ptr<API::MatrixWorkspace> &ws,
                             const size_t wsIndex, const std::shared_ptr<API::FunctionDomain> &domain,
                             const std::shared_ptr<API::FunctionValues> &resultValues) const;
 
  std::string m_workspacePropertyName;
  std::string m_workspaceIndexPropertyName;
  std::string m_startXPropertyName;
  std::string m_endXPropertyName;
 
  mutable std::shared_ptr<API::MatrixWorkspace> m_matrixWorkspace;
  mutable size_t m_workspaceIndex;
  mutable double m_startX;
  mutable double m_endX;
  mutable std::weak_ptr<API::FunctionDomain1D> m_domain;
  mutable std::weak_ptr<API::FunctionValues> m_values;
  size_t m_startIndex;
};
 
} // namespace CurveFitting
} // namespace Mantid