Doppler.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_ANALYSIS_DOPPLER_H
#define RACK_ANALYSIS_DOPPLER_H
 
#include <math.h>
 
#include <drain/Log.h>
#include <drain/Type.h>
#include <drain/util/Fuzzy.h>
#include <drain/util/Functor.h>
#include <drain/util/FunctorBank.h>
#include <drain/image/Window.h>
#include <drain/image/SlidingWindow.h>
 
#include "RadarWindows.h"
 
 
using namespace drain::image;
 
namespace rack {
 
 
class DopplerWindow : public SlidingRadarWindow<RadarWindowConfig> {
public:
 
 
    DopplerWindow(const RadarWindowConfig & conf) :
        SlidingRadarWindow<RadarWindowConfig>(conf),  radialSpeedConv(0.0) ,  radialSpeedConvInv(1.0),
            sumI(0.0), sumI2(0.0), sumJ(0.0), sumJ2(0.0), count(0){}; //, countMin(0) {};
 
    virtual
    inline
    ~DopplerWindow(){};
 
protected:
 
 
 
    double radialSpeedConv;
 
 
    double radialSpeedConvInv;
 
 
    // cumulants
    double sumI;
    double sumI2;
    double sumJ;
    double sumJ2;
    int count;
 
    virtual inline
    void initialize(){
 
        drain::Logger mout("RadarWindowDopplerDev", __FUNCTION__);
 
        this->setImageLimits();
        this->setLoopLimits();
        this->setRangeNorm();
 
 
        this->NI = this->odimSrc.getNyquist(LOG_WARNING); // warn if guessed from scaling
        if (this->NI == 0.0){
            mout.warn(odimSrc );
            mout.error("Could not derive Nyquist velocity (NI) from metadata." );
            radialSpeedConv    = 1.0;
            radialSpeedConvInv = 1.0;
        }
        else {
            radialSpeedConv    = M_PI     / this->NI;
            radialSpeedConvInv = this->NI /     M_PI;  // M_1_PI * this->NI;
        }
 
        reset();
 
    };
 
 
    virtual inline
    void clear(){
        sumI  = 0.0;
        sumI2 = 0.0;
        sumJ  = 0.0;
        sumJ2 = 0.0;
        count = 0;
    };
 
 
    virtual
    inline
    void removeTrailingValue(double x){
        x *= radialSpeedConv;
        double t;
        t = cos(x);
        sumI  -= t;
        sumI2 -= t*t;
        t = sin(x);
        sumJ  -= t;
        sumJ2 -= t*t;
        --count;
    };
 
    virtual inline
    void addLeadingValue(double x){
        x *= radialSpeedConv;
        double t;
        t = cos(x);
        sumI  += t;
        sumI2 += t*t;
        t = sin(x);
        sumJ  += t;
        sumJ2 += t*t;
        ++count;
        //if ((this->p.x == this->p.y) && (x > -15.0))
        //  std::cerr << "handleLeadingPixel" << this->p << ':' << x << '\t' << count << ':' << sum << std::endl;
    };
 
    virtual inline
    double averageR(){
        return atan2(sumJ, sumI);
    }
 
 
    virtual inline
    double stdDevR(){
        double c = 1.0/static_cast<double>(count);
        return ::sqrt((sumI2+sumJ2 - (sumI*sumI+sumJ*sumJ)*c)*c);
    }
 
 
    virtual inline
    double eccentricity(){
        return ::sqrt(sumI*sumI + sumJ*sumJ) / static_cast<double>(count);
    }
 
};
 
 
class DopplerAverageWindow : public DopplerWindow {
 
public:
 
    DopplerAverageWindow(const RadarWindowConfig & conf) : DopplerWindow(conf) {
 
    }
 
    typedef DopplerAverageWindow unweighted;
 
protected:
 
    virtual
    inline
    void write(){
        //if ((this->location.x == this->location.y) && (this->location.x%15  == 0))
        //  std::cerr << "write" << this->location << ':' << '\t' << count << ':' << (this->conf.contributionThreshold * this->samplingArea) << std::endl;
 
        if (count > countMin){ // TODO threshold 0.5?
 
            if (this->conf.relativeScale)
                this->dst.putScaled(this->location.x, this->location.y, averageR() * M_1_PI); // todo ftor?
            else
                this->dst.putScaled(this->location.x, this->location.y, averageR() * this->radialSpeedConvInv);
            /*
            if (this->debugDiag()){
                std::cerr << "write: " << this->location.x << ":\t"
                        << atan2(sumJ, sumI) << "~\t"
                        << ((this->conf.relativeScale?M_1_PI:this->radialSpeedConvInv) * atan2(sumJ, sumI)) << ":\t"
                        << this->dst.getScaled(this->location.x, this->location.y) << '\t'
                        << this->dst.get<double>(this->location.x, this->location.y) << '\n';
            }
            */
        }
        else
            this->dst.put(this->location, this->odimSrc.undetect); // NOTE: may be wrong (C/S), add odimDst?
 
    };
 
};
 
class DopplerAverageWindow2 : public DopplerWindow {
 
public:
 
