Newer
Older
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 ISIS Rutherford Appleton Laboratory UKRI,
// NScD Oak Ridge National Laboratory, European Spallation Source
// & Institut Laue - Langevin
// SPDX - License - Identifier: GPL - 3.0 +
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
//---------------------------------------------------
// Includes
//---------------------------------------------------
#include "LoadANSTOEventFile.h"
#include "LoadANSTOHelper.h"
#include "MantidAPI/IFileLoader.h"
#include "MantidAPI/LogManager.h"
#include "MantidDataObjects/EventWorkspace.h"
#include "MantidGeometry/Instrument.h"
#include "MantidNexus/NexusClasses.h"
namespace Mantid {
namespace DataHandling {
using ANSTO::EventVector_pt;
/*
Loads an ANSTO Pelican event file and stores it in an event workspace.
@author Geish Miladinovic (ANSTO)
Copyright © 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>
*/
/** LoadPLN : Loads an ANSTO PLN Hdf and linked event file into a workspace.
Required Properties:
<UL>
<LI> Filename - Name of and path to the input event file</LI>
<LI> OutputWorkspace - Name of the workspace which stores the data</LI>
</UL>
Optional Properties:
<UL>
<LI> Mask - The input filename of the mask data</LI>
<LI> SelectDetectorTubes - Range of detector tubes to be loaded</LI>
<LI> FilterByTimeStart - Only include events after the start time</LI>
<LI> FilterByTimeStop - Only include events before the stop time</LI>
<LI> PathToBinaryEventFile - Rel or abs path to event file linked to hdf</LI>
<LI> SelectDataset - Select the linked event dataset</LI>
</UL>
*/
class DLLExport LoadPLN : public API::IFileLoader<Kernel::NexusDescriptor> {
public:
int version() const override;
const std::vector<std::string> seeAlso() const override;
const std::string category() const override;
const std::string name() const override;
const std::string summary() const override;
int confidence(Kernel::NexusDescriptor &descriptor) const override;
private:
void exec() override;
void init() override;
void exec(const std::string &hdfFile, const std::string &eventFile);
// region of intereset
std::vector<bool> createRoiVector(const std::string &seltubes,
const std::string &maskfile);
protected:
// load parameters from input file
void loadParameters(const std::string &hdfFile, API::LogManager &logm);
void loadEnvironParameters(const std::string &hdfFile, API::LogManager &logm);
// load the instrument definition and instrument parameters
void loadInstrument();
// get the L2 distance indexed by detector id
void loadDetectorL2Values();
// create workspace
void createWorkspace(const std::string &title);
// prepare event storage
void prepareEventStorage(ANSTO::ProgressTracker &prog,
std::vector<size_t> &eventCounts,
std::vector<EventVector_pt> &eventVectors);
// set up the detector masks
void setupDetectorMasks(std::vector<bool> &roi);
// shared member variables
DataObjects::EventWorkspace_sptr m_localWorkspace;
int32_t m_datasetIndex;
std::string m_startRun;
std::vector<double> m_detectorL2;
};
} // namespace DataHandling
} // namespace Mantid