-
Notifications
You must be signed in to change notification settings - Fork 122
/
SaveCalFile.h
64 lines (56 loc) · 2.22 KB
/
SaveCalFile.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
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source,
// Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
#include "MantidAPI/Algorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataObjects/GroupingWorkspace.h"
#include "MantidDataObjects/MaskWorkspace.h"
#include "MantidDataObjects/OffsetsWorkspace.h"
#include "MantidKernel/System.h"
namespace Mantid {
namespace DataHandling {
/** Algorithm to save a 5-column ascii .cal file from to 3 workspaces:
* a GroupingWorkspace, OffsetsWorkspace and/or MaskWorkspace.
*
* @author
* @date 2011-05-10 09:48:31.796980
*/
class DLLExport SaveCalFile : public API::Algorithm {
public:
/// Algorithm's name for identification
const std::string name() const override { return "SaveCalFile"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Saves a 5-column ASCII .cal file from up to 3 workspaces: a "
"GroupingWorkspace, OffsetsWorkspace and/or MaskWorkspace.";
}
/// Algorithm's version for identification
int version() const override { return 1; };
const std::vector<std::string> seeAlso() const override {
return {"SaveDiffCal", "ReadGroupsFromFile",
"CreateDummyCalFile", "CreateCalFileByNames",
"AlignDetectors", "DiffractionFocussing",
"LoadCalFile", "MergeCalFiles"};
}
/// Algorithm's category for identification
const std::string category() const override {
return R"(DataHandling\Text;Diffraction\DataHandling\CalFiles)";
}
void saveCalFile(const std::string &calFileName,
const Mantid::DataObjects::GroupingWorkspace_sptr &groupWS,
const Mantid::DataObjects::OffsetsWorkspace_sptr &offsetsWS,
const Mantid::DataObjects::MaskWorkspace_sptr &maskWS);
private:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
/// Offset precision
int m_precision{7};
};
} // namespace DataHandling
} // namespace Mantid