mio::TimeShift Class Reference

Detailed Description

Time corrections.

This filter add offsets to the time at specified timestamps. This is for example usefull to remove the Daylight Saving Time in order to bring the timestamps back to Winter time only (or "Standard Time", as it should always be!) or to correct a clock that has drifted in a data logger.

This takes either a fixed offset or a correction file that contains on each line an ISO formatted timestamp as well as an offset (in seconds) to apply to the timestamps starting at the provided time (always assumed to be in the input timezone + a potential previous offset). So the supported arguments are:

• CORRECTIONS: the correction file (optional);
• OFFSET: the fixe offset (in seconds) to add to the time (optional).

TIME::filter1     = SHIFT
TIME::arg1::CORRECTIONS = ./input/meteo/dst.dat

The file dst.dat would look like this (the time is given in the timezone declared in Input::TIME_ZONE, first without offset and with -3600s offset for the second one):

2016-03-27T02:00 -3600
2016-10-30T03:00 0

Note

The current implementation does not handle data conflicts if a shifted timestep conflicts with another timestep. In such a case, an error message "[E] timestamp error for station..." will be returned and you will have to manually decide in your input data which timestep to keep.

The correction file supports comments (everything behind ';' or '#' is a comment) and empty lines.

#include <TimeFilters.h>

Public Member Functions
	TimeShift (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const Config &cfg)
void	process (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< MeteoData > &ovec)
Public Member Functions inherited from mio::ProcessingBlock
virtual	~ProcessingBlock ()
virtual void	process (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< MeteoData > &ovec)=0
virtual void	process (Date &dateStart, Date &dateEnd)
std::string	getName () const
const ProcessingProperties &	getProperties () const
const std::string	toString () const
bool	skipStation (const std::string &station_id) const
	Should the provided station be skipped in the processing? More...
bool	noStationsRestrictions () const
const std::vector< DateRange >	getTimeRestrictions () const

Additional Inherited Members
Static Public Member Functions inherited from mio::ProcessingBlock
static void	readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y)
	Read a data file structured as X Y value on each lines. More...
static void	readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y1, std::vector< double > &Y2)
	Read a data file structured as X Y1 Y2 value on each lines. More...
static std::vector< double >	readCorrections (const std::string &filter, const std::string &filename, const size_t &col_idx, const char &c_type, const double &init)
	Read a correction file applicable to repeating time period. More...
static std::vector< offset_spec >	readCorrections (const std::string &filter, const std::string &filename, const double &TZ, const size_t &col_idx=2)
	Read a correction file, ie a file structured as timestamps followed by values on each lines. More...
static std::map< std::string, std::vector< DateRange > >	readDates (const std::string &filter, const std::string &filename, const double &TZ)
	Read a list of date ranges by stationIDs from a file. More...
Protected Member Functions inherited from mio::ProcessingBlock
	ProcessingBlock (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const Config &cfg)
	protected constructor only to be called by children More...
Static Protected Member Functions inherited from mio::ProcessingBlock
static void	extract_dbl_vector (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< double > &ovec)
static void	extract_dbl_vector (const unsigned int &param, const std::vector< const MeteoData * > &ivec, std::vector< double > &ovec)
Protected Attributes inherited from mio::ProcessingBlock
const std::set< std::string >	excluded_stations
const std::set< std::string >	kept_stations
const std::vector< DateRange >	time_restrictions
ProcessingProperties	properties
const std::string	block_name
Static Protected Attributes inherited from mio::ProcessingBlock
static const double	soil_albedo = .23
static const double	snow_albedo = .85
static const double	snow_thresh = .1
	parametrize the albedo from HS More...

Constructor & Destructor Documentation

TimeShift()

mio::TimeShift::TimeShift	(	const std::vector< std::pair< std::string, std::string > > &	vecArgs,
		const std::string &	name,
		const Config &	cfg
	)

Member Function Documentation

process()

void mio::TimeShift::process ( const unsigned int &  param, const std::vector< MeteoData > &  ivec, std::vector< MeteoData > &  ovec  )

virtual

Implements mio::ProcessingBlock.

---

The documentation for this class was generated from the following files:

• TimeFilters.h
• TimeFilters.cc