MeteoIODoc  MeteoIODoc-2.9.0
mio::TimeSuppr Class Reference

Detailed Description

Timesteps suppression filter.

This filter deletes some timesteps based on the provided arguments:

  • TYPE: defines the strategy to delete timesteps. It is one of:
    • CLEANUP: suppress duplicated and out-of-order timestamps (a warning will be emitted anyway for each problematic timestamp). Duplicated timestamps are merged to the first encountered one.
    • BYDATES: delete specific timesteps
    • FRAC: suppress a given fraction of the data at random
  • FILE: when type=BYDATE, a file that contains a list of station ID's and timesteps that should be suppressed;
  • FRAC: when type=FRAC, the fraction of data to suppress. For example, 0.5 would ensure that at least 50% of the data set's points are deleted.
  • WIDTH: when type=FRAC, the width of data gaps to create (in seconds). If not set, individual data points are deleted.
TIME::filter1 = suppr
TIME::arg1::type = cleanup
TIME::filter2 = suppr
TIME::arg2::type = bydates
TIME::arg2::file = ./input/meteo/suppr.dat

The file 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
*WFJ 2015-12-25T01:00 2015-12-27T13:30
*WFJ 2015-09-01T07:15 - 2015-09-10T20:30
STB2 2015-10-01T21:30

Time ranges are declared by providing two dates on the same line. For more visibility, the said two dates can be separated by " - " (which a white space character on both sides, as shown in the example above).

#include <TimeFilters.h>

Public Member Functions

 TimeSuppr (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name, const std::string &root_path, const double &TZ)
 
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 ProcessingPropertiesgetProperties () const
 
const std::string toString () const
 
bool skipStation (const std::string &station_id) const
 
bool noStationsRestrictions () 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)
 
static void readCorrections (const std::string &filter, const std::string &filename, std::vector< double > &X, std::vector< double > &Y1, std::vector< double > &Y2)
 
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)
 
static std::vector< offset_specreadCorrections (const std::string &filter, const std::string &filename, const double &TZ, const size_t &col_idx=2)
 
static std::map< std::string, std::vector< dates_range > > readDates (const std::string &filter, const std::string &filename, const double &TZ)
 
static std::set< std::string > initStationSet (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &keyword)
 
- Protected Member Functions inherited from mio::ProcessingBlock
 ProcessingBlock (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &name)
 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
 
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

◆ TimeSuppr()

mio::TimeSuppr::TimeSuppr ( const std::vector< std::pair< std::string, std::string > > &  vecArgs,
const std::string &  name,
const std::string &  root_path,
const double &  TZ 
)

Member Function Documentation

◆ process()

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