-
Notifications
You must be signed in to change notification settings - Fork 122
/
RawFileInfo.h
86 lines (71 loc) · 2.88 KB
/
RawFileInfo.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
#ifndef MANTIDDATAHANDLING_RAWFILEINFO_H_
#define MANTIDDATAHANDLING_RAWFILEINFO_H_
//------------------------------------
// Includes
//------------------------------------
#include "MantidAPI/Algorithm.h"
//------------------------------------
// Forward declarations
//------------------------------------
class ISISRAW;
namespace Mantid {
namespace DataHandling {
/**
An algorithm to extract pertinent information about a RAW file without
loading the data.
Required input properties:
<UL>
<LI> Filename - The raw file to use to gather the information </LI>
<LI> GetRunParameters - Flag indicating whether to output run parameters
(RPB_STRUCT) in a table (default false)</LI>
</UL>
Output properties:
<UL>
<LI> RunTitle - The title of the run (r_title) </LI>
<LI> RunHeader - The run header (HDR_STRUCT) </LI>
<LI> SpectraCount - The number of spectra (t_nsp1) </LI>
<LI> TimeChannelCount - The number of time channels (t_ntc1) </LI>
<LI> PeriodCount - The number of periods (t_nper) </LI>
<LI> RunParameterTable (If requested by GetRunParameters flag above) <LI>
</UL>
@author Martyn, Tessella plc
@date 29/07/2009
Copyright © 2009 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 RawFileInfo : public API::Algorithm {
public:
static const std::string runTitle(const ISISRAW &isisRaw);
static const std::string runHeader(const ISISRAW &isisRaw);
/// Algorithm's name
const std::string name() const override { return "RawFileInfo"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "Extract run parameters from a RAW file as output properties.";
}
/// Algorithm's version
int version() const override { return (1); }
/// Algorithm's category for identification
const std::string category() const override { return "DataHandling\\Raw"; }
private:
/// Initialisation code
void init() override;
/// Execution code
void exec() override;
};
}
}
#endif /*MANTIDDATAHANDLING_RAWFILEINFO_H_*/