-
Notifications
You must be signed in to change notification settings - Fork 122
/
SaveNexus.h
98 lines (81 loc) · 3.42 KB
/
SaveNexus.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
88
89
90
91
92
93
94
95
96
97
98
#ifndef MANTID_DATAHANDLING_SAVENEXUS_H_
#define MANTID_DATAHANDLING_SAVENEXUS_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/Algorithm.h"
#include <climits>
namespace Mantid {
namespace DataHandling {
/**
Saves a file in NeXus format and from a 2D workspace
(Workspace2D class). SaveNeXus is an algorithm and as such inherits
from the Algorithm class, via DataHandlingCommand, and overrides
the init() & exec() methods.
Required Properties:
<UL>
<LI> Filename - The name of and path to the output NeXus file </LI>
<LI> OutputWorkspace - The name of the workspace from which to write the
exported data </LI>
</UL>
@author Freddie Akeroyd, STFC ISIS Facility, GB
@date 24/01/2008
Copyright © 2007-8 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 SaveNexus : public API::Algorithm {
public:
/// Default constructor
SaveNexus();
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "SaveNexus"; };
/// Summary of algorithms purpose
const std::string summary() const override {
return "The SaveNexus algorithm will write the given Mantid workspace to a "
"NeXus file. SaveNexus currently just invokes SaveNexusProcessed.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return 1; };
/// Algorithm's category for identification overriding a virtual method
const std::string category() const override { return "DataHandling\\Nexus"; }
private:
/// Overwrites Algorithm method.
void init() override;
/// Overwrites Algorithm method
void exec() override;
/// The name and path of the input file
std::string m_filename;
/// The name and path of the input file
std::string m_entryname;
/// The prefix to be used to name spectra (_n added for nth spectra)
std::string m_dataname;
/// The file type to save, currently only one type possible
std::string m_filetype;
/// Pointer to the local workspace
API::Workspace_sptr m_inputWorkspace;
/// Method to execute SNP Child Algorithm
void runSaveNexusProcessed();
/// sets non workspace properties for the algorithm
void setOtherProperties(IAlgorithm *alg, const std::string &propertyName,
const std::string &propertyValue,
int perioidNum) override;
protected:
/// Override process groups
bool processGroups() override;
};
} // namespace DataHandling
} // namespace Mantid
#endif /*MANTID_DATAHANDLING_SAVENEXUS_H_*/