DualPolBioMetOp.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_GLIDER_OP
#define RACK_GLIDER_OP
 
#include <string>
 
#include <drain/image/Image.h>
#include <drain/image/Window.h>
#include <drain/imageops/ImageOp.h>
 
 
#include "FuzzyDetectorOp.h"
 
// RAISED
/*
#include <drain/imageops/SlidingWindowOp.h>
#include "radar/Analysis.h"
#include "radar/Doppler.h"
 
//#include "data/Data.h"
#include "andre/DetectorOp.h"
// #include <drain/util/FunctorPack.h>
// #include <drain/util/Fuzzy.h>
// RAISED
*/
 
 
 
namespace rack {
 
using namespace drain::image;
 
 
class DualPolBioMetOp: public FuzzyDetectorOp {
 
public:
 
    inline
    DualPolBioMetOp(const std::string & name, const std::string & description, const std::string & classCode) : FuzzyDetectorOp(name, description, classCode){
    }
 
    inline
    DualPolBioMetOp(const DualPolBioMetOp & op) : FuzzyDetectorOp(op){
    }
 
    virtual inline
    const QuantitySelector & getSelectorDBZ() const override {
        return selectorDBZ;
    };
 
    virtual inline
    const QuantitySelector & getSelectorVRAD() const override {
        return selectorVRAD;
    };
 
    virtual inline
    const QuantitySelector & getSelectorZDR() const override {
        return selectorZDR;
    };
 
    virtual inline
    const QuantitySelector & getSelectorRHOHV() const override {
        return selectorRHOHV;
    };
 
 
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierZDR(LocalFunctorBank & bank) const override {
        typedef drain::FuzzyTriangle<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        functor.set(::abs(zdrAbsThreshold), -::abs(zdrAbsThreshold), 0.0); // INVERSE
        return functor;
    }
 
    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;
    }
 
 
 
 
};
 
 
class BirdOp: public DualPolBioMetOp {
 
public:
 
//  BirdOp(double dbzPeak = -5.0, double vradDevMin = 5.0, double rhoHVmax = 0.7, double zdrAbsMin = 2.0, double windowWidth = 2500, double windowHeight = 5.0) :
    BirdOp(double dbzPeak = -10.0, double vradDevMin = 1.0, double rhoHVmax = 0.99, double zdrAbsMin = 1.0, double windowWidth = 2500, double windowHeight = 5.0) :
 
        DualPolBioMetOp(__FUNCTION__, "Estimates bird probability from DBZH, VRAD, RhoHV and ZDR.", "nonmet.biol.bird"){
 
        init(dbzPeak, vradDevMin, rhoHVmax, zdrAbsMin, windowWidth, windowHeight);
 
    };
 
    inline
    BirdOp(const BirdOp & op) : DualPolBioMetOp(op) {
        this->parameters.copyStruct(op.getParameters(), op, *this);
    };
 
    virtual inline
    ~BirdOp(){};
 
    virtual
    void init(double dbzPeak, double vradDevMax, double rhoHVmax, double zdrDevMin, double windowWidth, double windowHeight);
 
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierDBZ(LocalFunctorBank & bank) const override {
 
        drain::Logger mout(__FUNCTION__, getName());
        typedef drain::FuzzyBell2<double> ftor_t;
        // typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
 
        if (dbzParam.min < dbzParam.max){
            functor.set(dbzParam);
        }
        else if (dbzParam.min > dbzParam.max){ // INVERSE
            functor.set(dbzParam.max, dbzParam.min);
        }
        else{
            // span out
            functor.set(dbzParam.min+15.0, dbzParam.max-15.0);
        }
 
        /*
        typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        if (dbzParam.min > dbzParam.max){ // INVERSE
            // mout.warn("Ok, INVERSE:", dbzParam);
            functor.set(dbzParam);
        }
        else if (dbzParam.min < dbzParam.max){
            // mout.warn("Ok, reversing:", dbzParam.max, '-', dbzParam.min);
            functor.set(dbzParam.max, dbzParam.min);
        }
        else {
            // span out
            functor.set(dbzParam.min+15.0, dbzParam.max-15.0);
        }
        */
        return functor;
    }
 
    // Birds are expected to move independently and fast
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierVRAD(LocalFunctorBank & bank) const override {
        typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        functor.set(vradDevThreshold-1.0, vradDevThreshold+1.0);
        return functor;
    }
 
    /*
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierVRAD(LocalFunctorBank & bank) const override {
        typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        functor.set(vradDevThreshold-1.0, vradDevThreshold+1.0);
        return functor;
    }
    */
 
};
 
 
class InsectOp: public DualPolBioMetOp {
 
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
 
    // InsectOp(double dbzPeak = -10.0, double vradDevMax = +5.0, double rhoHVmax = 0.7, double zdrAbsMin = 3.0, double windowWidth = 2500, double windowHeight = 5.0) :
    InsectOp(double dbzMax = 0.0, double vradDevMax = +5.0, double rhoHVmax = 0.99, double zdrAbsMin = 3.0, double windowWidth = 2500, double windowHeight = 5.0) :
        DualPolBioMetOp(__FUNCTION__, "Probability of insects, based on DBZH, VRAD, RhoHV and ZDR.", "nonmet.biol.insect"){
        init(dbzMax, vradDevMax, rhoHVmax, zdrAbsMin, windowWidth, windowHeight);
    };
 
    InsectOp(const InsectOp & op) : DualPolBioMetOp(op) {
        this->parameters.copyStruct(op.getParameters(), op, *this);
    }
 
    virtual
    void init(double dbzMax, double vradDevMax, double rhoHVmax, double zdrDevMin, double windowWidth, double windowHeight);
 
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierDBZ(LocalFunctorBank & bank) const override {
        typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        if (dbzParam.min > dbzParam.max){ // INVERSE
            functor.set(dbzParam);
        }
        else if (dbzParam.min < dbzParam.max){
            functor.set(dbzParam.max, dbzParam.min);
        }
        else {
            // span out
            functor.set(dbzParam.min+5.0, dbzParam.max-5.0);
        }
        return functor;
    }
 
    // Insects are expected to float, mostly
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierVRAD(LocalFunctorBank & bank) const override {
        typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        functor.set(vradDevThreshold+1.0, vradDevThreshold-1.0);
        return functor;
    }
 
    /*
    virtual inline
    drain::Fuzzifier<double> & getFuzzifierVRAD(LocalFunctorBank & bank) const override {
        typedef drain::FuzzyStep<double> ftor_t;
        ftor_t & functor = bank.clone<ftor_t>();
        functor.set(vradDevThreshold+1.0, vradDevThreshold-1.0); // INVERSE
        return functor;
    }
    */
 
};
 
 
}
 
#endif
 
// Rack