SplineBackground.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 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/Algorithm.h"
#include "MantidAPI/Workspace_fwd.h"
#include "MantidCurveFitting/DllConfig.h"
 
#include <gsl/gsl_bspline.h>
#include <gsl/gsl_multifit.h>
#include <gsl/gsl_statistics.h>
 
namespace Mantid {
namespace CurveFitting {
namespace Algorithms {
 
class MANTID_CURVEFITTING_DLL SplineBackground final : public API::Algorithm {
public:
  const std::string name() const override { return "SplineBackground"; }
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Fit", "SplineInterpolation", "SplineSmoothing"}; }
  const std::string category() const override { return "Optimization;CorrectionFunctions\\BackgroundCorrections"; }
  const std::string summary() const override { return "Fit spectra background using b-splines."; }
 
private:
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  void addWsDataToSpline(const API::MatrixWorkspace *ws, const size_t specNum, int expectedNumBins);
 
  void allocateBSplinePointers(int numBins, int ncoeffs);
 
  double calculateBinWeight(double errValue);
 
  void freeBSplinePointers();
 
  size_t calculateNumBinsToProcess(const API::MatrixWorkspace *ws);
 
  API::MatrixWorkspace_sptr saveSplineOutput(const API::MatrixWorkspace_sptr &ws, const size_t spec);
 
  void setupSpline(double xMin, double xMax, int numBins, int ncoeff);
 
  struct bSplinePointers {
    gsl_bspline_workspace *splineToProcess{nullptr};
    gsl_vector *inputSplineWs{nullptr};
    gsl_vector *xData{nullptr}, *yData{nullptr};
    gsl_vector *coefficients{nullptr}, *binWeights{nullptr};
    gsl_matrix *fittedWs{nullptr}, *covariance{nullptr};
    gsl_multifit_linear_workspace *weightedLinearFitWs{nullptr};
  };
 
  bSplinePointers m_splinePointers{};
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid