SplineInterpolation.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2013 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/Algorithm.h"
#include "MantidCurveFitting/Functions/CubicSpline.h"
#include "MantidKernel/System.h"
 
namespace Mantid {
namespace CurveFitting {
namespace Algorithms {
 
class MANTID_CURVEFITTING_DLL SplineInterpolation final : public API::Algorithm {
public:
  SplineInterpolation();
 
  const std::string name() const override;
  int version() const override;
  const std::vector<std::string> seeAlso() const override { return {"Fit", "SplineBackground", "SplineSmoothing"}; }
  const std::string category() const override;
  const std::string summary() const override;
  std::map<std::string, std::string> validateInputs() override;
 
private:
  void init() override;
  void exec() override;
 
  std::shared_ptr<Functions::CubicSpline> m_cspline;
 
  API::MatrixWorkspace_sptr setupOutputWorkspace(const API::MatrixWorkspace_sptr &mws,
                                                 const API::MatrixWorkspace_sptr &iws) const;
 
  API::MatrixWorkspace_sptr convertBinnedData(API::MatrixWorkspace_sptr workspace);
 
  void setInterpolationPoints(const API::MatrixWorkspace_const_sptr &inputWorkspace, const size_t row) const;
 
  void calculateSpline(const API::MatrixWorkspace_const_sptr &inputWorkspace,
                       const API::MatrixWorkspace_sptr &outputWorkspace, const size_t row) const;
 
  void calculateDerivatives(const API::MatrixWorkspace_const_sptr &inputWorkspace,
                            const API::MatrixWorkspace_sptr &outputWorkspace, const size_t order) const;
 
  std::pair<size_t, size_t> findInterpolationRange(const API::MatrixWorkspace_const_sptr &iwspt,
                                                   const API::MatrixWorkspace_sptr &mwspt, const size_t row);
 
  void extrapolateFlat(const API::MatrixWorkspace_sptr &ows, const API::MatrixWorkspace_const_sptr &iwspt,
                       const size_t row, const std::pair<size_t, size_t> &indices, const bool doDerivs,
                       std::vector<API::MatrixWorkspace_sptr> &derivs) const;
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid