Mantid
Loading...
Searching...
No Matches
FFTSmooth.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
9//----------------------------------------------------------------------
10// Includes
11//----------------------------------------------------------------------
12#include "MantidAPI/Algorithm.h"
15#include "MantidAlgorithms/DllConfig.h"
16
17namespace Mantid {
18namespace Algorithms {
24class MANTID_ALGORITHMS_DLL FFTSmooth final : public API::Algorithm, public API::DeprecatedAlgorithm {
25public:
27 FFTSmooth() { this->useAlgorithm("FFTSmooth", 2); }
29 const std::string name() const override { return "FFTSmooth"; }
31 const std::string summary() const override { return "Performs smoothing of a spectrum using various filters."; }
32
34 int version() const override { return 1; }
36 const std::string category() const override { return "Arithmetic\\FFT;Transforms\\Smoothing"; }
37
38private:
39 // Overridden Algorithm methods
40 void init() override;
41 void exec() override;
42
43 // Smoothing by truncation.
44 void truncate(int n);
45 // Smoothing by zeroing.
46 void zero(int n);
47
55};
56
57} // namespace Algorithms
58} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Class for marking algorithms as deprecated.
Data smoothing using the FFT algorithm and various filters.
Definition: FFTSmooth.h:24
const std::string summary() const override
Summary of algorithms purpose.
Definition: FFTSmooth.h:31
API::MatrixWorkspace_sptr m_inWS
The input workspace.
Definition: FFTSmooth.h:49
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: FFTSmooth.h:36
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: FFTSmooth.h:34
API::MatrixWorkspace_sptr m_filteredWS
Temporary workspace for keeping the filtered spectrum.
Definition: FFTSmooth.h:54
API::MatrixWorkspace_sptr m_unfilteredWS
Temporary workspace for keeping the unfiltered Fourier transform of the imput spectrum.
Definition: FFTSmooth.h:52
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: FFTSmooth.h:29
std::shared_ptr< MatrixWorkspace > MatrixWorkspace_sptr
shared pointer to the matrix workspace base class
Helper class which provides the Collimation Length for SANS instruments.