Mantid
Loading...
Searching...
No Matches
SassenaFFT.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"
16
17namespace Mantid {
18namespace Algorithms {
19
26class MANTID_ALGORITHMS_DLL SassenaFFT final : public API::Algorithm {
27public:
29 const std::string name() const override { return "SassenaFFT"; }
31 const std::string summary() const override {
32 return "Performs complex Fast Fourier Transform of intermediate scattering "
33 "function";
34 }
35
37 int version() const override { return 1; }
38 const std::vector<std::string> seeAlso() const override {
39 return {"ExtractFFTSpectrum", "FFT", "FFTDerivative", "MaxEnt", "RealFFT", "FFTSmooth"};
40 }
42 const std::string category() const override { return "Arithmetic\\FFT"; }
43
44protected:
45 // Overridden Algorithm methods
46 bool processGroups() override;
47
48private:
49 // Overridden Algorithm methods
50 void init() override;
51 void exec() override;
52 bool checkGroups() override;
53 static constexpr double m_T2ueV = 1000.0 / Mantid::PhysicalConstants::meVtoKelvin; // conversion factor from
54 // Kelvin to ueV
55 const double m_ps2meV = 4.136; // conversion factor from picosecond to mili-eV
56
57}; // class SassenaFFT
58
59} // namespace Algorithms
60} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Perform Fourier Transform of the Sassena Intermediate Scattering Function.
Definition: SassenaFFT.h:26
const std::string summary() const override
Summary of algorithms purpose.
Definition: SassenaFFT.h:31
int version() const override
Algorithm's version for identification overriding a virtual method.
Definition: SassenaFFT.h:37
const std::string category() const override
Algorithm's category for identification overriding a virtual method.
Definition: SassenaFFT.h:42
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: SassenaFFT.h:38
const std::string name() const override
Algorithm's name for identification overriding a virtual method.
Definition: SassenaFFT.h:29
static constexpr double meVtoKelvin
1 meV in Kelvin.
Helper class which provides the Collimation Length for SANS instruments.