WSL/SLF GitLab Repository

libsmet.cc 36.8 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
29
30
31

using namespace std;

namespace smet {

const std::string SMETCommon::smet_version = "1.1";
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>();

32
SMETException::SMETException(const std::string& message, const std::string& position) : msg()
33
{
34
	if (position.empty()) {
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
		msg = "At unknown position: " + message;
	} else {
		msg = position + ": " + message;
	}
}

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;
}

double SMETCommon::convert_to_double(const std::string& in_string)
{
84
85
	char* conversion_end = NULL;
	const double conversion_value = strtod(in_string.c_str(), &conversion_end);
86

87
88
	if (*conversion_end == '\0') {
		return conversion_value;
89
90
91
	} else {
		throw SMETException("Value \"" + in_string + "\" cannot be converted to double", SMET_AT);
	}
92
93
}

94
95
96
97
int SMETCommon::convert_to_int(const std::string& in_string)
{
	istringstream ss(in_string);
	int value;
98
	if (!(ss >> value)) throw SMETException("Value \"" + in_string + "\" cannot be converted to int", SMET_AT);
99
100
101
102

	return value;
}

103
104
105
106
107
108
109
110
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
	if(( std::string::npos == startpos ) || ( std::string::npos == endpos)) {
111
		str.clear();
112
	} else {
113
114
		str.erase(endpos+1); //right trim
		str.erase(0, startpos); //left trim
115
116
117
118
	}
}

bool SMETCommon::readKeyValuePair(const std::string& in_line, const std::string& delimiter,
119
                                  std::map<std::string,std::string>& out_map)
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
{
	//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 '='
	}


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

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

138
		if (key.empty() || value.empty()) {
139
140
141
142
143
144
145
146
147
148
149
150
151
			return false;
		}

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

	return true;
}

void SMETCommon::stripComments(std::string& str)
{
152
	const size_t found = str.find_first_of("#;");
153
154
155
156
157
158
159
	if (found != std::string::npos){
		str.erase(found); //rest of line disregarded
	}
}

void SMETCommon::toUpper(std::string& str)
{
160
	std::transform(str.begin(), str.end(),str.begin(), ::toupper);
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
}

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;

214
		if (!tmp_string.empty()) {
215
216
			vec_string.push_back(tmp_string);
		}
217
		tmp_string.clear();
218
219
220
221
222
	}

	return vec_string.size();
}

223
SMETWriter::SMETWriter(const std::string& in_filename, const SMETType& in_type, const bool& in_gzip)
224
           : other_header_keys(), ascii_precision(), ascii_width(), header(), mandatory_header_keys(), fout(),
225
             filename(in_filename), nodata_string(), smet_type(in_type), nodata_value(-999.), nr_of_fields(0),
226
             julian_field(0), timestamp_field(0), location_wgs84(0), location_epsg(0), gzip(in_gzip),
227
             location_in_header(false), location_in_data_wgs84(false), location_in_data_epsg(false),
228
             timestamp_present(false), julian_present(false), file_is_binary(false)
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
{

}

SMETWriter::~SMETWriter()
{
	cleanup();
}

void SMETWriter::cleanup() throw()
{
	//clear ios flags
	fout << resetiosflags(ios_base::fixed | ios_base::left);

	if (fout.is_open()) //close fout if open
		fout.close();
}

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()){
251
		ostringstream ss;
252
253
254
255
256
257
258
259
260
261
262
263
		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());
	} else {
264
		//It's a non-standard header value
265
		ostringstream ss;
266
267
		ss << value; //for nodata
		set_header_value(key, ss.str());
268
269
270
271
272
273
274
	}
}

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)){
275
		header[key] = value;
276
277
278
279

		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);
280
281
282
283
284
285
286
	} 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)
{
287
	bool key_ok = true;
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

	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;
317
	}
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

	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;
337
	const size_t counter = SMETCommon::readLineToVec(value, tmp_vec);
338
339
340
341
342
343
344

	//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;
	}
345

346
	if (key == "fields"){
347
        size_t count_wgs84 = 0, count_epsg = 0;
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380

		//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
381
		for (vector<string>::const_iterator it = tmp_vec.begin(); it != tmp_vec.end(); ++it)
382
383
384
385
386
387
388
389
390
391
			if (!SMETCommon::is_decimal(*it)) return false;
	}

	return true;
}