    DopplerAverageWindow2(const RadarWindowConfig & conf) : DopplerWindow(conf) {
 
    }
 
    typedef DopplerAverageWindow2 unweighted; // ????
 
protected:
 
    virtual inline
    void write(){
 
        //if ((this->location.x == this->location.y) && (this->location.x%15  == 0))
        //  std::cerr << "write" << this->location << ':' << '\t' << count << ':' << (this->conf.contributionThreshold * this->samplingArea) << std::endl;
 
        double confidence = this->myFunctor(this->eccentricity());
 
        if (count > countMin){ // TODO threshold 0.5?
 
            if (this->conf.relativeScale)
                this->dst.putScaled(this->location.x, this->location.y, averageR() * M_1_PI); //
            else
                this->dst.putScaled(this->location.x, this->location.y, averageR() * this->radialSpeedConvInv);
 
            this->dstWeight.putScaled(this->location.x, this->location.y, confidence);
            //this->dstWeight.putScaled(this->location.x, this->location.y, this->conf.ftor(this->NI*stdDevR()));
            //this->dstWeight.putScaled(this->location.x, this->location.y, this->eccentricity());
 
        }
        else {
            this->dst.put(this->location, this->odimSrc.undetect); // NOTE: may be wrong (C/S), add odimDst?
            this->dstWeight.put(this->location, 0.0); // NOTE: may be wrong (C/S), add odimDst?
        }
 
    };
 
};
 
 
class DopplerDevWindow : public DopplerWindow {
 
public:
 
    DopplerDevWindow(const RadarWindowConfig & conf) : DopplerWindow(conf){
    }
 
    typedef DopplerDevWindow unweighted;
 
protected:
 
 
    virtual inline
    void write(){
 
        if (count > countMin){ // TODO threshold 0.5?
 
            if (this->conf.relativeScale)
                this->dst.putScaled(this->location.x, this->location.y, this->myFunctor(stdDevR()));
            else
                //this->dst.putScaled(this->location.x, this->location.y, this->conf.ftor(c));
                // NOTE: possibly odimSrc != odimDst, (C/S), add odimDst?
                this->dst.putScaled(this->location.x, this->location.y, this->myFunctor(NI * stdDevR()) );
            /*
            if (this->debugDiag()){
                std::cerr << "write: " << this->location.x << ":\t" << (int) this->conf.relativeScale << '\t'
                        << c << ">\t"
                        << (this->conf.relativeScale ? c : c*this->odimSrc.NI ) << ":\t"
                        << this->dst.getScaled(this->location.x, this->location.y) << '\t'
                        << this->dst.get<double>(this->location.x, this->location.y) << '\n';
            }
            */
 
        }
        // else this->dst.put(this->location, 0); LEAVE undetect
 
    };
 
};
 
//DRAIN_TYPENAME(DopplerDevWindow);
 
class DopplerEccentricityWindow : public DopplerWindow {
 
public:
 
    DopplerEccentricityWindow(const RadarWindowConfig & conf) : DopplerWindow(conf) {
 
    }
 
    typedef DopplerEccentricityWindow unweighted; // ????
 
protected:
 
    virtual inline
    void write(){
 
        //if ((this->location.x == this->location.y) && (this->location.x%15  == 0))
        //  std::cerr << "write" << this->location << ':' << '\t' << count << ':' << (this->conf.contributionThreshold * this->samplingArea) << std::endl;
 
        //double confidence = this->conf.ftor(this->eccentricity());
 
        if (count > countMin){ // TODO threshold 0.5?
            this->dst.putScaled(this->location.x, this->location.y, this->myFunctor(this->eccentricity()));
        }
        else {
            this->dst.put(this->location, this->odimSrc.undetect); // NOTE: may be wrong (C/S), add odimDst?
        }
 
    };
 
};
 
 
} // rack::
 
namespace drain {
 
 
    DRAIN_TYPENAME(rack::DopplerWindow);
    DRAIN_TYPENAME(rack::DopplerAverageWindow);
    DRAIN_TYPENAME(rack::DopplerAverageWindow2);
    DRAIN_TYPENAME(rack::DopplerDevWindow);
}
 
 
#endif
 
// Rack