/
MaxMin.h
84 lines (71 loc) · 3.15 KB
/
MaxMin.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
#ifndef MANTID_ALGORITHMS_MAXMIN_H_
#define MANTID_ALGORITHMS_MAXMIN_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/** Takes a 2D workspace as input and find the maximum(minimum) in each 1D
spectrum.
The algorithm creates a new 1D workspace containing all maxima(minima) as
well as their X boundaries
and error. This is used in particular for single crystal as a quick way to
find strong peaks.
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>
</UL>
Optional Properties (assume that you count from zero):
<UL>
<LI> ShowMin - boolean value to show the minimum (defult=false). If set to
true, it will show minimum, else it will show maximum</LI>
<LI> Range_lower - The X value to search from (default 0)</LI>
<LI> Range_upper - The X value to search to (default max)</LI>
<LI> StartSpectrum - Start spectrum number (default 0)</LI>
<LI> EndSpectrum - End spectrum number (default max)</LI>
</UL>
@date 12/27/2011
Copyright © 2007-2012 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 MaxMin : public API::Algorithm {
public:
/// Default constructor
MaxMin() : API::Algorithm(){};
/// Destructor
~MaxMin() override{};
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "MaxMin"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Takes a 2D workspace as input and find the maximum (minimum) in "
"each 1D spectrum.";
}
/// 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"; }
private:
// Overridden Algorithm methods
void init() override;
void exec() override;
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_MAXMIN_H_*/