MeteoIODoc  MeteoIODoc-2.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
mio::FilterSuppr Class Reference

Detailed Description

Suppression filter. Normally, this filter simply reject all values. This is convenient to quickly turn a parameter off without modifying the original data. It is also possible to provide a list of station ID's and timesteps where the parameter should be suppressed.

Author
Mathias Bavay
Date
2013-12-06 Finally, it is also possible to suppress a given fraction of the data at random by providing such fraction as an argument. For example, 0.5 would ensure that at least 50% of the data set contains nodata for this parameter.
ILWR::filter1 = suppr
PSUM::filter1 = suppr
PSUM::arg1 = ./input/meteo/psum_suppr.dat
TA::filter1 = suppr
TA::arg1 = 0.5

In the second example (PSUM), the file psum_suppr.dat would look like this (the time is given in the timezone declared in Input::TIME_ZONE):

*WFJ 2015-10-01T12:00
*DAV 2015-10-02T15:00
*WFJ 2015-11-10T06:00
STB2 2015-10-01T21:30

#include <FilterSuppr.h>

Public Member Functions

 FilterSuppr (const std::vector< std::string > &vec_args, const std::string &name, const std::string &i_root_path, const double &i_TZ)
 
virtual void process (const unsigned int &param, const std::vector< MeteoData > &ivec, std::vector< MeteoData > &ovec)
 
- Public Member Functions inherited from mio::FilterBlock
virtual ~FilterBlock ()
 
- Public Member Functions inherited from mio::ProcessingBlock
virtual ~ProcessingBlock ()
 
std::string getName () const
 
const ProcessingPropertiesgetProperties () const
 
const std::string toString () const
 

Additional Inherited Members

- Protected Member Functions inherited from mio::FilterBlock
 FilterBlock (const std::string &filter_name)
 protected constructor only to be called by children More...
 
- Protected Member Functions inherited from mio::ProcessingBlock
 ProcessingBlock (const std::string &name)
 protected constructor only to be called by children More...
 
void convert_args (const size_t &min_nargs, const size_t &max_nargs, const std::vector< std::string > &vec_args, std::vector< double > &dbl_args) const
 
- Static Protected Member Functions inherited from mio::FilterBlock
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)
 
- Static Protected Member Functions inherited from mio::ProcessingBlock
static bool is_soft (std::vector< std::string > &vec_args)
 
static void readCorrections (const std::string &filter, const std::string &filename, const char &c_type, const double &init, std::vector< double > &corrections)
 
- Protected Attributes inherited from mio::ProcessingBlock
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

mio::FilterSuppr::FilterSuppr ( const std::vector< std::string > &  vec_args,
const std::string &  name,
const std::string &  i_root_path,
const double &  i_TZ 
)

Member Function Documentation

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

Implements mio::FilterBlock.


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