void SMETWriter::write_signature()
{
	fout << "SMET " << SMETCommon::smet_version << " ";
	if (smet_type == ASCII)
392
		fout << "ASCII" << "\n";
393
	else
394
		fout << "BINARY" << "\n";
395
396
397
398
399
400
401
402
}

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
403
		const map<string,string>::const_iterator it = header.find("epsg");
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
		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)
{
419
	fout.open(filename.c_str(), ios::binary);
420
	if (fout.fail()) {
421
		ostringstream ss;
422
		ss << "Error opening file \"" << filename << "\" for writing, possible reason: " << strerror(errno);
423
424
		throw SMETException(ss.str(), SMET_AT);
	}
425
426
427
428
429
430
431
432

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

	if (nr_of_fields == 0){
		cleanup();
		return;
	}

433
	if (!timestamp_present)
434
		throw SMETException("No timestamp present when writing file \""+filename+"\", use write(const vector<double>& data)", SMET_AT);
435
436

	const size_t nr_of_data_fields = nr_of_fields - 1;
437
	if(nr_of_fields<=1) { //avoid division by zero in the next block
438
439
		cerr << "[W] Attempting to write a dataset that contains no fields to file \"" + filename + "\"!\n";
		return;
440
	}
441

442
	const size_t nr_of_lines = data.size() / (nr_of_fields-1);
443
	if ((nr_of_lines != vec_timestamp.size()) || ((data.size() % (nr_of_fields-1)) != 0))
444
		throw SMETException("Inconsistency between the number of timestamp and number of data points detected for file \""+filename+"\", recheck your data", SMET_AT);
445

446
	std::vector<double> current_data(nr_of_fields-1);
447
448
449
450
451
	check_formatting();

	if (smet_type == ASCII){
		for (size_t ii=0; ii<nr_of_lines; ii++){
			const size_t offset = ii*(nr_of_fields-1);
452
			if (!data.empty())
453
				copy(data.begin()+offset, data.begin()+offset+nr_of_data_fields, current_data.begin());
454
			write_data_line_ascii(vec_timestamp[ii], current_data);
455
456
		}
	} else {
457
		throw SMETException("Cannot write binary file \""+filename+"\" with a timestamp, use julian instead", SMET_AT);
458
459
460
461
462
463
464
	}

	cleanup();
}

void SMETWriter::write(const std::vector<double>& data)
{
465
	fout.open(filename.c_str(), ios::binary);
466
	if (fout.fail()) {
467
		ostringstream ss;
468
		ss << "Error opening file \"" << filename << "\" for writing, possible reason: " << strerror(errno);
469
470
		throw SMETException(ss.str(), SMET_AT);
	}
471
472
473
474
475
476
477
478

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

	if (nr_of_fields == 0){
		cleanup();
		return;
	}

479
	const size_t nr_of_lines = data.size() / nr_of_fields;
480
	if ((data.size() % nr_of_fields) != 0)
481
		throw SMETException("Inconsistency between data and header fields detected in file \""+filename+"\", recheck your data", SMET_AT);
482

483
	std::vector<double> current_data(nr_of_fields);
484
485
486
487
	check_formatting();

	if (smet_type == ASCII){
		for (size_t ii=0; ii<nr_of_lines; ii++){
488
			if (!data.empty())
489
490
491
492
493
				copy(data.begin()+ii*nr_of_fields, data.begin()+ii*nr_of_fields+nr_of_fields, current_data.begin());
			write_data_line_ascii("0000-01-01T00:00", current_data); //dummy time
		}
	} else {
		for (size_t ii=0; ii<nr_of_lines; ii++){
494
			if (!data.empty())
495
496
497
				copy(data.begin()+ii*nr_of_fields, data.begin()+ii*nr_of_fields+nr_of_fields, current_data.begin());
			write_data_line_binary(current_data);
		}
498

499
500
501
502
503
504
505
506
507
		file_is_binary = false;
	}

	cleanup();
}

