MeteoIODoc 20240528.4cbdb3e5
mio::Meteo2DInterpolator Class Reference

Detailed Description

A class to spatially interpolate meteo parameters. For more, see Spatial interpolations.

#include <Meteo2DInterpolator.h>

Public Member Functions

 Meteo2DInterpolator (const Config &i_cfg, TimeSeriesManager &i_tsmanager, GridsManager &i_gridsmanager)
 Constructor. More...
 
 Meteo2DInterpolator (const Meteo2DInterpolator &)
 
Meteo2DInterpolatoroperator= (const Meteo2DInterpolator &)
 Assignement operator. More...
 
 ~Meteo2DInterpolator ()
 
std::string interpolate (const Date &date, const DEMObject &dem, const MeteoData::Parameters &meteoparam, Grid2DObject &result, const bool &quiet=false)
 A generic function that can interpolate for any given MeteoData member variable. More...
 
std::string interpolate (const Date &date, const DEMObject &dem, const std::string &param_name, Grid2DObject &result, const bool &quiet=false)
 
std::string interpolate (const Date &date, const DEMObject &dem, const MeteoData::Parameters &meteoparam, std::vector< Coords > vec_coords, std::vector< double > &result, const bool &quiet=false)
 
std::string interpolate (const Date &date, const DEMObject &dem, const MeteoData::Parameters &meteoparam, std::vector< StationData > vec_stations, std::vector< double > &result, const bool &quiet=false)
 
std::vector< std::pair< std::string, std::string > > getArgumentsForAlgorithm (const std::string &parname, const std::string &algorithm, const std::string &section) const
 Retrieve the arguments vector for a given interpolation algorithm. More...
 
const std::string toString () const
 

Constructor & Destructor Documentation

◆ Meteo2DInterpolator() [1/2]

mio::Meteo2DInterpolator::Meteo2DInterpolator ( const Config i_cfg,
TimeSeriesManager i_tsmanager,
GridsManager i_gridsmanager 
)

Constructor.

◆ Meteo2DInterpolator() [2/2]

mio::Meteo2DInterpolator::Meteo2DInterpolator ( const Meteo2DInterpolator source)

◆ ~Meteo2DInterpolator()

mio::Meteo2DInterpolator::~Meteo2DInterpolator ( )

Member Function Documentation

◆ getArgumentsForAlgorithm()

std::vector< std::pair< std::string, std::string > > mio::Meteo2DInterpolator::getArgumentsForAlgorithm ( const std::string &  parname,
const std::string &  algorithm,
const std::string &  section 
) const

Retrieve the arguments vector for a given interpolation algorithm.

Parameters
[in]parnamethe meteorological parameter that is concerned
[in]algorithmthe desired algorithm
[in]sectionthe section into which to look for the arguments
Returns
a vector containing the arguments

◆ interpolate() [1/4]

std::string mio::Meteo2DInterpolator::interpolate ( const Date date,
const DEMObject dem,
const MeteoData::Parameters meteoparam,
Grid2DObject result,
const bool &  quiet = false 
)

A generic function that can interpolate for any given MeteoData member variable.

Parameters
datedate for which to interpolate
demDigital Elevation Model on which to perform the interpolation
meteoparamAny MeteoData member variable as specified in the enum MeteoData::Parameters (e.g. MeteoData::TA)
resultA Grid2DObject that will be filled with the interpolated data
quietIf TRUE, missing data will print a warning but will not throw an exception (default: false)
Returns
some information about the interpolation process (useful for GUIs)

◆ interpolate() [2/4]

std::string mio::Meteo2DInterpolator::interpolate ( const Date date,
const DEMObject dem,
const MeteoData::Parameters meteoparam,
std::vector< Coords vec_coords,
std::vector< double > &  result,
const bool &  quiet = false 
)

◆ interpolate() [3/4]

std::string mio::Meteo2DInterpolator::interpolate ( const Date date,
const DEMObject dem,
const MeteoData::Parameters meteoparam,
std::vector< StationData vec_stations,
std::vector< double > &  result,
const bool &  quiet = false 
)

◆ interpolate() [4/4]

std::string mio::Meteo2DInterpolator::interpolate ( const Date date,
const DEMObject dem,
const std::string &  param_name,
Grid2DObject result,
const bool &  quiet = false 
)

◆ operator=()

Meteo2DInterpolator & mio::Meteo2DInterpolator::operator= ( const Meteo2DInterpolator source)

Assignement operator.

◆ toString()

const std::string mio::Meteo2DInterpolator::toString ( ) const

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