FindPeakBackground.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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/ITableWorkspace.h"
#include "MantidAPI/ParallelAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidHistogramData/Histogram.h"
#include "MantidKernel/cow_ptr.h"
 
namespace Mantid {
 
namespace HistogramData {
class HistogramX;
class HistogramY;
} // namespace HistogramData
 
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL FindPeakBackground : public API::ParallelAlgorithm {
public:
  const std::string name() const override { return "FindPeakBackground"; }
  const std::string summary() const override { return "Separates background from signal for spectra of a workspace."; }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Fit"}; }
 
  const std::string category() const override { return "Utility\\Calculation"; }
 
  void setSigma(const double &sigma);
 
  void setBackgroundOrder(size_t order);
 
  void setFitWindow(const std::vector<double> &window);
 
  void findWindowIndex(const HistogramData::Histogram &histogram, size_t &l0, size_t &n);
 
  int findBackground(const HistogramData::Histogram &histogram, const size_t &l0, const size_t &n,
                     std::vector<size_t> &peak_min_max_indexes, std::vector<double> &bkgd3);
 
private:
  std::string m_backgroundType; //< The type of background to fit
 
  void init() override;
  void exec() override;
  double moment4(MantidVec &X, size_t n, double mean);
  void estimateBackground(const HistogramData::Histogram &histogram, const size_t i_min, const size_t i_max,
                          const size_t p_min, const size_t p_max, const bool hasPeak, double &out_bg0, double &out_bg1,
                          double &out_bg2);
 
  void processInputProperties();
 
  void createOutputWorkspaces();
 
  // Histogram cannot be defined due to lack of default constructor. shared_ptr
  // will do the copy
 
  std::vector<double> m_vecFitWindows;
  size_t m_backgroundOrder;
  double m_sigmaConstant;
  API::ITableWorkspace_sptr m_outPeakTableWS;
  API::MatrixWorkspace_const_sptr m_inputWS;
  size_t m_inputWSIndex;
 
  struct cont_peak {
    size_t start;
    size_t stop;
    double maxY;
  };
  struct by_len {
    bool operator()(cont_peak const &a, cont_peak const &b) { return a.maxY > b.maxY; }
  };
};
 
} // namespace Algorithms
} // namespace Mantid