ProcessBackground.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/Algorithm.h"
#include "MantidAPI/FunctionDomain1D.h"
#include "MantidAPI/FunctionValues.h"
#include "MantidAPI/WorkspaceFactory.h"
#include "MantidCurveFitting/DllConfig.h"
#include "MantidCurveFitting/Functions/BackgroundFunction.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidKernel/ArrayProperty.h"
 
#include <span>
 
namespace Mantid {
namespace CurveFitting {
namespace Functions {
 
class RemovePeaks {
public:
  void setup(const DataObjects::TableWorkspace_sptr &peaktablews);
 
  DataObjects::Workspace2D_sptr removePeaks(const API::MatrixWorkspace_const_sptr &dataws, int wsindex, double numfwhm);
 
private:
  void parsePeakTableWorkspace(const DataObjects::TableWorkspace_sptr &peaktablews, std::vector<double> &vec_peakcentre,
                               std::vector<double> &vec_peakfwhm);
 
  size_t excludePeaks(std::span<double const> v_inX, std::vector<bool> &v_useX, const std::vector<double> &v_centre,
                      const std::vector<double> &v_fwhm, double num_fwhm);
 
  std::vector<double> m_vecPeakCentre;
  std::vector<double> m_vecPeakFWHM;
};
 
class MANTID_CURVEFITTING_DLL ProcessBackground final : public API::Algorithm {
public:
  ProcessBackground();
 
  const std::string category() const override { return "Diffraction\\Utility"; }
 
  const std::string name() const override { return "ProcessBackground"; }
 
  int version() const override { return 1; }
 
  const std::string summary() const override {
    return "ProcessBackground provides some tools to process powder "
           "diffraction pattern's "
           "background in order to help Le Bail Fit.";
  }
 
private:
  void init() override;
 
  void exec() override;
 
  void setupDummyOutputWSes();
 
  void selectBkgdPoints();
 
  void selectFromGivenXValues();
 
  void selectFromGivenFunction();
 
  DataObjects::Workspace2D_sptr autoBackgroundSelection(const DataObjects::Workspace2D_sptr &bkgdWS);
 
  BackgroundFunction_sptr createBackgroundFunction(const std::string &backgroundtype);
 
  DataObjects::Workspace2D_sptr filterForBackground(const BackgroundFunction_sptr &bkgdfunction);
 
  DataObjects::Workspace2D_const_sptr m_dataWS;
  DataObjects::Workspace2D_sptr m_outputWS;
 
  int m_wsIndex;
 
  double m_lowerBound;
  double m_upperBound;
 
  std::string m_bkgdType;
 
  // bool m_doFitBackground;
 
  // double mTolerance;
 
  double m_numFWHM;
 
  void removePeaks();
 
  void deleteRegion();
 
  void addRegion();
 
  void fitBackgroundFunction(const std::string &bkgdfunctiontype);
};
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid