Detailed Description

Mteorological indices data generator.

This generator offers several common meteorological indices that aggregate several parameters into one convenient index. It is possible to choose which index to compute with the TYPE argument:

WINDCHILL: human-percived feeling of air temperature on exposed skin due to wind;
HEATINDEX: human-perceived air temperature due to humidity;
WET_BULB: lowest temperature that could be reached by water evaporation;
HUMIDEX: Canadian index combining the effect of heat and humidity;
WBGT_INDEX: a parametrization to reproduce the Wet Bulb Globe Temperature index (this parametrization is not that great);
WBGT_SIMPLE: the simplified Wet Bulb Globe Temperature index parametzrization in use by the Australian Bureau of Meteorology.

*::edit1 = CREATE
*::arg1::algorithm = METEOINDEX
*::arg1::type = WINDCHILL
*::arg1::param = CHILL

#include <MeteoIndexGenerator.h>

Public Member Functions
	MeteoIndex (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &i_algo, const std::string &i_section, const double &TZ)

bool	generate (const size_t &param, MeteoData &md, const std::vector< MeteoData > &vecMeteo) override

bool	create (const size_t &param, const size_t &ii_min, const size_t &ii_max, std::vector< MeteoData > &vecMeteo) override
	Fill one time series of MeteoData for one station.

Public Member Functions inherited from mio::GeneratorAlgorithm
virtual	~GeneratorAlgorithm ()

bool	skipStation (const std::string &station_id) const
	Should this station be skipped, based on user-provided station ID restrictions?

bool	skipTimeStep (const Date &dt) const
	Should this timestep be skipped, based on user-provided time restrictions?

bool	skipHeight (const double &height) const

std::vector< DateRange >	getTimeRestrictions () const

std::string	getAlgo () const

Additional Inherited Members
Protected Member Functions inherited from mio::GeneratorAlgorithm
	GeneratorAlgorithm (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &i_algo, const std::string &i_section, const double &TZ)
	protected constructor only to be called by children

void	initHeightRestrictions (const std::vector< std::pair< std::string, std::string > > vecArgs)

Static Protected Member Functions inherited from mio::GeneratorAlgorithm
static std::set< std::string >	initStationSet (const std::vector< std::pair< std::string, std::string > > &vecArgs, const std::string &keyword)

Protected Attributes inherited from mio::GeneratorAlgorithm
const std::vector< DateRange >	time_restrictions

const std::set< std::string >	excluded_stations

const std::set< std::string >	kept_stations

std::set< double >	included_heights

std::set< double >	excluded_heights

bool	all_heights

const std::string	algo

const std::string	section

Static Protected Attributes inherited from mio::GeneratorAlgorithm
static const double	default_height = IOUtils::nodata

Constructor & Destructor Documentation

◆ MeteoIndex()

mio::MeteoIndex::MeteoIndex	(	const std::vector< std::pair< std::string, std::string > > &	vecArgs,
		const std::string &	i_algo,
		const std::string &	i_section,
		const double &	TZ
	)

inline

Member Function Documentation

◆ create()

bool mio::MeteoIndex::create	(	const size_t &	param,
		const size_t &	ii_min,
		const size_t &	ii_max,
		std::vector< MeteoData > &	vecMeteo
	)

overridevirtual

Fill one time series of MeteoData for one station.

This is used by the dataCreators to create a new parameter in one go for the whole timeseries.

Parameters

[in]	param	meteo parameter to generate
[in]	ii_min	minimum index to apply it to in vecMeteo
[in]	ii_max	maximum index to apply it to in vecMeteo
[in]	vecMeteo	meteo timeseries to process

Returns: true if all missing data points for the given parameter could be generated, false otherwise

Implements mio::GeneratorAlgorithm.

◆ generate()

bool mio::MeteoIndex::generate	(	const size_t &	param,
		MeteoData &	md,
		const std::vector< MeteoData > &	vecMeteo
	)