NonMetOp.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 RACK_NONMET_OP_H_
#define RACK_NONMET_OP_H_
 
//#include "DetectorOp.h"
 
#include "FuzzyDetectorOp.h"
 
//using namespace drain::image;
 
namespace rack {
 
 
class NonMetOp: public DetectorOp {
 
public:
 
 
    //NonMetOp(double threshold=0.4, double thresholdWidth=0.2, double windowWidth=0.0, double windowHeight=0.0, double medianPos=0.95) :
    NonMetOp(const drain::UniTuple<double,2> & threshold = {0.7,0.8}, const drain::UniTuple<double,2> & medianWindow = {0.0,0.0}, double medianThreshold=0.95) :
        DetectorOp(__FUNCTION__,"Detects clutter. Based on dual-pol parameter RhoHV . Optional post processing: morphological closing. Universal.", "nonmet"){
 
        dataSelector.setQuantities("RHOHV");
        REQUIRE_STANDARD_DATA = false;
        UNIVERSAL = true;
 
        parameters.link("threshold", this->threshold.tuple() = threshold, "0...1[:0...1]");
        parameters.link("medianWindow", this->medianWindow.tuple() = medianWindow, "metres,degrees");
        parameters.link("medianPos", this->medianPos = medianPos, "0...1");     //parameters.link("area", this->area, area);
    };
 
    /*
    inline
    NonMetOp(const NonMetOp & op) : DetectorOp(op){
        UNIVERSAL = true;
        std::cerr << __FUNCTION__ << " copy const \n";
    }
    */
 
    //double threshold;
    //double thresholdWidth;
    drain::Range<double> threshold;
    drain::Frame2D<double> medianWindow;
    // double windowWidth;
    // double windowHeight;
    double medianPos;
 
 
protected:
 
    virtual
    void runDetector(const PlainData<PolarSrc> & srcData, PlainData<PolarDst> & dstProb) const;
 
 
 
};
 
 
 
class NonMet2Op: public FuzzyDetectorOp {
 
public:
 
 
    //NonMetOp(double threshold=0.4, double thresholdWidth=0.2, double windowWidth=0.0, double windowHeight=0.0, double medianPos=0.95) :
    NonMet2Op(const drain::UniTuple<double,2> & threshold = {0.75,0.95}, const drain::UniTuple<double,2> & medianWindow = {0.0,0.0}, double medianThreshold=0.95);
 
    //double threshold;
    //double thresholdWidth;
    drain::Range<double> threshold;
    drain::Frame2D<double> medianWindow;
    // double windowWidth;
    // double windowHeight;
    double medianPos;
 
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierRHOHV(LocalFunctorBank & bank) const override {
        typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        // Ensure INVERSE (decreasing step function)
        if (rhoHVthreshold.min > rhoHVthreshold.max){
            functor.set(rhoHVthreshold);
        }
        else if (rhoHVthreshold.min < rhoHVthreshold.max){
            functor.set(rhoHVthreshold.max, rhoHVthreshold.min); // invert
        }
        else {
            functor.set(rhoHVthreshold.max, 0.8 * rhoHVthreshold.max);
        }
        return functor;
    }
 
protected:
 
    //virtual
    //void runDetector(const PlainData<PolarSrc> & srcData, PlainData<PolarDst> & dstProb) const;
 
    virtual
    void init(const drain::UniTuple<double,2> & threshold, const drain::UniTuple<double,2> & medianWindow, double medianThreshold);
 
    /*
    virtual inline
    void computeFuzzyDBZ(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const {};
 
    virtual inline
    void computeFuzzyVRAD(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const {};
 
    virtual
    void computeFuzzyZDR(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const;
 
    virtual
    void computeFuzzyRHOHV(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const;
    */
};
 
 
 
class ChaffOp: public FuzzyDetectorOp {
 
public:
 
    // BIRD: double dbzPeak = -5.0, double vradDevMin = 5.0, double rhoHVmax = 0.7, double zdrAbsMin = 2.0, double windowWidth = 2500, double windowHeight = 5.0
 
    ChaffOp(double dbzPeak = 10.0, double vradDevMax = +5.0, double rhoHVmax = 0.50, double zdrAbsMin = 0.5, double windowWidth = 2500, double windowHeight = 5.0) :
        FuzzyDetectorOp(__FUNCTION__, "Estimates chaff probability from DBZH, VRAD, RhoHV and ZDR.", "nonmet.chaff"){
        init(dbzPeak, vradDevMax, rhoHVmax, zdrAbsMin, windowWidth, windowHeight);
    };
 
    ChaffOp(const ChaffOp & op) : FuzzyDetectorOp(op) {
        this->parameters.copyStruct(op.getParameters(), op, *this);
    }
 
    virtual
    void init(double dbzPeak, double vradDevMax, double rhoHVmax, double zdrDevMin, double windowWidth, double windowHeight);
 
    /*
    virtual
    void computeFuzzyDBZ(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const;
 
    virtual
    void computeFuzzyVRAD(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const;
 
    virtual
    void computeFuzzyZDR(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const;
 
    virtual
    void computeFuzzyRHOHV(const PlainData<PolarSrc> & src, PlainData<PolarDst> & dstData, DataSet<PolarDst> & dstProduct) const;
    */
 
    /*
    virtual inline
    const drain::Fuzzifier<double> & getDBZFuzzifier() const override {
        // dbzFuzzifier.set(dbzParam);
        return dbzFuzzifier;
    }
    */
 
    /*
    virtual inline
    RadarFunctorBaseOp & getDBZFuzzifier() const override {
        dbzFuzzifier.functor.set(dbzParam);
        return dbzFuzzifier;
    }
    */
 
private:
 
    //mutable
    // RadarFunctorOp<drain::FuzzyStep<double> > dbzFuzzifier;
    // RadarDataFunctor<drain::FuzzyStep<double> > dbzFuzzifier;
 
};
 
 
 
} // rack::
 
#endif /* NONMET_OP_H_ */