-
Notifications
You must be signed in to change notification settings - Fork 122
/
PoldiAutoCorrelation5.h
91 lines (69 loc) · 3.16 KB
/
PoldiAutoCorrelation5.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_DATAHANDLING_PoldiAutoCorrelation5_H_
#define MANTID_DATAHANDLING_PoldiAutoCorrelation5_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidSINQ/DllConfig.h"
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/ITableWorkspace_fwd.h"
#include "MantidDataObjects/Workspace2D.h"
#include "MantidDataObjects/TableWorkspace.h"
#include "MantidKernel/PhysicalConstants.h"
#include "MantidSINQ/PoldiUtilities/PoldiAutoCorrelationCore.h"
#include "MantidSINQ/PoldiUtilities/PoldiDeadWireDecorator.h"
namespace Mantid {
namespace Poldi {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
// N.B. PoldiAutoCorrelation5 is used to create the autocorrelation
// function from POLDI raw data
/** @class PoldiAutoCorrelation5 PoldiAutoCorrelation5.h
Poldi/PoldiAutoCorrelation5.h
Part of the Poldi scripts set, used to analyse Poldi data
@author Christophe Le Bourlot, Paul Scherrer Institut - SINQ
@date 05/06/2013
@author Michael Wedel, Paul Scherrer Institut - SINQ
@date 18/02/2014
Copyright © 2013, 2014 PSI-MSS
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://svn.mantidproject.org/mantid/trunk/Code/Mantid>
Code Documentation is available at <http://doxygen.mantidproject.org>
*/
class MANTID_SINQ_DLL PoldiAutoCorrelation5 : public API::Algorithm {
public:
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "PoldiAutoCorrelation"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Performs correlation analysis of POLDI 2D-data.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 5; }
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "SINQ\\Poldi"; }
protected:
/// Overwrites Algorithm method
void exec() override;
void logConfigurationInformation(
boost::shared_ptr<PoldiDeadWireDecorator> cleanDetector,
PoldiAbstractChopper_sptr chopper);
private:
/// Overwrites Algorithm method.
void init() override;
boost::shared_ptr<PoldiAutoCorrelationCore> m_core;
};
} // namespace Poldi
} // namespace Mantid
#endif /* MANTID_DATAHANDLING_PoldiAutoCorrelation5_H_*/