MeteoIODoc 20250905.f67af007
 
Loading...
Searching...
No Matches
mio::Grid1DInterpolator Class Reference

Detailed Description

A class to temporally resample grid objects.

Author
Michael Reisecker
Date
2021-09

#include <Grid1DInterpolator.h>

Public Member Functions

 Grid1DInterpolator (const Config &in_cfg)
 Constructor for a grid interpolator.
 
 Grid1DInterpolator (const Grid1DInterpolator &org)=default
 
 ~Grid1DInterpolator ()
 Destructor for a Grid1DInterpolator instance.
 
Grid1DInterpolatoroperator= (const Grid1DInterpolator &)
 
bool resampleData (const Date &date, const MeteoGrids::Parameters &parameter, const std::map< Date, Grid2DObject > &available_grids, Grid2DObject &resampled_grid)
 Wrapper function to call the desired grid resampling algorithm.
 
double getWindowSize () const
 
const std::string toString () const
 

Constructor & Destructor Documentation

◆ Grid1DInterpolator() [1/2]

mio::Grid1DInterpolator::Grid1DInterpolator ( const Config in_cfg)

Constructor for a grid interpolator.

On initialization, a Grid1DInterpolator instance prepares a map of per-parameter interpolation algorithms which are then ready to do the work when called.

Parameters
[in]in_cfgThe current simulation configuration.

◆ Grid1DInterpolator() [2/2]

mio::Grid1DInterpolator::Grid1DInterpolator ( const Grid1DInterpolator org)
default

◆ ~Grid1DInterpolator()

mio::Grid1DInterpolator::~Grid1DInterpolator ( )

Destructor for a Grid1DInterpolator instance.

Upon destruction all algorithms previously created through the object factory are deleted here.

Member Function Documentation

◆ getWindowSize()

double mio::Grid1DInterpolator::getWindowSize ( ) const
inline

◆ operator=()

Grid1DInterpolator & mio::Grid1DInterpolator::operator= ( const Grid1DInterpolator )

◆ resampleData()

bool mio::Grid1DInterpolator::resampleData ( const Date date,
const MeteoGrids::Parameters parameter,
const std::map< Date, Grid2DObject > &  available_grids,
Grid2DObject resampled_grid 
)

Wrapper function to call the desired grid resampling algorithm.

The grid processor calls this function which in turn redirects the request to the proper algorithm object.

Parameters
[in]dateThe date to resample to.
[in]parameterThe meteo parameter to resample.
[in]available_gridsA list of grids on the hard drive (or generated ones) which should be used for temporal resampling inbetween them, as well as the corresponding dates.
[out]resampled_gridThe grid that was temporally resampled.
Returns
True if resampling could be performed. This means that the setup is in order, but nodata may still be returned.

◆ toString()

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

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