-
Notifications
You must be signed in to change notification settings - Fork 122
/
StripPeaks.h
91 lines (74 loc) · 3.19 KB
/
StripPeaks.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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
#ifndef MANTID_ALGORITHMS_STRIPPEAKS_H_
#define MANTID_ALGORITHMS_STRIPPEAKS_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
namespace Mantid {
namespace Algorithms {
/** This algorithm calls FindPeaks as a ChildAlgorithm and then subtracts
all the peaks found from the data, leaving just the 'background'.
*** IT IS ASSUMED THAT THE FITTING FUNCTION WAS A GAUSSIAN ***
Required Properties:
<UL>
<LI> InputWorkspace - The name of the Workspace to take as input. </LI>
<LI> OutputWorkspace - The name under which to store the output workspace.
</LI>
</UL>
Optional Properties:
<UL>
<LI> fwhm - passed to the FindPeaks ChildAlgorithm</LI>
<LI> Tolerance - passed to the FindPeaks ChildAlgorithm</LI>
<LI> WorkspaceIndex - The spectrum from which to remove peaks. Will search
all spectra if absent.</LI>
</UL>
@author Russell Taylor, Tessella Support Services plc
@date 30/10/2008
Copyright © 2008-9 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport StripPeaks : public API::Algorithm {
public:
/// (Empty) Constructor
StripPeaks();
/// Algorithm's name
const std::string name() const override { return "StripPeaks"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "This algorithm attempts to find all the peaks in all spectra of a "
"workspace and subtract them from the data, leaving just the "
"'background'.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override {
return "CorrectionFunctions\\PeakCorrections;Optimization\\PeakFinding";
}
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
API::ITableWorkspace_sptr findPeaks(API::MatrixWorkspace_sptr WS);
API::MatrixWorkspace_sptr removePeaks(API::MatrixWorkspace_const_sptr input,
API::ITableWorkspace_sptr peakslist);
double m_maxChiSq;
};
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_STRIPPEAKS_H_*/