MeteoIODoc  2.10.0
Public Member Functions | List of all members
mio::FilterMinMax Class Reference
Data processing elements

Detailed Description

Min/Max range filter.

Reject all values greater than the max or smaller than the min. Arguments:

  • MIN: the minimum permissible value (in SI, mandatory);
  • MAX: the maximum permissible value (in SI, mandatory);
  • SOFT: if set to TRUE, all data smaller than the min / larger than the max, would be assigned either the minimum / maximum permissible value or another value given as an extra argument (optional);
  • MIN_RESET: if SOFT has been set to TRUE, this is the new value for otherwise rejected points (optional).
  • MAX_RESET: if SOFT has been set to TRUE, this is the new value for otherwise rejected points (optional).
    TA::filter1 = min_max
    TA::arg1::MIN = 230
    TA::arg1::MAX = 330
    ISWR::filter1 = min_max
    ISWR::arg1::SOFT = TRUE
    ISWR::arg1::MIN = 8
    ISWR::arg1::MIN_RESET = 0
    ISWR::arg1::MAX = 1400
    ISWR::arg1::MAX_RESET = 1398

#include <FilterMinMax.h>

Public Member Functions

 FilterMinMax (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 (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

◆ FilterMinMax()

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

Member Function Documentation

◆ process()

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