-
Notifications
You must be signed in to change notification settings - Fork 122
/
CalculateFlatBackground.h
71 lines (62 loc) · 2.89 KB
/
CalculateFlatBackground.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
64
65
66
67
68
69
70
71
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 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
#include "MantidAPI/ParallelAlgorithm.h"
#include "MantidAlgorithms/DllConfig.h"
namespace Mantid {
namespace HistogramData {
class Histogram;
}
namespace Algorithms {
/** Finds a constant background value of each desired spectrum
and optionally subtracts that value from the entire spectrum.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the input workspace. </LI>
<LI> OutputWorkspace - The name to give the output workspace. </LI>
<LI> SpectrumIndexList - The workspace indices of the spectra to fit
background to. </LI>
<LI> StartX - The start of the flat region to fit to. </LI>
<LI> EndX - The end of the flat region to fit to. </LI>
<LI> AveragingWindowWidth - The width (in bins) of the moving window. </LI>
<LI> Mode - How to estimate the background number of
counts: a linear fit, the mean, or moving window average. </LI>
<LI> OutputMode - What to return in the Outputworkspace: the
corrected signal or just the background. </LI>
</UL>
@author Russell Taylor, Tessella plc
@date 5/02/2009
*/
class MANTID_ALGORITHMS_DLL CalculateFlatBackground : public API::ParallelAlgorithm {
public:
/// Algorithm's name
const std::string name() const override { return "CalculateFlatBackground"; }
/// Summary of algorithms purpose
const std::string summary() const override { return "Finds a constant background value of each desired histogram."; }
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override { return "SANS;CorrectionFunctions\\BackgroundCorrections"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
void convertToDistribution(API::MatrixWorkspace_sptr workspace);
void restoreDistributionState(API::MatrixWorkspace_sptr workspace);
void checkRange(double &startX, double &endX);
void Mean(const HistogramData::Histogram &histogram, double &background, double &variance, const double startX,
const double endX) const;
void LinearFit(const HistogramData::Histogram &histogram, double &background, double &variance, const double startX,
const double endX);
void MovingAverage(const HistogramData::Histogram &histogram, double &background, double &variance,
const size_t windowWidth) const;
/// Progress reporting
std::unique_ptr<API::Progress> m_progress = nullptr;
};
} // namespace Algorithms
} // namespace Mantid