InterpolationAlgorithms.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2010 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    MeteoIO is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.
 
    You should have received a copy of the GNU Lesser General Public License
    along with MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INTERPOLATIONALGORITHMS_H
#define INTERPOLATIONALGORITHMS_H
 
#include <meteoio/dataClasses/DEMObject.h>
#include <meteoio/dataClasses/MeteoData.h>
#include <meteoio/TimeSeriesManager.h>
#include <meteoio/GridsManager.h>
#include <meteoio/Meteo2DInterpolator.h>
#include <meteoio/meteoStats/libfit1D.h>
 
#include <vector>
#include <string>
 
namespace mio {
 
class Meteo2DInterpolator; // forward declaration, cyclic header include
 
class Trend {
        public:
                Trend(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& algo, const std::string& i_param);
 
                void detrend(const std::vector<StationData>& vecMeta, std::vector<double> &vecDat);
                void retrend(const DEMObject& dem, Grid2DObject &grid) const;
 
                std::string getInfo() const;
                bool has_user_lapse() const {return (user_lapse!=IOUtils::nodata);}
                bool is_soft() const {return soft;}
 
                std::string toString() const;
        private:
                void initTrendModel(const std::vector<double>& vecAltitudes, const std::vector<double>& vecDat);
                bool multilinearDetrend(const std::vector<StationData>& vecMeta, std::vector<double> &vecDat);
                void multilinearRetrend(const DEMObject& dem, Grid2DObject &grid) const;
                static std::vector<double> getStationAltitudes(const std::vector<StationData>& vecMeta);
 
                FitLinClosedForm multi_trend;
                Fit1D trend_model;
                const std::string param;
                double user_lapse; 
                double trend_min_alt, trend_max_alt; 
                bool frac, soft, multilinear; 
};
 
class InterpolationAlgorithm {
        public:
                InterpolationAlgorithm(const std::vector< std::pair<std::string, std::string> >& /*vecArgs*/,
                                       const std::string& i_algo, const std::string& i_param, TimeSeriesManager& i_tsm) :
                                      algo(i_algo), tsmanager(i_tsm), date(0., 0), vecMeteo(), vecData(),
                                      vecMeta(), info(), param(i_param), nrOfMeasurments(0) {}
                virtual ~InterpolationAlgorithm() {}
                
                //if anything is not ok (wrong parameter for this algo, insufficient data, etc) -> return zero
                virtual double getQualityRating(const Date& i_date) = 0;
                virtual void calculate(const DEMObject& dem, Grid2DObject& grid) = 0;
 
                std::string getInfo() const;
                const std::string algo;
 
        protected:
                std::vector<double> getData(const Date& i_date, const std::string& i_param);
                size_t getData(const Date& i_date, const std::string& i_param,
                               std::vector<double>& o_vecData, std::vector<StationData>& o_vecMeta);
 
                TimeSeriesManager& tsmanager;
                Date date;
                std::vector<MeteoData> vecMeteo;
                std::vector<double> vecData; 
                std::vector<StationData> vecMeta; 
                std::ostringstream info; 
                const std::string param; 
                size_t nrOfMeasurments; 
};
 
class AlgorithmFactory {
        public:
                static InterpolationAlgorithm* getAlgorithm(std::string algoname,
                                                            Meteo2DInterpolator& mi,
                                                            const std::vector< std::pair<std::string, std::string> >& vecArgs, TimeSeriesManager& tsm, GridsManager& gdm, const std::string& param);
};
 
} //end namespace mio
 
#endif