void SMETWriter::write_header()
{
	if (!valid_header())
508
		throw SMETException("The header data you supplied is not valid, file \""+filename+"\" cannot be written", SMET_AT);
509
510
511

	write_signature();

512
	fout << "[HEADER]" << "\n";
513
	fout << "station_id          = " << header["station_id"] << "\n";
514

515
	map<string,string>::const_iterator it = header.find("station_name");
516
	if (it != header.end())
517
		fout << "station_name    = " << it->second << "\n";
518
519
520

	if (location_in_header){
		if (location_wgs84 == 7){
521
522
523
			fout << "latitude              = " << header["latitude"]  << "\n";
			fout << "longitude           = " << header["longitude"] << "\n";
			fout << "altitude              = " << header["altitude"]  << "\n";
524
525
526
		}

		if (location_epsg == 15){
527
528
			fout << "easting               = " << header["easting"]   << "\n";
			fout << "northing             = " << header["northing"]  << "\n";
529
			if (location_wgs84 != 7)
530
531
				fout << "altitude           = " << header["altitude"]  << "\n";
			fout << "epsg                   = " << header["epsg"]  << "\n";
532
533
534
		}
	} else {
		if (location_in_data_epsg)
535
			fout << "epsg                   = " << header["epsg"]      << "\n";
536
537
	}

538
	fout << "nodata               = " << header["nodata"] << "\n";
539
540
541

	//Optional header keys:
	it = header.find("tz");
542
	if (it != header.end())
543
		fout << "tz                        = " << it->second << "\n";
544
545

	it = header.find("creation");
546
	if (it != header.end())
547
		fout << "creation             = " << it->second << "\n";
548
549

	it = header.find("source");
550
	if (it != header.end())
551
		fout << "source               = " << it->second << "\n";
552
553

	it = header.find("units_offset");
554
	if (it != header.end())
555
		fout << "units_offset       = " << it->second << "\n";
556
557

	it = header.find("units_multiplier");
558
	if (it != header.end())
559
		fout << "units_multiplier = " << it->second << "\n";
560
561

	it = header.find("comment");
562
	if (it != header.end())
563
		fout << "comment          = " << it->second << "\n";
564

565
	for (size_t ii=0; ii<other_header_keys.size(); ii++){
566
		fout << other_header_keys[ii] << " = " << header[other_header_keys[ii]] << "\n";
567
568
	}

569
	fout << "fields                  = " << header["fields"] << "\n";
570
571
572
573
574
575
576
577
578
579
	fout << "[DATA]" << endl;
}

void SMETWriter::write_data_line_binary(const std::vector<double>& data)
{
	const char eoln = '\n';

	if (!file_is_binary){ //open it as binary file
		fout.close();
		fout.open(filename.c_str(), ios::out | ios::app | ios::binary); //reopen as binary file
580
		if (fout.fail()) {
581
			ostringstream ss;
582
583
584
			ss << "Error writing to file \"" << filename << "\", possible reason: " << strerror(errno);
			throw SMETException(ss.str(), SMET_AT);
		}
585
586
587
588
589
590

		file_is_binary = true;
	}

	for (size_t ii = 0; ii < data.size(); ii++){
		if (julian_present && (julian_field == ii)){
591
			const double julian = data[ii];
592
593
			fout.write((char*)&julian, sizeof(double)); //the julian date is written in 64bit IEEE754 precision
		} else {
594
			const float val = (float)data[ii];
595
596
597
598
599
600
601
602
603
604
605
606
607
			fout.write((char*)&val, sizeof(float)); //normal data fields are written in 32bit IEEE754 precision
		}
	}

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

void SMETWriter::write_data_line_ascii(const std::string& timestamp, const std::vector<double>& data)
{
	fout.fill(' ');
	fout << right;
	fout << fixed;

608
	if ((data.empty()) && timestamp_present) fout << timestamp;
609
610
611
612
613
614
615
616
617

	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];
	}
618
	fout << "\n";
619
620
621
622
}

void SMETWriter::check_formatting()
{
623
	const size_t nr_of_data_fields = (timestamp_present)? nr_of_fields-1 : nr_of_fields;
624
625
626
627
628
629
630
631
632
633
634
635

	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;
	}
}

636
void SMETWriter::set_width(const std::vector<int>& vec_width)
637
638
639
640
{
	ascii_width = vec_width;
}

641
void SMETWriter::set_precision(const std::vector<int>& vec_precision)
642
643
644
645
{
	ascii_precision = vec_precision;
}

