ResamplingAlgorithms.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2009 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 RESAMPLINGALGORITHMS_H
#define RESAMPLINGALGORITHMS_H
 
#include <meteoio/dataClasses/MeteoData.h>
#include <meteoio/IOUtils.h>
 
#include <string>
#include <vector>
 
#ifdef _MSC_VER
        #pragma warning(disable:4512) //we don't need any = operator!
#endif
 
namespace mio {
 
 
class GapInfo final {
        public:
                enum GapType {
                        INTERPOLATION,       
                        EXTRAPOLATION_BEGIN, 
                        EXTRAPOLATION_END,   
                        NO_VALID_POINTS     
                };
 
                GapInfo() : before(), after(), beforeIdx(IOUtils::npos), afterIdx(IOUtils::npos),
                            gapType(INTERPOLATION), scannedBeforeLimit(IOUtils::npos), scannedAfterLimit(IOUtils::npos) {}
 
                bool isUndef() const {return (before.isUndef() || after.isUndef());}
                
                void reset() {before.setUndef(), after.setUndef(); beforeIdx=IOUtils::npos; afterIdx=IOUtils::npos; scannedBeforeLimit=IOUtils::npos; scannedAfterLimit=IOUtils::npos;}
 
                void setBefore(const size_t& idx, const std::vector<MeteoData>& vecM) {
                        if (idx>=vecM.size()) return;
                        beforeIdx=idx; before=vecM[idx].date;
                        scannedBeforeLimit = idx;
                }
 
                void setAfter(const size_t& idx, const std::vector<MeteoData>& vecM) {
                        if (idx>=vecM.size()) return;
                        afterIdx=idx; after=vecM[idx].date;
                        scannedAfterLimit = idx;
                }
 
                std::string toString() const {
                        std::ostringstream os;
                        if (before.isUndef()) {
                                os << "Undefined";
                        } else {
                                std::string type_str( "INTERPOLATION" );
                                if (gapType==GapType::EXTRAPOLATION_BEGIN) type_str = "EXTRAPOLATION_BEGIN";
                                else if (gapType==GapType::EXTRAPOLATION_END) type_str = "EXTRAPOLATION_END";
                                else if (gapType==GapType::NO_VALID_POINTS) type_str = "NO_VALID_POINTS";
                                os << " [" << before.toString(Date::ISO) << " (" << beforeIdx << ") - " << after.toString(Date::ISO) << " (" << afterIdx << ") -> " << type_str << "]";
                        }
                        return os.str();
                }
 
                double size() const;
 
                // Search methods that can use cached anchor points and scanning boundaries
                size_t searchBackward(const size_t& pos, const size_t& paramindex, const std::vector<MeteoData>& vecM,
                                                        const Date& resampling_date, const double& max_gap_size);
                size_t searchForward(const size_t& pos, const size_t& paramindex, const std::vector<MeteoData>& vecM,
                                                        const Date& resampling_date, const double& max_gap_size);
 
                Date before; //< Date of the last valid point before the gap
                Date after; 
                size_t beforeIdx; 
                size_t afterIdx; 
                GapType gapType;
 
        private:
                // These track how far we've scanned when we haven't found anchor points yet
                size_t scannedBeforeLimit; //< Furthest index scanned backward
                size_t scannedAfterLimit;  //< Furthest index scanned forward
};
 
 
 
class ResamplingAlgorithms {
 
        public:
                using gap_info = GapInfo;
 
                enum ResamplingPosition {
                        hasTimestamp,  // Resampling date exactly matches an existing data point
                        inGap,         // Resampling date falls between two existing data points
                        begin,         // Resampling date is before the first data point (extrapolation)
                        end            // Resampling date is after the last data point (extrapolation)
                };
 
                ResamplingAlgorithms(const std::string& i_algoname, const std::string& i_parname, const double& dflt_max_gap_size, const std::vector< std::pair<std::string, std::string> >& /*vecArgs*/)
                                    : algo(i_algoname), parname(i_parname), max_gap_size(dflt_max_gap_size), gaps() {}
 
                virtual ~ResamplingAlgorithms() {}
 
                // findGap now takes stationHash for caching
                gap_info findGap(const std::string& stationHash, const size_t& pos, const size_t& paramindex, const std::vector<MeteoData>& vecM, const Date& resampling_date, const double& i_max_gap_size);
 
                //return true if resampling took place, false otherwise
                virtual bool resample(const std::string& stationHash, const size_t& index, const ResamplingPosition& position, const size_t& paramindex,
                              const std::vector<MeteoData>& vecM, MeteoData& md, const gap_info& gap, const bool& exactMatch) = 0;
 
                void resetResampling() {gaps.clear();} //invalidate all gaps, usually after rebuffering
 
                const std::string getAlgo() const {return algo;}
                double getMaxGapSize() const {return max_gap_size;}
 
                virtual std::string toString() const = 0;
 
        protected:
                bool allowExtrapolate = false;  
                static double partialAccumulateAtLeft(const std::vector<MeteoData>& vecM, const size_t& paramindex,
                                                      const size_t& pos, const Date& curr_date);
                static double partialAccumulateAtRight(const std::vector<MeteoData>& vecM, const size_t& paramindex,
                                                       const size_t& pos, const Date& curr_date);
                static double linearInterpolation(const double& x1, const double& y1,
                                                  const double& x2, const double& y2, const double& x3);
                static Date getDailyStart(const Date& resampling_date);
                static size_t getDailyValue(const std::vector<MeteoData>& vecM, const size_t& paramindex, size_t pos, const Date& intervalStart, const Date& intervalEnd);
 
                const std::string algo, parname;
                double max_gap_size; 
 
        private:
                std::map<std::string, gap_info> gaps;
 
};
 
class ResamplingAlgorithmsFactory {
        public:
                static ResamplingAlgorithms* getAlgorithm(const std::string& i_algoname, const std::string& parname, const double& max_gap_size, const std::vector< std::pair<std::string, std::string> >& vecArgs, const Config &cfg);
};
 
} //end namespace
#endif