TimeFilters.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2017 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 TIMEFILTERS_H
#define TIMEFILTERS_H
 
#include <meteoio/IOUtils.h>
#include <meteoio/meteoFilters/ProcessingBlock.h>
#include <vector>
#include <string>
 
namespace mio {
class TimeProcStack {
        public:
                TimeProcStack(const Config& i_cfg);
                TimeProcStack(const TimeProcStack& source);
                ~TimeProcStack() {for (size_t ii=0; ii<filter_stack.size(); ii++) delete filter_stack[ii];}
                
                void process(std::vector< std::vector<MeteoData> >& ivec);
                void process(Date &dateStart, Date &dateEnd);
 
                TimeProcStack& operator=(const TimeProcStack& source);
                static void checkUniqueTimestamps(std::vector<METEO_SET> &vecVecMeteo);
                static const std::string timeParamName;
                
        private:
                std::vector<ProcessingBlock*> filter_stack; //for now: strictly linear chain of processing blocks
                bool enable_time_filtering;
};
 
class TimeSuppr : public ProcessingBlock {
        public:
                TimeSuppr(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& name, const Config& cfg);
 
                void process(const unsigned int& param, const std::vector<MeteoData>& ivec, std::vector<MeteoData>& ovec) override;
 
        private:
                //possible modes of operation
                typedef enum SUPPR_MODE {
                            NONE,
                            BYDATES,
                            FRAC,
                            CLEANUP
                } suppr_mode;
                
                void supprByDates(std::vector<MeteoData>& ovec) const;
                void supprFrac(std::vector<MeteoData>& ovec) const;
                void supprInvalid(std::vector<MeteoData>& ovec) const;
                
                std::map< std::string, std::vector<DateRange> > suppr_dates;
                double range, width;
                suppr_mode op_mode;
};
 
class TimeShift : public ProcessingBlock {
        public:
                TimeShift(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& name, const Config& cfg);
 
                void process(const unsigned int& param, const std::vector<MeteoData>& ivec, std::vector<MeteoData>& ovec) override;
 
        private:
                void process_corrections(std::vector<MeteoData>& ovec) const;
                void process_offset(std::vector<MeteoData>& ovec) const;
                std::vector<offset_spec> dst_changes;
                double offset;
                bool has_offset;
};
 
class TimeSort : public ProcessingBlock {
        public:
                TimeSort(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& name, const Config& cfg);
 
                void process(const unsigned int& param, const std::vector<MeteoData>& ivec, std::vector<MeteoData>& ovec) override;
};
 
class TimeLoop : public ProcessingBlock {
        public:
                TimeLoop(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& name, const Config& cfg);
 
                void process(const unsigned int& param, const std::vector<MeteoData>& ivec, std::vector<MeteoData>& ovec) override;
                void process(Date &dateStart, Date &dateEnd) override;
 
        private:
                Date req_start, req_end;
                Date match_date, ref_start, ref_end;
};
 
} //end namespace
 
#endif