mio::FilterRate Class Reference

Detailed Description

Rate of change filter.

Calculate the change rate (ie: slope) between two points, if it is above a user given value, reject the point. It takes the following arguments:

• MIN: minimum permissible rate of change (per seconds, optional);
• MAX: either the absolute value of the maximum permissible rate of change (per seconds) if no other argument is provided, or maximum permissible rate of change (per seconds) if a MIN was provided.
• METHOD: which points are taken into account when computing the rate of change (optional, default is LEFT). It can be either one of:
  • LEFT: looking for the rate of change on the left of the current point, ie between the last valid point and the current one (default);
  • RIGHT: looking for the rate of change on the right of the current point, ie between the current point and the next valid one;
  • LEFT_AND_RIGHT: excluding a point if the rate of change exceeds MAX or MIN both on the left and on the right of the current point;
  • LEFT_OR_RIGHT: excluding a point if the rate of change exceeds MAX or MIN either on the left or on the right of the current point;

So depending if MIN and MAX were provided or only MAX, every point where the local rate of change is outside [ MIN , MAX] or every point outside [ -MAX , MAX] is rejected.

TA::filter1   = rate
TA::arg1::MIN = -0.01
TA::arg1::MAX = 0.015

#include <FilterRate.h>

Public Member Functions
	FilterRate (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)
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

FilterRate()

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

Member Function Documentation

process()

void mio::FilterRate::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:

• FilterRate.h
• FilterRate.cc