FilterDespikingPS.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2018 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 FilterDespikingPS_H
#define FilterDespikingPS_H
 
#include <meteoio/meteoFilters/ProcessingBlock.h>
#include <meteoio/meteoStats/libfit1D.h>
 
#include <vector>
#include <string>
 
namespace mio {
 
class FilterDespikingPS : public ProcessingBlock {
        public:
                FilterDespikingPS(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 IMPLEMENTATION_TYPE {
                        GORING,
                        MORI
                } implementation_type;
 
                void parse_args(const std::vector< std::pair<std::string, std::string> >& vecArgs);
 
                std::vector<int> findSpikesGoring(const std::vector<double>& timeVec, const std::vector<double>& ivec, unsigned int& nNewSpikes) const;
                std::vector<int> findSpikesMori(const std::vector<double>& timeVec, const std::vector<double>& ivec, unsigned int& nNewSpikes) const;
                void replaceSpikes(const std::vector<double>& timeVec, std::vector<double>& uVec, std::vector<int>& spikesVec) const;
 
                static std::vector<double> calculateDerivatives(const std::vector<double>& ivec, const std::vector<double>& timeVec);
                static double calculateCrossCorrelation(const std::vector<double>& aVec,const std::vector<double>& bVec);
                static unsigned int nNodataElements(const std::vector<double>& iVec);
                static void findPointsOutsideEllipse(const std::vector<double>& xVec,const std::vector<double>& yVec,
                                      const double a,const double b,const double theta, std::vector<int>& outsideVec);
                static void findPointsOutsideEllipsoid(const std::vector<double>& xVec,const std::vector<double>& yVec, const std::vector<double>& zVec,
                                                const double a,const double b,const double c, std::vector<int>& outsideVec);
                void getWindowForInterpolation(const size_t index,const std::vector<double>& timeVec, const std::vector<double>& uVec,
                                       const std::vector<int>& spikesVec, std::vector<double>& xVec, std::vector<double>& yVec) const;
                static bool checkIfWindowForInterpolationIsSufficient(const std::vector<double>& xVec,const double time,const unsigned int minPoints,
                                                       const bool avoidExtrapolation);
                //helper functions:
                static void solve2X2LinearEquations(const double* a, const double* b, const double* c, double* x);
                static const std::vector<double> helperGetDoubleVectorOutOfMeteoDataVector(const std::vector<MeteoData>& ivec, const unsigned int& param);
                static const std::vector<double> helperGetTimeVectorOutOfMeteoDataVector(const std::vector<MeteoData>& ivec);
 
                double sensitivityParam; //this parameter controls the sensitivity of the filter. standard value: 1
                implementation_type methodParam; //this parameter controls which implementation of the filter is used: according to Mori or Goring
                int nIterations;   //this counts the iterations
                int maxIterations; //this is a hard-coded parameter to stop the iteration
 
                unsigned int degreeOfInterpolation; //1: linear fit, 2: quadratic fit, 3: cubic fit
                unsigned int windowWidth; //wished width of the window for interpolation
};
 
} //end namespace
 
#endif