646
647
const size_t SMETReader::streampos_every_n_lines = 2000; //save streampos every 2000 lines of data

648
649
650
651
652
653
654
655
656
657
658
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)
659
660
661
{
	std::ifstream fin; //Input file streams
	fin.clear();
662
	fin.open (filename.c_str(), ios::in|ios::binary); //ascii does end of line translation, which messes up the pointer code
663
	if (fin.fail()) {
664
		ostringstream ss;
665
		ss << "Error opening file \"" << filename << "\" for reading, possible reason: " << strerror(errno);
666
667
668
		ss << " Please check file existence and permissions!";
		throw SMETException(ss.str(), SMET_AT);
	}
669
670
671
672
673
674
675
676
677
678
679
680

	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
}

681
SMETReader::~SMETReader() {}
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696

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){
697
		return vec_fieldnames[nr_of_field];
698
	} else {
699
		ostringstream ss;
700
701
702
		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);
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
	}
}

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;
743
	for (map<string,string>::iterator it = header.begin(); it != header.end(); ++it){
744
745
		if (SMETCommon::all_mandatory_header_keys.find(it->first) != SMETCommon::all_mandatory_header_keys.end())
			obligatory_keys.insert(it->first);
746

747
748
		if (it->first == "fields"){
			SMETCommon::readLineToVec(it->second, tmp_vec);
749
			string newfields;
750
			if (!tmp_vec.empty()){
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
				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;
					}
766

767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
					//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;

795
796
797
		//Now do a value check on EPSG
		if (it->first == "epsg")
			SMETCommon::convert_to_int(it->second);
798
799
800
801
	}

	if (get_header_value("units_offset") != ""){
		vector<string> tmp_offset;
802
		string offsetstring;
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
		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;
819
		string multiplierstring;
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
		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())
835
		throw SMETException("\""+filename+"\" is not a valid SMET file, mandatory information in header is missing", SMET_AT);
836

837
	if ((location_wgs84 == 7) || (location_epsg == 15) || (location_data_wgs84 == 7)
838
839
840
	    || ((location_epsg == 8) && (location_data_epsg == 7))){
		//location info present somewhere
	} else {
841
		throw SMETException("\""+filename+"\" is not a valid SMET file, mandatory location info is missing (header and data)", SMET_AT);
842
	}
843
844
845

	const size_t nr_offset = vec_offset.size();
	const size_t nr_multiplier = vec_multiplier.size();
846
847
848
849
	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;
850
		std::ostringstream ss;
851
852
		ss << "File \"" << filename << "\" has " << Nfields << " data fields, but specifies ";
		ss << Noffset << " offsets and " << Nmultiplier << " multipliers. ";
853
854
855
		ss << "The number of offsets and multipliers MUST fit the number of fields, including the (optional) timestamp column.";
		throw SMETException(ss.str(), SMET_AT);
	}
856
857
858
859
860
}

void SMETReader::read_header(std::ifstream& fin)
{
	//1. Read signature
861
	std::string line;
862
863
864
865
866
	vector<string> tmpvec;
	getline(fin, line, eoln); //read complete signature line
	SMETCommon::stripComments(line);
	SMETCommon::readLineToVec(line, tmpvec);
	checkSignature(tmpvec, isAscii);
867

868
	//2. Read Header
869
	while (!fin.eof() && (fin.peek() != '[')) //skip lines until '[' is found
870
871
872
		getline(fin, line, eoln);

	getline(fin, line, eoln);
873

874
875
876
877
878
	SMETCommon::stripComments(line);
	SMETCommon::trim(line);
	SMETCommon::toUpper(line);

	if (line != "[HEADER]")
879
		throw SMETException("Read \"" + line + "\" in "+ filename + " when expecting \"[HEADER]\"", AT);
880
881
882
883
884
885

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

886
		if (!line.empty()) {
887
			if (!SMETCommon::readKeyValuePair(line, "=", header))
888
				throw SMETException("Invalid key value pair in file \""+filename+"\", in [Header] section: " + line, SMET_AT);
889
890
891
892
893
		}

	}

	//Read [DATA] section tag
894
	getline(fin, line, eoln);
