Fit.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 "MantidCurveFitting/IFittingAlgorithm.h"
 
namespace Mantid {
 
namespace API {
class FunctionDomain;
class FunctionValues;
class Workspace;
class IFuncMinimizer;
} // namespace API
 
namespace CurveFitting {
namespace Algorithms {
class MANTID_CURVEFITTING_DLL Fit : public IFittingAlgorithm {
public:
  Fit();
  const std::string name() const override { return "Fit"; }
  const std::string summary() const override { return "Fits a function to data in a Workspace"; }
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override {
    return {"FitGaussian", "UserFunction1D", "PlotPeakByLogValue", "SplineBackground", "EvaluateFunction"};
  }
 
private:
  void initConcrete() override;
  void execConcrete() override;
  std::map<std::string, std::string> validateInputs() override;
  void readProperties();
  void initializeMinimizer(size_t maxIterations);
  size_t runMinimizer();
  void finalizeMinimizer(size_t nIterations);
  void copyMinimizerOutput(const API::IFuncMinimizer &minimizer);
  void createOutput();
  std::shared_ptr<CostFunctions::CostFuncFitting> m_costFunction;
  std::shared_ptr<API::IFuncMinimizer> m_minimizer;
  size_t m_maxIterations;
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid