DoublePulseFit.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2020 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
 
#include "MantidAPI/MatrixWorkspace.h"
#include "MantidAPI/MultiDomainFunction.h"
#include "MantidAPI/ParamFunction.h"
#include "MantidCurveFitting/Functions/Convolution.h"
#include "MantidCurveFitting/IFittingAlgorithm.h"
 
namespace Mantid {
 
namespace API {
class FunctionDomain;
class FunctionValues;
class Workspace;
class IFuncMinimizer;
} // namespace API
 
namespace CurveFitting {
namespace Algorithms {
MANTID_CURVEFITTING_DLL Mantid::API::IFunction_sptr
getDoublePulseFunction(std::shared_ptr<const API::IFunction> const &function, double offset, double firstPulseWeight,
                       double secondPulseWeight);
 
MANTID_CURVEFITTING_DLL Mantid::API::IFunction_sptr
getDoublePulseMultiDomainFunction(std::shared_ptr<const API::MultiDomainFunction> const &function, double offset,
                                  double firstPulseWeight, double secondPulseWeight);
 
MANTID_CURVEFITTING_DLL Mantid::API::IFunction_sptr
extractInnerFunction(std::shared_ptr<const Mantid::CurveFitting::Functions::Convolution> const &function);
 
MANTID_CURVEFITTING_DLL Mantid::API::IFunction_sptr
extractInnerFunction(std::shared_ptr<const API::MultiDomainFunction> const &function);
class MANTID_CURVEFITTING_DLL DoublePulseFit : public IFittingAlgorithm {
public:
  DoublePulseFit();
  const std::string name() const override { return "DoublePulseFit"; }
  const std::string summary() const override {
    return "A function to fit muon data from a double pulse source. Wraps Fit.";
  }
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"FitGaussian", "UserFunction1D", "PlotPeakByLogValue", "SplineBackground", "EvaluateFunction", "Fit"};
  }
 
private:
  void initConcrete() override;
  void execConcrete() override;
 
  std::vector<Mantid::API::MatrixWorkspace_sptr> getWorkspaces() const;
  void declareAdditionalProperties();
  void runFitAlgorith(const Mantid::API::IAlgorithm_sptr &fitAlgorithm, const Mantid::API::IFunction_sptr &function,
                      int maxIterations);
  void setOutputProperties();
  void createOutput(const Mantid::API::IAlgorithm_sptr &fitAlg, const Mantid::API::IFunction_sptr &function);
 
  bool m_makeOutput;
  bool m_outputFitData;
  bool m_multiDomain;
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid