-
Notifications
You must be signed in to change notification settings - Fork 122
/
LoadCalFile.h
70 lines (59 loc) · 2.73 KB
/
LoadCalFile.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
// 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/IAlgorithm.h"
#include "MantidAPI/MatrixWorkspace_fwd.h"
#include "MantidDataObjects/GroupingWorkspace.h"
#include "MantidDataObjects/MaskWorkspace.h"
#include "MantidDataObjects/OffsetsWorkspace.h"
#include "MantidGeometry/Instrument.h"
#include "MantidKernel/System.h"
namespace Mantid {
namespace DataHandling {
/** Algorithm to load a 5-column ascii .cal file into up to 3 workspaces:
* a GroupingWorkspace, OffsetsWorkspace and/or MaskWorkspace.
*
* @author Janik Zikovsky
* @date 2011-05-09
*/
class DLLExport LoadCalFile final : public API::Algorithm {
public:
/// Algorithm's name for identification
const std::string name() const override { return "LoadCalFile"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "Loads a 5-column ASCII .cal file into 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 {"LoadDiffCal", "ReadGroupsFromFile", "CreateDummyCalFile", "CreateCalFileByNames",
"AlignDetectors", "DiffractionFocussing", "SaveCalFile", "MergeCalFiles"};
}
/// Algorithm's category for identification
const std::string category() const override { return R"(DataHandling\Text;Diffraction\DataHandling\CalFiles)"; }
static void getInstrument3WaysInit(Mantid::API::Algorithm *alg);
static Geometry::Instrument_const_sptr getInstrument3Ways(API::Algorithm *alg);
static bool instrumentIsSpecified(API::Algorithm *alg);
static void readCalFile(const std::string &calFileName, const Mantid::DataObjects::GroupingWorkspace_sptr &groupWS,
const Mantid::DataObjects::OffsetsWorkspace_sptr &offsetsWS,
const Mantid::DataObjects::MaskWorkspace_sptr &maskWS);
protected:
Parallel::ExecutionMode
getParallelExecutionMode(const std::map<std::string, Parallel::StorageMode> &storageModes) const override;
private:
/// Initialise the properties
void init() override;
/// Run the algorithm
void exec() override;
/// Checks if a detector ID is for a monitor on a given instrument
static bool idIsMonitor(const Mantid::Geometry::Instrument_const_sptr &inst, int detID);
};
} // namespace DataHandling
} // namespace Mantid