StripPeaks.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
 
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidAPI/ParallelAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
 
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL StripPeaks : public API::ParallelAlgorithm {
public:
  const std::string name() const override { return "StripPeaks"; }
  const std::string summary() const override {
    return "This algorithm attempts to find all the peaks in all spectra of a "
           "workspace and subtract them from the data, leaving just the "
           "'background'.";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"FindPeaks", "StripVanadiumPeaks"}; }
  const std::string category() const override {
    return "CorrectionFunctions\\PeakCorrections;Optimization\\PeakFinding";
  }
 
private:
  void init() override;
  void exec() override;
 
  API::ITableWorkspace_sptr findPeaks(const API::MatrixWorkspace_sptr &WS);
  API::MatrixWorkspace_sptr removePeaks(const API::MatrixWorkspace_const_sptr &input,
                                        const API::ITableWorkspace_sptr &peakslist);
  double m_maxChiSq{0.0};
};
 
} // namespace Algorithms
} // namespace Mantid