PolarODIM.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 POLAR_ODIM_STRUCT
#define POLAR_ODIM_STRUCT
 
//#include <drain/TypeName.h>
#include <drain/util/Units.h>
 
#include "ODIM.h"
 
namespace rack {
 
 
class PolarODIM : public ODIM {
 
 
public:
 
    PolarODIM(group_t initialize = ODIMPathElem::ALL_LEVELS) : ODIM(initialize), rscale(resolution.x){
        init(initialize);
    };
 
    PolarODIM(const PolarODIM & odim) : ODIM(ODIMPathElem::ALL_LEVELS), rscale(resolution.x), highprf(0.0) {
        initFromMap(odim);
        getNyquist();
    }
 
    template <class T>
    PolarODIM(const std::map<std::string,T> & m) : ODIM(ODIMPathElem::ALL_LEVELS), rscale(resolution.x), highprf(0.0) {
        initFromMap(m);
        getNyquist();
    }
 
    PolarODIM(const drain::image::Image & img, const std::string & quantity="") : ODIM(ODIMPathElem::ALL_LEVELS), rscale(resolution.x), highprf(0.0) {
        initFromImage(img, quantity);
    }
 
    inline
    rack::PolarODIM & operator=(const rack::PolarODIM & odim){
        updateFromMap(odim);
        // updateFromCastableMap(odim);
        return *this;
    }
 
    double  & rscale;
 
    double lon = 0.0;
    double lat = 0.0;
    double height = 0.0;
 
    double elangle = 0.0;
    double rstart = 0.0;
    long   a1gate = 0.0;
 
 
    double startaz = 0.0;
    double stopaz = 0.0;
 
    //double NI; // Maximum Nyquist
    double highprf = 0.0; //
    double lowprf = 0.0;  //
    double wavelength = 0.0;
 
    double freeze = 0.0;
 
 
    virtual inline
    const drain::image::CoordinatePolicy & getCoordinatePolicy() const {
        using namespace drain::image;
        static const CoordinatePolicy polarLeft(EdgePolicy::POLAR, EdgePolicy::WRAP, EdgePolicy::LIMIT, EdgePolicy::WRAP);
        return polarLeft;
    }
 
    /*
    inline
    void setGeometry(size_t cols, size_t rows){
        nbins = cols;
        nrays = rows;
    }
    */
 
 
    virtual
    void updateLenient(const PolarODIM & odim);
 
 
 
    inline
    bool optimiseVRAD(){
        if (quantity.find("VRAD") == 0){
            getNyquist();
            setRange(-NI, NI);
            return true;
        }
        else
            return false;
    }
 
    // Sets how:NI from lowprf if needed. If that fails, tries to derive it from scaling (gain, offset).
    double getNyquist(int errorThreshold = LOG_NOTICE) const;
 
 
    inline
    double getBeamWidth() const {
        return 2.0*M_PI/static_cast<double>(area.height);
    };
 
    bool deriveDifference(double v1, double v2, double & dOmega) const;
 
 
    signed char checkAliasing(double v1, double v2, double NI_threshold) const;
 
    inline
    double getElangleR() const {
        return elangle * drain::DEG2RAD;
    }
 
    // CF ? Returns the distance in metres to the start of the measurement volume (i.e. the end nearer to radar).
    inline
    double getBinDistance(size_t i) const {
        return rstart + (static_cast<double>(i)+0.5)*rscale;
    }
 
    inline
    double getBinSpan(size_t i) const {
        return (static_cast<double>(i))*rscale;
    }
 
    inline
    int getBinIndex(double d) const {
        return static_cast<int>((d - rstart) / rscale) ;
    }
 
    inline
    int getRayIndex(double d) const {
        return static_cast<int>(d * static_cast<double>(area.height)/(2.0 * M_PI)) ;
    }
 
    inline
    int getDRayIndex(double d) const {
        return static_cast<int>(d * static_cast<double>(area.height) / 360.0) ;
    }
 
    template <class T>
    inline
    double getAzimuth(T j) const {
        return static_cast<double>(j)*2.0*M_PI / static_cast<double>(area.height);
    }
 
 
    inline
    int getAzimuthalBins(double degree) const {
        return static_cast<int>(degree * static_cast<double>(area.height)/360.0 + 0.5) ;
    }
 
    /*
     *   Returns the number of bins corresponding to a given distance range (in meters).
     *   \see getAzimuthalBins()
     */
    inline
    int getBeamBins(double spanM) const {
        return static_cast<int>(spanM/rscale + 0.5) ;
    }
 
    //inline
    double getMaxRange(bool warn = false) const;
 
    double getGroundAngle(size_t i) const {
        return (static_cast<double>(i)+0.5) * rscale / EARTH_RADIUS_43;
    }
 
    inline
    void mapDopplerSpeed(double d, double &x, double &y) const {
        d = scaleForward(d) * M_PI/NI;
        //std::cerr << d << '\n';
        x = cos(d);
        y = sin(d);
    }
 
 
    static double defaultRange;
 
private:
 
    virtual // must
    void init(group_t initialize =ODIMPathElem::ALL_LEVELS);
 
 
};
 
 
 
 
 
}  // namespace rack
 
namespace drain {
    DRAIN_TYPENAME(rack::PolarODIM);
}
 
 
#endif
 
// Rack