Detailed Description

Data aggregation.

This aggregates the input data over the defined window with the defined aggregation algorithm. It takes as arguments all the window parameters as defined in WindowedFilter::setWindowFParams() as well as the following:

SOFT: the keyword "soft" maybe added (this is highly recommended), if the window position is allowed to be adjusted to the data present (boolean, optional);
TYPE: the type of filter to use, one of the following:
- min: return the minimum value of the whole window;
- max: return the maximum value of the whole window;
- mean: return the mean of the whole window;
- median: return the median of the whole window;
- step_sum: return the sum over the last timestep (assuming that the value given at the end of the timestep is valid for the whole timestep);
- wind_avg: Wind vector averaging. CURRENTLY, THIS FILTER DOES NOT WORK PROPERLY (the first parameter is correctly calculated but the second one uses the modified output of the first one and therefore is WRONG).

Remarks: nodata values are excluded from the aggregation

VW::filter3    = AGGREGATE
VW::arg3::TYPE = MEAN
VW::arg3::soft = TRUE
VW::arg3::centering = left
VW::arg3::MIN_PTS = 4
VW::arg3::MIN_SPAN = 14400 ;ie 14400 seconds time span, at least 4 points, for a left leaning window
 
;Reconstruct a PSUM signal from PINT
PINT::filter1 = AGGREGATE
PINT::arg1::type = step_sum

#include <ProcAggregate.h>

Public Member Functions
	ProcAggregate (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const Config &cfg)

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

virtual void	process (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< MeteoData > &ovec)=0

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

bool	skipHeight (const double &height) const
	Should the provided height be skipped in the processing? More...

Additional Inherited Members
Public Types inherited from mio::WindowedFilter
enum	Centering { left , center , right }

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...

Static Public Attributes inherited from mio::ProcessingBlock
static const double	default_height

Protected Member Functions inherited from mio::WindowedFilter
	WindowedFilter (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const Config &cfg, const bool &skipWindowParams=false)
	Construct a WindowedFilter Object. This is for filters that require a certain window of data. More...

void	setWindowFParams (const std::vector< std::pair< std::string, std::string > > &vecArgs)
	Parse the arguments in order to retrieve the user parameters for the data window. The following parameters are recognized: More...

const std::vector< const MeteoData * > &	get_window (const size_t &index, const std::vector< MeteoData > &ivec)
	A function that cuts out the desired window for the 'index' element within ivec, the window elements are stored into vec_window Calls to this function have to start with index 0, then 1, 2, 3, ... vec_window is not allowed to be changed between two calls. More...

bool	get_window_specs (const size_t &index, const std::vector< MeteoData > &ivec, size_t &start, size_t &end) const
	A function that computes the start and end for a window for the 'index' element from ivec The principle is to compute the first index that matches the minimum number of points criteria, and the one that matches the minimum time window, then combine them (with the equivalent of OR: we take the MIN index). Afterward, we compute the last index [...] for number of points and the last index [...] for the time window and combine them (with the equivalent of OR: we take the MIN index) or vice versa for right centering. 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::WindowedFilter
Duration	min_time_span
	This is filled in the constructor by calling setWindowFParams. More...

Centering	centering
	This is filled in the constructor by calling setWindowFParams. More...

size_t	min_data_points
	This is filled in the constructor by calling setWindowFParams. More...

size_t	last_start

size_t	last_end

bool	is_soft

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

std::set< double >	included_heights

std::set< double >	excluded_heights

bool	all_heights

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

◆ ProcAggregate()

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

Member Function Documentation

◆ process()

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

virtual

Implements mio::WindowedFilter.

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

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ ProcAggregate()

Member Function Documentation

◆ process()