-
Notifications
You must be signed in to change notification settings - Fork 122
/
SavePAR.h
100 lines (95 loc) · 3.38 KB
/
SavePAR.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
#ifndef SAVEPAR_H_
#define SAVEPAR_H_
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace DataHandling {
/**
* Saves a workspace into an ASCII PAR file.
*
* Required properties:
* <UL>
* <LI> InputWorkspace - The workspace name to save. </LI>
* <LI> Filename - The filename for output </LI>
* </UL>
*
* @author Alex Buts; after save PHX Sturat Cambell, ScD, Oak Ridge National
*Laboratory
* @date 15/09/2011
*
* Copyright © 2009-2010 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>
*
*/
/*!
* an ASCII Tobyfit par file format:
*
* par(6,ndet) contents of array
*
* 1st column sample-detector distance \n
* 2nd " scattering angle (deg) \n
* 3rd " azimuthal angle (deg) \n
* (west bank = 0 deg, north bank = -90 deg etc.)
* (Note the reversed sign convention cf .phx files) \n
* 4th " width (m) \n
* 5th " height (m) \n
* 6th " DetID (m) \n
*-----------------------------------------------------------------------
*/
class DLLExport SavePAR : public Mantid::API::Algorithm {
public:
/// (Empty) Constructor
SavePAR() : Mantid::API::Algorithm() {}
/// Virtual destructor
~SavePAR() override {}
/// Algorithm's name
const std::string name() const override { return "SavePAR"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Writes the detector geometry information of a workspace into a "
"Tobyfit PAR format file.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override {
return "DataHandling\\SPE;Inelastic\\DataHandling";
}
/** the method used in tests. It requested the ChildAlgorithm, which does the
detectors
* position calculations to produce a target workspace This workspace then
can be retrieved
from analysis data service and used to check the results of the save
algorithm. */
void set_resulting_workspace(const std::string &ws_name) {
det_par_ws_name = ws_name;
}
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
/// The name of the table workpsace with detectors positions used in tests
std::string det_par_ws_name;
};
} // namespace DataHandling
} // namespace Mantid
#endif /*SAVEPAR_H_*/