JammingOp.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
*/
 
#ifndef Jamming2_OP_H_
#define Jamming2_OP_H_
 
#include <limits>
 
//#include <drain/util/FunctorPack.h>
//#include <drain/util/Math.h>
 
/*
#include <drain/image/File.h>
#include <drain/imageops/RunLengthOp.h>
#include <drain/imageops/DistanceTransformOp.h>
*/
 
 
#include "DetectorOp.h"
 
 
//using namespace drain::image;
 
using namespace drain::image;
 
namespace rack {
 
 
class JammingOp: public DetectorOp {
 
public:
 
    //  \param derivativeDifferenceMax - maximum difference between modelled and detected dBZ(range) slopes.
    // \param windowWidth - windowWidth [kilometres]
    // JammingOp(int windowWidth=5000, float windowHeight=10.0, float sensitivity = 0.5, float eWidth = 1.0f, float eHeight = 0.0f) :
    // JammingOp(double smoothnessThreshold = 5.0, double sampleContent=0.5, double weightLower = 0.1, double maxCurvature = 0.001, double distanceMin = 40.0, int debugRow=-1) :
    JammingOp(double smoothnessThreshold = 5.0, double distanceMin = 80.0, double refit=true, int debugRow=-1) : // , double derivativeDifferenceMax = 0.0001
        DetectorOp(__FUNCTION__, "Detects broad lines caused by electromagnetic interference. Intensities should be smooth, increasing by distance.",
                "jamming")
    {
        parameters.link("smoothnessThreshold", this->smoothnessThreshold = smoothnessThreshold, "dBZ");
        parameters.link("distanceMin", this->distanceMin = distanceMin, "km");
        parameters.link("refit", this->refit = refit, "true|false");  // [0.0...1.0]
        // parameters.link("weightLower", this->weightLower = weightLower, "[0.0...1.0]");
        // parameters.link("debugRow", this->debugRow = debugRow, "index");
 
        UNIVERSAL = true;
        REQUIRE_STANDARD_DATA = true;
    }
 
 
    double smoothnessThreshold;
    double distanceMin;
    //double sampleContent;
    //double weightLower;
    bool refit;
    //double derivativeDifferenceMax;
 
    //double maxCurvature;
 
 
    int debugRow;
 
 
    static inline
    double modelledEmitter(double dBZ0, double distance){
        return dBZ0 + distance*(0.016/1000.0) + 20.0*log10(distance);
    };
 
protected:
 
    virtual
    void runDetector(const PlainData<PolarSrc> & srcData, PlainData<PolarDst> & dstProb) const;
    //void filterImage(const PolarODIM &odimIn, const Image &src, Image &dst) const;
 
    /*
    static
    void fitCurve(const std::vector<double> &src, const std::vector<double> &weight, std::vector<double> &coeff);
 
    virtual
    void filterImageOLD(const PolarODIM &odimIn, const Image &src, Image &dst) const;
    */
 
    inline
    static
    double derivativeDBZ(const PolarODIM &odimIn, const Image &src, int i, int j, int span = 10){
        int iLower = std::max(i-span, 0);
        double zLower = src.get<double>(iLower,j);
        if  (odimIn.isValue(zLower)){
            int iUpper = std::min(i+span, static_cast<int>(src.getWidth())-1);
            double zUpper = src.get<double>(iUpper,j);
            if (odimIn.isValue(zUpper)){
                return (zUpper - zLower)/(odimIn.rscale*static_cast<double>(iUpper-iLower));
            }
        }
        return std::numeric_limits<double>::max();
    }
 
    inline
    static
    double derivativeDBZ_Modelled(double yModelBase, double range, double rangeDifference){
        return (modelledEmitter(yModelBase, range+rangeDifference) - modelledEmitter(yModelBase, range-rangeDifference)) / (2.0*rangeDifference);
    }
 
 
};
 
}
 
#endif // Jamming2_OP_H_
 
// Rack