Mantid
Loading...
Searching...
No Matches
ExtractFFTSpectrum.h
Go to the documentation of this file.
1// Mantid Repository : https://github.com/mantidproject/mantid
2//
3// Copyright © 2010 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"
13#include "MantidAlgorithms/DllConfig.h"
14
15namespace Mantid {
16namespace Algorithms {
29class MANTID_ALGORITHMS_DLL ExtractFFTSpectrum final : public API::Algorithm {
30public:
32 const std::string name() const override { return "ExtractFFTSpectrum"; }
34 const std::string summary() const override {
35 return "This algorithm performs a Fast Fourier Transform on each spectrum "
36 "in a workspace, and from the result takes the indicated spectrum "
37 "and places it into the OutputWorkspace, so that you end up with "
38 "one result spectrum for each input spectrum in the same workspace.";
39 }
40
42 int version() const override { return (1); }
43 const std::vector<std::string> seeAlso() const override {
44 return {"FFT", "FFTDerivative", "MaxEnt", "RealFFT", "SassenaFFT", "FFTSmooth"};
45 }
47 const std::string category() const override { return "Arithmetic\\FFT"; }
48
49private:
51 void init() override;
53 void exec() override;
54};
55
56} // namespace Algorithms
57} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
This algorithm performs a Fast Fourier Transform on each spectra of the input workspace.
const std::string name() const override
Algorithm's name.
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
int version() const override
Algorithm's version.
const std::string summary() const override
Summary of algorithms purpose.
const std::string category() const override
Algorithm's category for identification.
Helper class which provides the Collimation Length for SANS instruments.