-
Notifications
You must be signed in to change notification settings - Fork 122
/
LoadAscii2.h
117 lines (101 loc) · 4.8 KB
/
LoadAscii2.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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
#ifndef MANTID_DATAHANDLING_LoadAscii2_H_
#define MANTID_DATAHANDLING_LoadAscii2_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/IFileLoader.h"
#include "MantidDataObjects/Histogram1D.h"
#include "MantidAPI/MatrixWorkspace.h"
namespace Mantid
{
namespace DataHandling
{
/**
Loads a workspace from an ascii file. Spectra must be stored in columns.
Properties:
<ul>
<li>Filename - the name of the file to read from.</li>
<li>Workspace - the workspace name that will be created and hold the loaded data.</li>
<li>Separator - the column separation character: comma (default),tab,space,colon,semi-colon.</li>
<li>Unit - the unit to assign to the X axis (default: Energy).</li>
</ul>
@author Keith Brown, ISIS, Placement student from the University of Derby
@date 10/10/13
Copyright © 2007-2010 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
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 LoadAscii2 :public API::IFileLoader<Kernel::FileDescriptor>
{
public:
/// Default constructor
LoadAscii2();
/// The name of the algorithm
virtual const std::string name() const { return "LoadAscii"; }
/// The version number
virtual int version() const { return 2; }
/// The category
virtual const std::string category() const { return "DataHandling\\Text"; }
/// Returns a confidence value that this algorithm can load a file
virtual int confidence(Kernel::FileDescriptor & descriptor) const;
static bool isAscii(FILE *file);
protected:
/// Read the data from the file
virtual API::Workspace_sptr readData(std::ifstream & file);
/// Return true if the line is to be skipped
bool skipLine(const std::string & line) const;
/// Return true if the line doesn't start with a valid character
bool badLine(const std::string & line) const;
/// check and configure flags and values relating to starting a new spectra
void newSpectra();
/// Check if the file has been found to incosistantly include spectra IDs
void inconsistantIDCheck() const;
/// Split the data into columns.
int splitIntoColumns(std::list<std::string> & columns, const std::string & str) const;
/// Fill the given vector with the data values
void fillInputValues(std::vector<double> &values, const std::list<std::string>& columns) const;
//write the values in the current line to teh end fo teh current spectra
void addToCurrentSpectra(std::list<std::string> & columns);
//check that the nubmer of columns in the current line match the number found previously
void checkLineColumns(const int & cols) const;
//interpret a line that has been deemed valid enough to look at.
void parseLine(const std::string & line, std::list<std::string> & columns, const int & lineNo);
//find the number of collums we should expect from now on
void setcolumns(std::ifstream & file, std::string & line, std::list<std::string> & columns);
//wirte the spectra to the workspace
void writeToWorkspace(API::MatrixWorkspace_sptr & localWorkspace, const size_t & numSpectra) const;
/// The column separator
std::string m_columnSep;
private:
/// Sets documentation strings for this algorithm
virtual void initDocs();
/// Declare properties
void init();
/// Execute the algorithm
void exec();
/// Map the separator options to their string equivalents
std::map<std::string,std::string> m_separatorIndex;
std::string m_comment;
int m_baseCols;
int m_specNo;
int m_lastBins;
int m_curBins;
bool m_spectraStart;
int m_specIDs;
std::vector<DataObjects::Histogram1D> m_spectra;
DataObjects::Histogram1D *m_curSpectra;
};
} // namespace DataHandling
} // namespace Mantid
#endif /* MANTID_DATAHANDLING_LoadAscii2_H_ */