895
896
897
898
899
900
901
	SMETCommon::stripComments(line);
	SMETCommon::trim(line);
	SMETCommon::toUpper(line);

	if (line != "[DATA]")
		throw SMETException("Section " + line + " in "+ filename + " invalid, expected [DATA]", SMET_AT);

902
	data_start_fpointer = fin.tellg();
903
904
}

905
void SMETReader::checkSignature(const std::vector<std::string>& vecSignature, bool& o_isAscii)
906
907
{
	if ((vecSignature.size() != 3) || (vecSignature[0] != "SMET"))
908
		throw SMETException("The signature of file " + filename + " is invalid. Is it really a SMET file?", SMET_AT);
909

910
	const std::string version = vecSignature[1];
911
	if ((version != "0.9") && (version != "0.95") && (version != "0.99")
912
913
914
915
	    && (version != "1.0") && (version != SMETCommon::smet_version))
		throw SMETException("Unsupported file format version for file " + filename, SMET_AT);

	if(version=="0.9" || version=="0.95" || version=="0.99" || version=="1.0") {
916
		cerr << "[W] SMET specification 1.1 changes the priorities of units_multiplier and units_offset. "
917
918
919
920
921
			<< "Please check/update your files and bring them to 1.1!!" << endl;
	}

	const std::string type = vecSignature[2];
	if (type == "ASCII")
922
		o_isAscii = true;
923
	else if (type == "BINARY")
924
		o_isAscii = false;
925
926
927
928
	else
		throw SMETException("The 3rd column of file " + filename + " must be either ASCII or BINARY", SMET_AT);
}

929
void SMETReader::read(const std::string& i_timestamp_start, const std::string& i_timestamp_end,
930
                      std::vector<std::string>& vec_timestamp, std::vector<double>& vec_data)
931
{
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
	if (!timestamp_present){
		read(vec_timestamp, vec_data);
	} else {
		timestamp_interval = true;
		timestamp_start = i_timestamp_start;
		timestamp_end = i_timestamp_end;

		read(vec_timestamp, vec_data);

		timestamp_interval = false;
	}
}

void SMETReader::read(const double& i_julian_start, const double& i_julian_end, std::vector<double>& vec_data)
{
	if (!julian_present){
		read(vec_data);
	} else {
		julian_interval = true;
		julian_start = i_julian_start;
		julian_end = i_julian_end;

		read(vec_data);

		julian_interval = false;
	}
}

void SMETReader::read(std::vector<std::string>& vec_timestamp, std::vector<double>& vec_data)
{
962
	if (!timestamp_present)
963
		throw SMETException("Requesting to read timestamp when there is none present in \""+filename+"\"", SMET_AT);
964
965
966

	ifstream fin;
	fin.clear();
967
	fin.open (filename.c_str(), ios::in|ios::binary); //ascii mode messes up pointer code on windows (automatic eol translation)
968
	if (fin.fail()) {
969
		ostringstream ss;
970
		ss << "Error opening file \"" << filename << "\" for reading, possible reason: " << strerror(errno);
971
972
		throw SMETException(ss.str(), SMET_AT);
	}
973
974

	try {
975
		streampos fpointer = static_cast<streampos>(-1);
976
		if (timestamp_interval && timestamp_present){
977
			fpointer = indexer.getIndex(timestamp_start);
978
		} else if (julian_interval && julian_present){
979
			fpointer = indexer.getIndex(julian_start);
980
		}
981

982
983
		if(fpointer!=static_cast<streampos>(-1))
			fin.seekg(fpointer); //a previous pointer was found, jump to it
984
		else {
985
986
987
988
989
990
991
992
			if(data_start_fpointer!=static_cast<streampos>(-1))
				fin.seekg(data_start_fpointer); //nothing was found, jump to data start position in the file
			else { //the data section was itself empty (not even containg \n)
				cleanup(fin);
				return;
			}
		}

993
994
		if (fin.fail() || fin.bad())
			fin.seekg(data_start_fpointer);
995

996
997
998
		if (isAscii)
			read_data_ascii(fin, vec_timestamp, vec_data);
		else
999
			throw SMETException("Binary SMET file \""+filename+"\" has no field timestamp, only julian date", SMET_AT);
1000
	} catch(...) {
For faster browsing, not all history is shown. View entire blame