WSL/SLF GitLab Repository

libsmet.cc 41.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/***********************************************************************************/
/*  Copyright 2009 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    MeteoIO 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
18
#include <meteoio/plugins/libsmet.h>
19
20
#include <errno.h>
#include <string.h>
21
#include <limits>
22

23
24
25
26
27
28
#if defined _WIN32 || defined __MINGW32__
	#include <windows.h>
#else
	#include <sys/stat.h>
#endif

29
30
31
32
using namespace std;

namespace smet {

Mathias Bavay's avatar
Mathias Bavay committed
33
const char* SMETCommon::smet_version = "1.1";
34
35
36
37
set<string> SMETCommon::all_mandatory_header_keys = set<std::string>();
set<string> SMETCommon::all_optional_header_keys  = set<std::string>();
set<string> SMETCommon::all_decimal_header_values = set<std::string>();

Mathias Bavay's avatar
Mathias Bavay committed
38
39
SMETException::SMETException(const std::string& message, const std::string& position)
              : msg( (position.empty())? "At unknown position: " + message : position + ": " + message) {}
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

SMETException::~SMETException() throw() {}

const char* SMETException::what() const throw()
{
	return msg.c_str();
}

const bool SMETCommon::__init = SMETCommon::initStaticData();
bool SMETCommon::initStaticData()
{
	all_mandatory_header_keys.insert("station_id");
	all_mandatory_header_keys.insert("nodata");
	all_mandatory_header_keys.insert("fields");

	all_optional_header_keys.insert("latitude");
	all_optional_header_keys.insert("longitude");
	all_optional_header_keys.insert("altitude");
	all_optional_header_keys.insert("easting");
	all_optional_header_keys.insert("northing");
	all_optional_header_keys.insert("epsg");

	all_optional_header_keys.insert("station_name");
	all_optional_header_keys.insert("tz");
	all_optional_header_keys.insert("creation");
	all_optional_header_keys.insert("source");
	all_optional_header_keys.insert("units_offset");
	all_optional_header_keys.insert("units_multiplier");
	all_optional_header_keys.insert("comment");

	all_decimal_header_values.insert("nodata");
	all_decimal_header_values.insert("latitude");
	all_decimal_header_values.insert("longitude");
	all_decimal_header_values.insert("altitude");
	all_decimal_header_values.insert("easting");
	all_decimal_header_values.insert("northing");
	all_decimal_header_values.insert("epsg");
	all_decimal_header_values.insert("tz");

	return true;
}

82
#if defined _WIN32 || defined __MINGW32__
83
bool SMETCommon::fileExists(const std::string& filename)
84
85
{
	const DWORD attributes = GetFileAttributes( filename.c_str() );
86
87

	if (attributes==INVALID_FILE_ATTRIBUTES || attributes==FILE_ATTRIBUTE_VIRTUAL
88
89
	     || attributes==FILE_ATTRIBUTE_DIRECTORY || attributes==FILE_ATTRIBUTE_DEVICE)
		return false;
90

91
92
93
	return true;
}
#else
94
bool SMETCommon::fileExists(const std::string& filename)
95
96
97
98
99
100
{
	struct stat buffer ;

	if ((stat( filename.c_str(), &buffer))!=0) {//File exists if stat returns 0
		return false;
	}
101

102
103
104
105
106
107
108
	if (S_ISREG(buffer.st_mode) || S_ISFIFO(buffer.st_mode) || S_ISLNK(buffer.st_mode))
		return true;
	else
		return false; //exclude char device, block device, sockets, etc
}
#endif

109
110
111
112
113
114
115
116
117
bool SMETCommon::validFileAndPath(const std::string& filename)
{
#if defined _WIN32 || defined __MINGW32__ || defined __CYGWIN__
	const size_t startpos = filename.find_first_not_of(" \t\n"); // Find the first character position after excluding leading blank spaces
	const size_t invalid_char = filename.find_first_of("\000*:<>?|"); //find possible invalid characters
#else
	const size_t startpos = filename.find_first_not_of(" \t\n"); // Find the first character position after excluding leading blank spaces
	const size_t invalid_char = filename.find_first_of("\000"); //find possible invalid characters
#endif
Mathias Bavay's avatar
Mathias Bavay committed
118

119
120
121
122
123
124
	if ((startpos!=0) || (invalid_char!=std::string::npos) || (filename==".") || (filename=="..")) {
		return false;
	}
	return true;
}

125
126
double SMETCommon::convert_to_double(const std::string& in_string)
{
127
128
	char* conversion_end = NULL;
	const double conversion_value = strtod(in_string.c_str(), &conversion_end);
129

130
131
	if (*conversion_end == '\0') {
		return conversion_value;
132
133
134
	} else {
		throw SMETException("Value \"" + in_string + "\" cannot be converted to double", SMET_AT);
	}
135
136
}

137
138
139
140
int SMETCommon::convert_to_int(const std::string& in_string)
{
	istringstream ss(in_string);
	int value;
141
	if (!(ss >> value)) throw SMETException("Value \"" + in_string + "\" cannot be converted to int", SMET_AT);
142
143
144
145

	return value;
}

146
147
148
149
150
151
152
void SMETCommon::trim(std::string& str)
{
	const std::string whitespaces(" \t\f\v\n\r");
	const size_t startpos = str.find_first_not_of(whitespaces); // Find the first character position after excluding leading blank spaces
	const size_t endpos = str.find_last_not_of(whitespaces); // Find the first character position from reverse af

	// if all spaces or empty return an empty string
153
	if (( std::string::npos == startpos ) || ( std::string::npos == endpos)) {
154
		str.clear();
155
	} else {
156
157
		str.erase(endpos+1); //right trim
		str.erase(0, startpos); //left trim
158
159
160
161
	}
}

bool SMETCommon::readKeyValuePair(const std::string& in_line, const std::string& delimiter,
162
                                  std::map<std::string,std::string>& out_map)
163
164
165
166
167
168
169
170
171
172
173
{
	//size_t pos = in_line.find(delimiter); //first occurence of '='

	size_t pos = std::string::npos;
	if ((delimiter==" ") || (delimiter=="\t")) {
		pos = in_line.find_first_of(" \t", 0);
	} else {
		pos = in_line.find(delimiter); //first occurence of '='
	}


174
	if (pos != std::string::npos) { //ignore in_lines that are empty or without '='
175
176
177
178
179
180
		std::string key = in_line.substr(0, pos);
		std::string value = in_line.substr(pos + 1);

		SMETCommon::trim(key);
		SMETCommon::trim(value);

181
		if (key.empty() || value.empty()) {
182
183
184
185
186
187
188
189
190
191
192
193
194
			return false;
		}

		out_map[key] = value;
	} else {
		return false;
	}

	return true;
}

void SMETCommon::stripComments(std::string& str)
{
195
	const size_t found = str.find_first_of("#;");
196
197
198
199
200
201
202
	if (found != std::string::npos){
		str.erase(found); //rest of line disregarded
	}
}

void SMETCommon::toUpper(std::string& str)
{
203
	std::transform(str.begin(), str.end(),str.begin(), ::toupper);
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
}

char SMETCommon::getEoln(std::istream& fin)
{
	std::streambuf* pbuf;
	char tmp = '0';
	int chars = 0;

	const std::streampos position = fin.tellg();

	do {
		fin.get(tmp);
		chars++;

		if ((tmp == '\r') || (tmp == '\n')) {
			char peekc = tmp;
			while ((!fin.eof() && ((peekc=='\r') || (peekc=='\n')))) {
				tmp = peekc;
				fin.get(peekc);
				chars++;
			}
			pbuf = fin.rdbuf();
			pbuf->pubseekpos(position); //rewind
			fin.clear(); //reset eof flag, etc
			return tmp;
		}
	} while ((chars < 3000) && (!fin.eof()));

	pbuf = fin.rdbuf();
	pbuf->pubseekpos(position); //rewind
	fin.clear(); //reset eof flag, etc

	return '\n';
}

bool SMETCommon::is_decimal(const std::string& value)
{
	istringstream ss(value);
	double doublevalue;
	if (!(ss >> doublevalue)) return false;

	return true;
}

size_t SMETCommon::readLineToVec(const std::string& line_in, std::vector<std::string>& vec_string)
{
	vec_string.clear();
	std::istringstream iss(line_in); //construct inputstream with the string line as input

	std::string tmp_string;
	while (!iss.eof()) {
		iss >> std::skipws >> tmp_string;

257
		if (!tmp_string.empty()) {
258
			vec_string.push_back( tmp_string );
259
		}
260
		tmp_string.clear();
261
262
263
264
265
	}

	return vec_string.size();
}

266
267
268

////////////////////////////////////////////////////////////
//// SMETWriter class
269
SMETWriter::SMETWriter(const std::string& in_filename, const SMETType& in_type)
270
           : other_header_keys(), ascii_precision(), ascii_width(), header(), mandatory_header_keys(),
271
             filename(in_filename), nodata_string(), smet_type(in_type), nodata_value(-999.), nr_of_fields(0),
272
             julian_field(0), timestamp_field(0), location_wgs84(0), location_epsg(0),
273
             location_in_header(false), location_in_data_wgs84(false), location_in_data_epsg(false),
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
             timestamp_present(false), julian_present(false), file_is_binary(false), append_mode(false) {}

//what the caller MUST provide: 
//	* the fields header (for checks)
//	* the ascii width and precision
//	* nodata_value provided through set_header_value() calls
//HACK: the multipliers and offsets are not handled yet...
//for now, we do the most basic append: all the data after the first insertion point is deleted
SMETWriter::SMETWriter(const std::string& in_filename, const std::string& in_fields, const double& in_nodata)
           : other_header_keys(), ascii_precision(), ascii_width(), header(), mandatory_header_keys(),
             filename(in_filename), nodata_string(), smet_type(ASCII), nodata_value(in_nodata), nr_of_fields(0),
             julian_field(0), timestamp_field(0), location_wgs84(0), location_epsg(0),
             location_in_header(false), location_in_data_wgs84(false), location_in_data_epsg(false),
             timestamp_present(false), julian_present(false), file_is_binary(false), append_mode(true)
{
	SMETReader reader(filename);
	smet_type = (reader.isAscii)? ASCII : BINARY;
	nodata_string = reader.get_header_value("nodata");
	//nodata_value = reader.nodata_value; //we trust the value provided to the constructor
	
	nr_of_fields = reader.nr_of_fields;
	julian_field = reader.julian_field;
	timestamp_field = reader.timestamp_field;
	timestamp_present = reader.timestamp_present;
	julian_present = reader.julian_present;
	
	location_wgs84 = reader.location_wgs84;
	location_epsg = reader.location_epsg;
	location_in_header = reader.location_in_header(WGS84) || reader.location_in_header(EPSG);
	location_in_data_wgs84 = reader.location_in_data(WGS84);
	location_in_data_epsg = reader.location_in_data(EPSG);
	
	//check that the fields match
	std::vector<std::string> vecFields;
	SMETCommon::readLineToVec(in_fields, vecFields);
	if (nr_of_fields!=vecFields.size()) {
		std::ostringstream ss;
		ss << "Trying to write " << vecFields.size() << " fields in file '" << filename << "' that has " << nr_of_fields << " fields";
		throw SMETException(ss.str(), AT);
	}
	for (size_t ii=0; ii<nr_of_fields; ii++) {
		if (vecFields[ii] != reader.get_field_name(ii)) {
			std::ostringstream ss;
			ss << "Trying to write field '" << vecFields[ii] << "' at position " << ii << " in file '" << filename << "' when it should be '" << reader.get_field_name(ii);
			throw SMETException(ss.str(), AT);
		}
	}
}
322
323
324
325
326

void SMETWriter::set_header_value(const std::string& key, const double& value)
{
	//check if key is decimal, transform to string and add to header
	if (SMETCommon::all_decimal_header_values.find(key) != SMETCommon::all_decimal_header_values.end()){
327
		ostringstream ss;
328
329
330
331
332
333
334
335
336
337
338
		if ((key == "latitude") || (key == "longitude") || (key == "easting") || (key == "northing")){
			ss << fixed << setprecision(6) << value;
		} else if (key == "altitude"){
			ss << fixed << setprecision(1) << value;
		} else if ((key == "epsg") || (key == "tz")){
			ss << fixed << setprecision(0) << value;
		} else {
			ss << value; //for nodata
		}

		set_header_value(key, ss.str());
339
	} else { //It's a non-standard header value
340
		ostringstream ss;
341
342
		ss << value; //for nodata
		set_header_value(key, ss.str());
343
344
345
346
347
348
349
	}
}

void SMETWriter::set_header_value(const std::string& key, const std::string& value)
{
	//check if header key/value pair is valid
	if (valid_header_pair(key, value)){
350
		header[key] = value;
351
352
353
354

		if ((SMETCommon::all_optional_header_keys.find(key) == SMETCommon::all_optional_header_keys.end())
		    && (SMETCommon::all_mandatory_header_keys.find(key) == SMETCommon::all_mandatory_header_keys.end()))
			other_header_keys.push_back(key);
355
356
357
358
359
360
361
	} else {
		throw SMETException("Invalid, inconsistent or unknown key/value pair: " + key + " = " + value, SMET_AT);
	}
}

bool SMETWriter::valid_header_pair(const std::string& key, const std::string& value)
{
362
	bool key_ok = true;
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391

	if (SMETCommon::all_mandatory_header_keys.find(key) != SMETCommon::all_mandatory_header_keys.end()){
		mandatory_header_keys.insert(key);
		key_ok = true;
	}

	//nodata value needs extra treatment
	if (key == "nodata"){
		istringstream ss(value);
		if (!(ss >> nodata_value)) return false;
		nodata_string = value;
	}

	//Using WGS_84 coordinate system
	if (key == "latitude")  location_wgs84 |= 1;
	else if (key == "longitude") location_wgs84 |= 2;
	else if (key == "altitude")  location_wgs84 |= 4;

	//Using an EPSG coordinate system
	if (key == "easting")  location_epsg |= 1;
	else if (key == "northing") location_epsg |= 2;
	else if (key == "altitude") location_epsg |= 4;
	else if (key == "epsg")     location_epsg |= 8;

	//Now do some value checks
	if (key == "epsg"){
		istringstream ss(value);
		int intvalue;
		if (!(ss >> intvalue)) return false;
392
	}
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411

	if (SMETCommon::all_decimal_header_values.find(key) != SMETCommon::all_decimal_header_values.end()){
		//check if value is a double value
		if (!SMETCommon::is_decimal(value)) return false;
	}

	if ((location_epsg == 15) || (location_wgs84 == 7))
		location_in_header = true;

	//Rudimentary check on keys: fields, units_offset, units_multiplier
	if ((key == "fields") || (key == "units_offset") || (key == "units_multiplier"))
		key_ok = check_fields(key, value);

	return key_ok;
}

bool SMETWriter::check_fields(const std::string& key, const std::string& value)
{
	vector<string> tmp_vec;
412
	const size_t counter = SMETCommon::readLineToVec(value, tmp_vec);
413
414
415
416
417
418
419

	//Firstly: Check if number of fields is consistent
	if (nr_of_fields != 0){
		if (counter != nr_of_fields) return false;
	} else {
		nr_of_fields = counter;
	}
420

421
	if (key == "fields"){
422
        size_t count_wgs84 = 0, count_epsg = 0;
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455

		//check if location is in data and if timestamp is present
		for (size_t ii = 0; ii<tmp_vec.size(); ii++){
			if (tmp_vec[ii] == "latitude") count_wgs84++;
			else if (tmp_vec[ii] == "longitude") count_wgs84++;
			else if (tmp_vec[ii] == "easting") count_epsg++;
			else if (tmp_vec[ii] == "northing") count_epsg++;

			if (tmp_vec[ii] == "altitude") {
				count_wgs84++;
				count_epsg++;
			}

			if (tmp_vec[ii] == "timestamp"){
				if (timestamp_present) return false; //no duplicate timestamp field allowed
				timestamp_present = true;
				timestamp_field = ii;
			}

			if (tmp_vec[ii] == "julian"){
				if (julian_present) return false; //no duplicate julian field allowed
				julian_present = true;
				julian_field = ii;
			}
		}

		if (count_wgs84 == 3)
			location_in_data_wgs84 = true;

		if (count_epsg == 3)
			location_in_data_epsg = true;
	} else {
		//every value in units_offset and units_multiplier must be a decimal
456
		for (vector<string>::const_iterator it = tmp_vec.begin(); it != tmp_vec.end(); ++it)
457
458
459
460
461
462
463
464
465
466
467
468
			if (!SMETCommon::is_decimal(*it)) return false;
	}

	return true;
}

bool SMETWriter::valid_header()
{
	if (mandatory_header_keys.size() != 3)
		return false;

	if (location_in_data_epsg){ //EPSG code must be in the header anyway
469
		const map<string,string>::const_iterator it = header.find("epsg");
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
		if (it == header.end()){
			return false;
		} else {
			return true;
		}
	}

	if (location_in_header || location_in_data_wgs84)
		return true;

	return false;
}

void SMETWriter::write(const std::vector<std::string>& vec_timestamp, const std::vector<double>& data)
{
485
486
	if (!SMETCommon::validFileAndPath(filename)) throw SMETException("Invalid file name \""+filename+"\"", AT);
	errno = 0;
487
	
488
489
490
491
	if (append_mode) {
		//check where to insert the new data
		//remove everything from there on
	}
492
	
493
	ofstream fout;
494
	fout.open(filename.c_str(), ios::binary);
495
	if (fout.fail()) {
496
		ostringstream ss;
497
		ss << "Error opening file \"" << filename << "\" for writing, possible reason: " << strerror(errno);
498
499
		throw SMETException(ss.str(), SMET_AT);
	}
500

501
	write_header(fout); //Write the header info, always in ASCII format
502

503
	if (nr_of_fields == 0) {
504
		fout.close();
505
506
507
		return;
	}

508
509
	if (!timestamp_present) {
		fout.close();
510
		throw SMETException("No timestamp present when writing file \""+filename+"\", use write(const vector<double>& data)", SMET_AT);
511
	}
512
513

	const size_t nr_of_data_fields = nr_of_fields - 1;
514
	if (nr_of_fields<=1) { //avoid division by zero in the next block
515
		cerr << "[W] Attempting to write a dataset that contains no fields to file \"" + filename + "\"!\n";
516
		fout.close();
517
		return;
518
	}
519

520
	const size_t nr_of_lines = data.size() / (nr_of_fields-1);
521
522
	if ((nr_of_lines != vec_timestamp.size()) || ((data.size() % (nr_of_fields-1)) != 0)) {
		fout.close();
523
		throw SMETException("Inconsistency between the number of timestamp and number of data points detected for file \""+filename+"\", recheck your data", SMET_AT);
524
	}
525

526
	std::vector<double> current_data(nr_of_fields-1);
527
528
	check_formatting();

529
530
	if (smet_type == ASCII) {
		for (size_t ii=0; ii<nr_of_lines; ii++) {
531
			const size_t offset = ii*(nr_of_fields-1);
532
			if (!data.empty())
533
				copy(data.begin()+offset, data.begin()+offset+nr_of_data_fields, current_data.begin());
534
			write_data_line_ascii(vec_timestamp[ii], current_data, fout);
535
536
		}
	} else {
537
		fout.close();
538
		throw SMETException("Cannot write binary file \""+filename+"\" with a timestamp, use julian instead", SMET_AT);
539
540
	}

541
	fout.close();
542
543
544
545
}

void SMETWriter::write(const std::vector<double>& data)
{
546
547
	if (!SMETCommon::validFileAndPath(filename)) throw SMETException("Invalid file name \""+filename+"\"", AT);
	errno = 0;
548
	std::ofstream fout;
549
	fout.open(filename.c_str(), ios::binary);
550
	if (fout.fail()) {
551
		ostringstream ss;
552
		ss << "Error opening file \"" << filename << "\" for writing, possible reason: " << strerror(errno);
553
554
		throw SMETException(ss.str(), SMET_AT);
	}
555

556
	write_header(fout); //Write the header info, always in ASCII format
557
558

	if (nr_of_fields == 0){
559
		fout.close();
560
561
562
		return;
	}

563
	const size_t nr_of_lines = data.size() / nr_of_fields;
564
565
	if ((data.size() % nr_of_fields) != 0) {
		fout.close();
566
		throw SMETException("Inconsistency between data and header fields detected in file \""+filename+"\", recheck your data", SMET_AT);
567
	}
568

569
	std::vector<double> current_data(nr_of_fields);
570
571
572
573
	check_formatting();

	if (smet_type == ASCII){
		for (size_t ii=0; ii<nr_of_lines; ii++){
574
			if (!data.empty())
575
				copy(data.begin()+ii*nr_of_fields, data.begin()+ii*nr_of_fields+nr_of_fields, current_data.begin());
576
			write_data_line_ascii("0000-01-01T00:00", current_data, fout); //dummy time
577
578
579
		}
	} else {
		for (size_t ii=0; ii<nr_of_lines; ii++){
580
			if (!data.empty())
581
				copy(data.begin()+ii*nr_of_fields, data.begin()+ii*nr_of_fields+nr_of_fields, current_data.begin());
582
			write_data_line_binary(current_data, fout);
583
		}
584

585
586
587
		file_is_binary = false;
	}

588
	fout.close();
589
590
}

591
void SMETWriter::write_header(std::ofstream& fout)
592
{
593
594
	if (!valid_header()) {
		fout.close();
595
		throw SMETException("The header data you supplied is not valid, file \""+filename+"\" cannot be written", SMET_AT);
596
	}
597

598
599
600
601
	//write signature
	fout << "SMET " << SMETCommon::smet_version << " ";
	if (smet_type == ASCII) fout << "ASCII" << "\n";
	else fout << "BINARY" << "\n";
602

603
	fout << "[HEADER]" << "\n";
604
	fout << "station_id       = " << header["station_id"] << "\n";
605

606
	map<string,string>::const_iterator it = header.find("station_name");
607
	if (it != header.end())
608
		fout << "station_name     = " << it->second << "\n";
609
610
611

	if (location_in_header){
		if (location_wgs84 == 7){
612
613
614
			fout << "latitude         = " << header["latitude"]  << "\n";
			fout << "longitude        = " << header["longitude"] << "\n";
			fout << "altitude         = " << header["altitude"]  << "\n";
615
616
617
		}

		if (location_epsg == 15){
618
619
			fout << "easting          = " << header["easting"]   << "\n";
			fout << "northing         = " << header["northing"]  << "\n";
620
			if (location_wgs84 != 7)
621
622
				fout << "altitude        = " << header["altitude"]  << "\n";
			fout << "epsg             = " << header["epsg"]  << "\n";
623
624
625
		}
	} else {
		if (location_in_data_epsg)
626
			fout << "epsg             = " << header["epsg"]      << "\n";
627
628
	}

629
	fout << "nodata           = " << header["nodata"] << "\n";
630
631
632

	//Optional header keys:
	it = header.find("tz");
633
	if (it != header.end())
634
		fout << "tz               = " << it->second << "\n";
635
636

	it = header.find("creation");
637
	if (it != header.end())
638
		fout << "creation         = " << it->second << "\n";
639
640

	it = header.find("source");
641
	if (it != header.end())
642
		fout << "source           = " << it->second << "\n";
643
644

	it = header.find("units_offset");
645
	if (it != header.end())
646
		fout << "units_offset     = " << it->second << "\n";
647
648

	it = header.find("units_multiplier");
649
	if (it != header.end())
650
		fout << "units_multiplier = " << it->second << "\n";
651
652

	it = header.find("comment");
653
	if (it != header.end())
654
		fout << "comment          = " << it->second << "\n";
655

656
	for (size_t ii=0; ii<other_header_keys.size(); ii++){
657
		fout << other_header_keys[ii] << " = " << header[other_header_keys[ii]] << "\n";
658
659
	}

660
	fout << "fields           = " << header["fields"] << "\n";
661
662
663
	fout << "[DATA]" << endl;
}

664
void SMETWriter::write_data_line_binary(const std::vector<double>& data, std::ofstream& fout)
665
666
667
668
669
{
	const char eoln = '\n';

	if (!file_is_binary){ //open it as binary file
		fout.close();
670
		errno = 0;
671
		fout.open(filename.c_str(), ios::out | ios::app | ios::binary); //reopen as binary file
672
		if (fout.fail()) {
673
			ostringstream ss;
674
675
676
			ss << "Error writing to file \"" << filename << "\", possible reason: " << strerror(errno);
			throw SMETException(ss.str(), SMET_AT);
		}
677
678
679
680
681
682

		file_is_binary = true;
	}

	for (size_t ii = 0; ii < data.size(); ii++){
		if (julian_present && (julian_field == ii)){
683
			const double julian = data[ii];
684
685
			fout.write((char*)&julian, sizeof(double)); //the julian date is written in 64bit IEEE754 precision
		} else {
686
			const float val = (float)data[ii];
687
688
689
690
691
692
693
			fout.write((char*)&val, sizeof(float)); //normal data fields are written in 32bit IEEE754 precision
		}
	}

	fout.write((char*)&eoln, sizeof(char));
}

694
void SMETWriter::write_data_line_ascii(const std::string& timestamp, const std::vector<double>& data, std::ofstream& fout)
695
696
697
698
699
{
	fout.fill(' ');
	fout << right;
	fout << fixed;

700
	if ((data.empty()) && timestamp_present) fout << timestamp;
701
702
703
704
705
706
707
708
709

	for (size_t ii = 0; ii < data.size(); ii++){
		if (ii > 0) fout << " ";
		if (timestamp_present && (timestamp_field == ii))	fout << timestamp << " ";

		fout << setw(ascii_width[ii]) << setprecision(ascii_precision[ii]);
		if (data[ii] == nodata_value) fout << nodata_string; //to have a nicer representation
		else fout << data[ii];
	}
710
	fout << "\n";
711
712
713
714
}

void SMETWriter::check_formatting()
{
715
	const size_t nr_of_data_fields = (timestamp_present)? nr_of_fields-1 : nr_of_fields;
716
717
718
719
720
721
722
723
724
725
726
727

	if ((ascii_precision.size() != nr_of_data_fields) || (ascii_width.size() != nr_of_data_fields)){
		ascii_precision.resize(nr_of_data_fields, 3);
		ascii_width.resize(nr_of_data_fields, 8);
	}

	if (julian_present){
		ascii_precision[julian_field] = 8;
		ascii_width[julian_field] = 16;
	}
}

728
void SMETWriter::set_width(const std::vector<int>& vec_width)
729
730
731
732
{
	ascii_width = vec_width;
}

733
void SMETWriter::set_precision(const std::vector<int>& vec_precision)
734
735
736
737
{
	ascii_precision = vec_precision;
}

738
739
740

////////////////////////////////////////////////////////////
//// SMETReader class
741
742
const size_t SMETReader::streampos_every_n_lines = 2000; //save streampos every 2000 lines of data

743
744
745
746
747
748
749
750
751
752
753
SMETReader::SMETReader(const std::string& in_fname)
            : data_start_fpointer(), vec_offset(), vec_multiplier(), vec_fieldnames(),
              header(), indexer(),
              filename(in_fname), timestamp_start("-4714-11-24T00:00"),
              timestamp_end("9999-12-31T00:00"), nodata_value(-999.),
              julian_start(0.), julian_end(5373483.5),
              nr_of_fields(0), timestamp_field(0), julian_field(0),
              location_wgs84(0), location_epsg(0), location_data_wgs84(0), location_data_epsg(0),
              eoln('\n'),
              timestamp_present(false), julian_present(false), isAscii(true), mksa(true),
              timestamp_interval(false), julian_interval(false)
754
755
756
{
	std::ifstream fin; //Input file streams
	fin.clear();
757
	if (!SMETCommon::fileExists(filename)) throw SMETException("File '"+filename+"' does not exists", AT); //prevent invalid filenames
758
	errno = 0;
759
	fin.open (filename.c_str(), ios::in|ios::binary); //ascii does end of line translation, which messes up the pointer code
760
	if (fin.fail()) {
761
		ostringstream ss;
762
		ss << "Error opening file \"" << filename << "\" for reading, possible reason: " << strerror(errno);
763
764
765
		ss << " Please check file existence and permissions!";
		throw SMETException(ss.str(), SMET_AT);
	}
766
767
768
769
770
771
772
773
774
775
776
777

	try {
		eoln = SMETCommon::getEoln(fin); //get the end of line character for the file
		read_header(fin);
		process_header();
	} catch(...){
		cleanup(fin); //closes file
		throw;
	}
	cleanup(fin); //closes file
}

778
SMETReader::~SMETReader() {}
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793

void SMETReader::cleanup(std::ifstream& fin) throw()
{
	if (fin.is_open()) //close fin if open
		fin.close();
}

void SMETReader::convert_to_MKSA(const bool& in_mksa)
{
	mksa = in_mksa;
}

std::string SMETReader::get_field_name(const size_t& nr_of_field)
{
	if (nr_of_field < nr_of_fields){
794
		return vec_fieldnames[nr_of_field];
795
	} else {
796
		ostringstream ss;
797
798
799
		ss << "Trying to access field #" << nr_of_field << " (starting from 0) of " << nr_of_fields << " fields in file \"" << filename << "\". ";
		ss << "This is out of bounds!";
		throw SMETException(ss.str(), SMET_AT);
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
	}
}

size_t SMETReader::get_nr_of_fields() const
{
	return nr_of_fields;
}

void SMETReader::get_units_conversion(std::vector<double>& offset, std::vector<double>& multiplier) const
{
	multiplier = vec_multiplier;
	offset = vec_offset;
}

bool SMETReader::location_in_header(const LocationType& type) const
{
	if ((location_epsg == 15) && (type == EPSG)){
		return true;
	} else if ((location_wgs84 == 7) && (type == WGS84)){
		return true;
	}

	return false;
}

bool SMETReader::location_in_data(const LocationType& type) const
{
	if ((location_epsg == 8) && (location_data_epsg == 7) && (type == EPSG)){
		return true;
	} else if ((location_data_wgs84 == 7) && (type == WGS84)){
		return true;
	}

	return false;
}

void SMETReader::process_header()
{
	vector<string> tmp_vec;
	set<string> obligatory_keys;
840
	for (map<string,string>::iterator it = header.begin(); it != header.end(); ++it){
841
842
		if (SMETCommon::all_mandatory_header_keys.find(it->first) != SMETCommon::all_mandatory_header_keys.end())
			obligatory_keys.insert(it->first);
843

844
845
		if (it->first == "fields"){
			SMETCommon::readLineToVec(it->second, tmp_vec);
846
			string newfields;
847
			if (!tmp_vec.empty()){
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
				for (size_t ii=0; ii<tmp_vec.size(); ii++){
					if (tmp_vec[ii] == "timestamp"){
						timestamp_present = true;
						timestamp_field = ii;
					} else {
						if (nr_of_fields > 0) newfields += " ";
						vec_fieldnames.push_back(tmp_vec[ii]);
						newfields += tmp_vec[ii];
						nr_of_fields++;
					}

					if (tmp_vec[ii] == "julian"){
						julian_present = true;
						julian_field = ii;
					}
863

864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
					//Using WGS_84 coordinate system
					if (tmp_vec[ii] == "latitude")  location_data_wgs84 |= 1;
					else if (tmp_vec[ii] == "longitude") location_data_wgs84 |= 2;
					else if (tmp_vec[ii] == "altitude")  location_data_wgs84 |= 4;

					//Using an EPSG coordinate system
					if (tmp_vec[ii] == "easting")  location_data_epsg |= 1;
					else if (tmp_vec[ii] == "northing") location_data_epsg |= 2;
					else if (tmp_vec[ii] == "altitude") location_data_epsg |= 4;
				}
				it->second = newfields;
			}
		}

		if (it->first == "nodata")
			nodata_value = SMETCommon::convert_to_double(it->second);

		//Using WGS_84 coordinate system
		if (it->first == "latitude")  location_wgs84 |= 1;
		else if (it->first == "longitude") location_wgs84 |= 2;
		else if (it->first == "altitude")  location_wgs84 |= 4;

		//Using an EPSG coordinate system
		if (it->first == "easting")  location_epsg |= 1;
		else if (it->first == "northing") location_epsg |= 2;
		else if (it->first == "altitude") location_epsg |= 4;
		else if (it->first == "epsg")     location_epsg |= 8;

892
893
894
		//Now do a value check on EPSG
		if (it->first == "epsg")
			SMETCommon::convert_to_int(it->second);
895
896
897
898
	}

	if (get_header_value("units_offset") != ""){
		vector<string> tmp_offset;
899
		string offsetstring;
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
		SMETCommon::readLineToVec(get_header_value("units_offset"), tmp_offset);

		for (size_t ii=0; ii<tmp_offset.size(); ii++){
			if (!timestamp_present || (ii != timestamp_field)){
				if (ii>0) offsetstring += " ";
				offsetstring += tmp_offset[ii];
				vec_offset.push_back(SMETCommon::convert_to_double(tmp_offset[ii]));
			}
		}
		header["units_offset"] = offsetstring;
	} else {
		vec_offset.resize(nr_of_fields, 0.0);
	}

	if (get_header_value("units_multiplier") != ""){
		vector<string> tmp_multiplier;
916
		string multiplierstring;
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
		SMETCommon::readLineToVec(get_header_value("units_multiplier"), tmp_multiplier);

		for (size_t ii=0; ii<tmp_multiplier.size(); ii++){
			if (!timestamp_present || (ii != timestamp_field)){
				if (ii>0) multiplierstring += " ";
				multiplierstring += tmp_multiplier[ii];
				vec_multiplier.push_back(SMETCommon::convert_to_double(tmp_multiplier[ii]));
			}
		}
		header["units_multiplier"] = multiplierstring;
	} else {
		vec_multiplier.resize(nr_of_fields, 1.0);
	}

	if (obligatory_keys.size() != SMETCommon::all_mandatory_header_keys.size())
932
		throw SMETException("\""+filename+"\" is not a valid SMET file, mandatory information in header is missing", SMET_AT);
933

934
	if ((location_wgs84 == 7) || (location_epsg == 15) || (location_data_wgs84 == 7)
935
936
937
	    || ((location_epsg == 8) && (location_data_epsg == 7))){
		//location info present somewhere
	} else {
938
		throw SMETException("\""+filename+"\" is not a valid SMET file, mandatory location info is missing (header and data)", SMET_AT);
939
	}
940
941
942

	const size_t nr_offset = vec_offset.size();
	const size_t nr_multiplier = vec_multiplier.size();
943
944
945
946
	if (nr_offset!=nr_of_fields || nr_multiplier!=nr_of_fields) {
		const size_t Nfields = (timestamp_present)? nr_of_fields+1 : nr_of_fields;
		const size_t Noffset = (timestamp_present)? nr_offset+1 : nr_offset;
		const size_t Nmultiplier =(timestamp_present)? nr_multiplier+1 : nr_multiplier;
947
		std::ostringstream ss;
948
949
		ss << "File \"" << filename << "\" has " << Nfields << " data fields, but specifies ";
		ss << Noffset << " offsets and " << Nmultiplier << " multipliers. ";
950
951
952
		ss << "The number of offsets and multipliers MUST fit the number of fields, including the (optional) timestamp column.";
		throw SMETException(ss.str(), SMET_AT);
	}
953
954
955
956
957
}

void SMETReader::read_header(std::ifstream& fin)
{
	//1. Read signature
958
	std::string line;
959
960
961
962
963
	vector<string> tmpvec;
	getline(fin, line, eoln); //read complete signature line
	SMETCommon::stripComments(line);
	SMETCommon::readLineToVec(line, tmpvec);
	checkSignature(tmpvec, isAscii);
964

965
	//2. Read Header
966
	while (!fin.eof() && (fin.peek() != '[')) //skip lines until '[' is found
967
968
969
		getline(fin, line, eoln);

	getline(fin, line, eoln);
970

971
972
973
974
975
	SMETCommon::stripComments(line);
	SMETCommon::trim(line);
	SMETCommon::toUpper(line);

	if (line != "[HEADER]")
976
		throw SMETException("Read \"" + line + "\" in "+ filename + " when expecting \"[HEADER]\"", AT);
977
978
979
980
981
982

	while (!fin.eof() && (fin.peek() != '[')){ //Read until next section
		getline(fin, line, eoln);
		SMETCommon::stripComments(line);
		SMETCommon::trim(line);

983
		if (!line.empty()) {
984
			if (!SMETCommon::readKeyValuePair(line, "=", header))
985
				throw SMETException("Invalid key value pair in file \""+filename+"\", in [Header] section: " + line, SMET_AT);
986
987
988
989
990
		}

	}

	//Read [DATA] section tag
991
	getline(fin, line, eoln);
992
993
994
995
996
	SMETCommon::stripComments(line);
	SMETCommon::trim(line);
	SMETCommon::toUpper(line);

	if (line != "[DATA]")
997
		throw SMETException("In '"+filename+"', expected [DATA] but found: "+line, SMET_AT);
998

999
	data_start_fpointer = fin.tellg();
1000
}
For faster browsing, not all history is shown. View entire blame