ProcShift.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2014 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 PROCSHIFT_H
#define PROCSHIFT_H
 
#include <meteoio/meteoFilters/ProcessingBlock.h> //use this one for all others
 
#include <vector>
#include <string>
 
namespace mio {
 
class ProcShift : public ProcessingBlock { //use this one for simple filter that only look at one data point at a time, for example min_max
        public:
                ProcShift(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& name, const Config& cfg);
 
                virtual void process(const unsigned int& param, const std::vector<MeteoData>& ivec,
                                     std::vector<MeteoData>& ovec);
 
        private:
                typedef enum INTERPOL_TYPE {
                        cst,
                        stepwise,
                        linear
                } interpol_type;
                
                void parse_args(const std::vector< std::pair<std::string, std::string> >& vecArgs);
                void writeOffsets(const unsigned int& param, const std::vector<MeteoData>& ivec);
                void correctOffsets(const unsigned int& param, std::vector<MeteoData>& ovec);
                
                static bool isAllNodata(const std::vector<ProcessingBlock::offset_spec>& vecX, const size_t& startIdx, const size_t& endIdx);
                static double getMedianSampling(const size_t& param, const std::vector<MeteoData>& ivec);
                
                std::vector<offset_spec> resampleVector(const std::vector<MeteoData>& ivec, const size_t& param) const;
                double getPearson(const std::vector<ProcessingBlock::offset_spec>& vecX, const std::vector<ProcessingBlock::offset_spec>& vecY, const size_t& curr_idx, const int& offset) const;
                int getOffsetFullScan(const std::vector<ProcessingBlock::offset_spec>& vecX, const std::vector<ProcessingBlock::offset_spec>& vecY, const size_t& curr_idx, const int& range_min, const int& range_max) const;
                int getOffset(const std::vector<ProcessingBlock::offset_spec>& vecX, const std::vector<ProcessingBlock::offset_spec>& vecY, const size_t& curr_idx) const;
                
                std::vector<ProcessingBlock::offset_spec> corrections; 
                std::string ref_param; 
                std::string root_path;
                std::string offsets_file; 
                double cst_offset; 
                double sampling_rate; 
                double offset_range; 
                double width_d; 
                size_t width_idx; 
                interpol_type offsets_interp; 
                bool extract_offsets; 
};
 
} //end namespace
 
#endif