Mantid
Loading...
Searching...
No Matches
FFTDerivative.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 {
14
15namespace HistogramData {
16class Histogram;
17class HistogramX;
18class HistogramY;
19} // namespace HistogramData
20
21namespace Algorithms {
22
30public:
32 const std::string name() const override { return "FFTDerivative"; }
34 const std::string summary() const override {
35 return "Calculated derivatives of a spectra in the MatrixWorkspace using "
36 "Fast Fourier Transform (FFT).";
37 }
38
40 int version() const override { return (1); }
41 const std::vector<std::string> seeAlso() const override {
42 return {"ExtractFFTSpectrum", "FFT", "MaxEnt", "RealFFT", "SassenaFFT", "FFTSmooth"};
43 }
45 const std::string category() const override { return "Arithmetic\\FFT"; }
46
47private:
49 void init() override;
51 void exec() override;
52 void execComplexFFT();
53 void symmetriseSpectrum(const HistogramData::Histogram &in, HistogramData::HistogramX &symX,
54 HistogramData::HistogramY &symY, const size_t nx, const size_t ny);
55 void multiplyTransform(const HistogramData::HistogramX &nu, HistogramData::HistogramY &re,
56 HistogramData::HistogramY &im);
57};
58
59} // namespace Algorithms
60} // namespace Mantid
Base class from which all concrete algorithm classes should be derived.
Definition: Algorithm.h:85
Calculates derivatives of the spectra in a MatrixWorkspace using a Fast Fourier Transform.
Definition: FFTDerivative.h:29
void symmetriseSpectrum(const HistogramData::Histogram &in, HistogramData::HistogramX &symX, HistogramData::HistogramY &symY, const size_t nx, const size_t ny)
void multiplyTransform(const HistogramData::HistogramX &nu, HistogramData::HistogramY &re, HistogramData::HistogramY &im)
A Fourier transform of a derivative of order n has a factor of i^n where i is the imaginary unit.
void init() override
Initialisation code.
void exec() override
Execution code.
const std::string category() const override
Algorithm's category for identification.
Definition: FFTDerivative.h:45
int version() const override
Algorithm's version.
Definition: FFTDerivative.h:40
const std::string name() const override
Algorithm's name.
Definition: FFTDerivative.h:32
const std::string summary() const override
Summary of algorithms purpose.
Definition: FFTDerivative.h:34
const std::vector< std::string > seeAlso() const override
Function to return all of the seeAlso algorithms related to this algorithm.
Definition: FFTDerivative.h:41
Helper class which provides the Collimation Length for SANS instruments.