-
Notifications
You must be signed in to change notification settings - Fork 122
/
CreateWorkspace.h
87 lines (80 loc) · 2.97 KB
/
CreateWorkspace.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
#ifndef MANTID_ALGORITHMS_CREATEWORKSPACE_H_
#define MANTID_ALGORITHMS_CREATEWORKSPACE_H_
#include "MantidAPI/Algorithm.h"
namespace Mantid {
namespace Algorithms {
/**
* CreateWorkspace Algorithm
*
* This algorithm constructs a MatrixWorkspace when passed a vector for each of
*the X, Y, E, and Dx
* data values. The unit for the X Axis can optionally be specified as any of
*the units in the
* Kernel's UnitFactory.
*
* Multiple spectra may be created by supplying the NSpec Property (integer,
*default 1). When this
* is provided the vectors are split into equal-sized spectra (all X, Y, E
*values must still be
* in a single vector for input). If the X values should be the same for all
*spectra, then DataX
* can just provide them once, i.e. its length can be length(DataY)/NSpec (or 1
*longer for histograms).
*
* @date 20/10/2010
* @author Michael Whitty
*
* 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>
*/
class DLLExport CreateWorkspace : public API::Algorithm {
public:
const std::string name() const override {
return "CreateWorkspace";
} ///< @return the algorithms name
/// Summary of algorithms purpose
const std::string summary() const override {
return "This algorithm constructs a MatrixWorkspace when passed a vector "
"for each of the X, Y, and E data values.";
}
const std::string category() const override {
return "Utility\\Workspaces";
} ///< @return the algorithms category
int version() const override {
return (1);
} ///< @return version number of algorithm
const std::vector<std::string> seeAlso() const override {
return {"CreateSingleValuedWorkspace", "CreateSampleWorkspace"};
}
std::map<std::string, std::string> validateInputs() override;
protected:
Parallel::ExecutionMode getParallelExecutionMode(
const std::map<std::string, Parallel::StorageMode> &storageModes)
const override;
private:
/// Initialise the Algorithm (declare properties)
void init() override;
/// Execute the Algorithm
void exec() override;
};
} // namespace Algorithms
} // namespace Mantid
#endif // MANTID_ALGORITHMS_CREATEWORKSPACE_H_