-
Notifications
You must be signed in to change notification settings - Fork 121
/
CrossCorrelate.h
101 lines (85 loc) · 3.49 KB
/
CrossCorrelate.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
92
93
94
95
96
97
98
99
100
101
#ifndef MANTID_ALGORITHMS_CROSSCORRELATE_H_
#define MANTID_ALGORITHMS_CROSSCORRELATE_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/SpectraAxis.h"
namespace Mantid {
namespace Algorithms {
/** Compute the cross correlation function for a range of spectra with respect
to a reference spectrum.
* This is use in powder diffraction experiments when trying to estimate the
offset of one spectra
* with respect to another one. The spectra are converted in d-spacing and then
interpolate
* on the X-axis of the reference. The cross correlation function is computed in
the range [-N/2,N/2]
* where N is the number of points.
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>
<LI> ReferenceSpectra - The spectra number against which cross-correlation
function is computed.</LI>
<LI> Spectra_min - Lower bound of the spectra range for which
cross-correlation is computed.</LI>
<LI> Spectra_max - Upper bound of the spectra range for which
cross-correlation is computed.</LI>
</UL>
@author Laurent C Chapon, ISIS Facility Rutherford Appleton Laboratory
@date 15/12/2008
Copyright © 2008 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 CrossCorrelate : public API::Algorithm {
public:
/// (Empty) Constructor
CrossCorrelate() : API::Algorithm(), m_progress(nullptr) {}
/// Virtual destructor
~CrossCorrelate() override {
if (m_progress)
delete m_progress;
m_progress = nullptr;
}
/// Algorithm's name
const std::string name() const override { return "CrossCorrelate"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Cross-correlates a range of spectra against one reference spectra "
"in the same workspace.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override { return "Arithmetic"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
/// Spectra to index map
spec2index_map index_map;
/// Iterator for the spectra to index map
spec2index_map::iterator index_map_it;
/// Progress reporting
API::Progress *m_progress;
};
// Functor for vector sum
} // namespace Algorithms
} // namespace Mantid
#endif /*MANTID_ALGORITHMS_CROSSCORRELATE_H_*/