-
Notifications
You must be signed in to change notification settings - Fork 122
/
PaddingAndApodization.h
63 lines (55 loc) · 2.45 KB
/
PaddingAndApodization.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2008 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAlgorithms/DllConfig.h"
#include "MantidHistogramData/Histogram.h"
#include "MantidKernel/cow_ptr.h"
namespace Mantid {
namespace Algorithms {
/**Takes a workspace as input and applies a
apodization function and/or padding
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace2D to take as input </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the result
</LI>
<LI> Spectra - The spectra to be adjusted (by default all spectra are done)</LI>
<LI> ApodizationFunction - the apodization function to use </LI>
<LI> decayConstant - the decay constant for the apodization function</LI>
<LI> padding - the number of times to extend the data range by zeros </LI>
</UL>
@author Anthony Lim
@date 10/08/2017
*/
class MANTID_ALGORITHMS_DLL PaddingAndApodization : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "PaddingAndApodization"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "This algorithm applies apodization and/or padding to input data.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "Arithmetic\\FFT"; }
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
using fptr = double (*)(const double, const double);
fptr getApodizationFunction(const std::string &method);
HistogramData::Histogram applyApodizationFunction(const HistogramData::Histogram &histogram,
const double decayConstant, fptr function);
HistogramData::Histogram addPadding(const HistogramData::Histogram &histogram, const int padding);
};
} // namespace Algorithms
} // namespace Mantid