Mantid
Loading...
Searching...
No Matches
EstimatePeakIntensities.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2026 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
12#include <map>
13#include <string>
14#include <vector>
15
16namespace Mantid::Algorithms {
17
29class MANTID_ALGORITHMS_DLL EstimatePeakIntensities : public API::Algorithm {
30public:
31 const std::string name() const override { return "EstimatePeakIntensities"; }
32 int version() const override { return 1; }
33 const std::string category() const override { return "Optimization\\PeakFinding"; }
34 const std::string summary() const override {
35 return "Fit-independent per-spectrum estimate of a peak's background and integrated intensity over a window.";
36 }
37 const std::vector<std::string> seeAlso() const override { return {"FitPeaks", "FindPeakBackground"}; }
38
39private:
40 void init() override;
41 void exec() override;
42 std::map<std::string, std::string> validateInputs() override;
43};
44
45} // namespace Mantid::Algorithms
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
EstimatePeakIntensities : fit-independent, per-spectrum estimate of a peak's background and integrate...
int version() const override
function to return a version of the algorithm, must be overridden in all algorithms
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
const std::string category() const override
function to return a category of the algorithm.
const std::string summary() const override
function returns a summary message that will be displayed in the default GUI, and in the help.
const std::string name() const override
function to return a name of the algorithm, must be overridden in all algorithms