Mantid
Loading...
Searching...
No Matches
StripVanadiumPeaks2.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2011 ISIS Rutherford Appleton Laboratory UKRI,
4// NScD Oak Ridge National Laboratory, European Spallation Source,
5// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6// SPDX - License - Identifier: GPL - 3.0 +
7#pragma once
8
10#include "MantidAlgorithms/DllConfig.h"
11
12namespace Mantid {
13namespace Algorithms {
14
20class MANTID_ALGORITHMS_DLL StripVanadiumPeaks2 : public API::SerialDataProcessorAlgorithm {
21public:
23 const std::string name() const override { return "StripVanadiumPeaks"; }
25 int version() const override { return 2; }
26 const std::vector<std::string> seeAlso() const override { return {"FindPeaks", "StripPeaks"}; }
28 const std::string category() const override {
29 return "CorrectionFunctions\\PeakCorrections;Optimization\\PeakFinding;"
30 "Diffraction\\Corrections";
31 }
33 const std::string summary() const override {
34 return "This algorithm removes peaks (at vanadium d-spacing positions by "
35 "default)"
36 " out of a background by linearly/quadratically interpolating over "
37 "the expected peak positions. ";
38 }
39
40private:
41 void init() override;
42 void exec() override;
43};
44
45} // namespace Algorithms
46} // namespace Mantid
Data processor algorithm to be used as a parent to workflow algorithms.
const std::vector< std::string > seeAlso() const override
const std::string category() const override
Algorithm's category for identification.
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
int version() const override
Algorithm's version for identification overriding a virtual method.
const std::string summary() const override
Summary of algorithms purpose.
Helper class which provides the Collimation Length for SANS instruments.