Mantid
Loading...
Searching...
No Matches
FFTSmooth2.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2008 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
11#include "MantidAlgorithms/DllConfig.h"
12
13namespace Mantid {
14namespace Algorithms {
15namespace FFTSmooth {
21class MANTID_ALGORITHMS_DLL FFTSmooth2 : public API::Algorithm {
22public:
24 const std::string name() const override { return "FFTSmooth"; }
26 const std::string summary() const override { return "Performs smoothing of a spectrum using various filters."; }
27
29 int version() const override { return 2; }
30 const std::vector<std::string> seeAlso() const override { return {"FFT", "WienerSmooth"}; }
32 const std::string category() const override { return "Arithmetic\\FFT;Transforms\\Smoothing"; }
33
34private:
35 // Overridden Algorithm methods
36 void init() override;
37 std::map<std::string, std::string> validateInputs() override;
38 std::map<std::string, std::string> actuallyValidateInputs(API::Workspace_sptr const &);
39 void exec() override;
40};
41
42namespace PropertyNames {
43inline std::string const INPUT_WKSP("InputWorkspace");
44inline std::string const OUTPUT_WKSP("OutputWorkspace");
45inline std::string const WKSP_INDEX("WorkspaceIndex");
46inline std::string const FILTER("Filter");
47inline std::string const PARAMS("Params");
48inline std::string const IGNORE_X_BINS("IgnoreXBins");
49inline std::string const ALL_SPECTRA("AllSpectra");
50} // namespace PropertyNames
51
52} // namespace FFTSmooth
53} // namespace Algorithms
54} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition Algorithm.h:76
Data smoothing using the FFT algorithm and various filters.
Definition FFTSmooth2.h:21
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition FFTSmooth2.h:32
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition FFTSmooth2.h:24
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition FFTSmooth2.h:30
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition FFTSmooth2.h:29
const std::string summary() const override
Summary of algorithms purpose.
Definition FFTSmooth2.h:26
Data smoothing using the FFT algorithm and various filters.
Definition FFTSmooth.h:24
std::shared_ptr< Workspace > Workspace_sptr
shared pointer to Mantid::API::Workspace
std::string const OUTPUT_WKSP("OutputWorkspace")
std::string const INPUT_WKSP("InputWorkspace")
std::string const IGNORE_X_BINS("IgnoreXBins")
std::string const ALL_SPECTRA("AllSpectra")
std::string const WKSP_INDEX("WorkspaceIndex")
Helper class which provides the Collimation Length for SANS instruments.