ConvOp.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 POLARCB_H_
#define POLARCB_H_
 
#include <algorithm>
#include "radar/Geometry.h"
 
//#include "RackOp.h"
#include "PolarProductOp.h"
 
namespace rack
{
 
using namespace drain::image;
 
 
 
 
class ConvOp : public PolarProductOp {
 
public:
 
 
     /*  EI KÄYTÖSSÄ \subsection alg_Cb
     *
     *  Radar measurement is sparse; the dBZ threshold lies seldom at the beam but more often between two beams or outside all the beams.
     *  In computing the
     *
     *  - (a) Between lower and higher dBZ: the height is interpolated
     *  - (b) Under \c undetect and above higher dBZ: the height is interpolated, assuming reference measurement \f$ (z_{r},h_{r}) \f$
     *  - (c) Above two highest beams, which have higher, decreasing dBZ values : the height is extrapolated
     *  - (d) Above two highest beams, which have higher, increasing dBZ values : the height is extrapolated; lower quality is assigned
     *  - (e) Above higher dBZ and \undetect measurement : the height is extrapolated; lower quality is assigned
     *
     *  \image html  Cb-principle.png "The location of the dBZ threshold with respect to measurements on the beam."
     *  \image latex Cb-principle.png "The location of the dBZ threshold with respect to measurements on the beam."
     *
     */
 
    //
    ConvOp(double maxEchoThreshold = 25.0, double cellDiameter = 3.0, double echoTopThreshold = 2.0, double echoTopDBZ = 20.0, double smoothRad = 0.0, double smoothAzm = 0.0) :
        PolarProductOp(__FUNCTION__, "Computes the probability of convection based on fuzzy cell intensity, area and height."), top(true) {
 
        parameters.link("maxEchoThreshold", this->maxEchoThreshold = maxEchoThreshold, "dBZ");
        parameters.link("cellDiameter", this->cellDiameter = cellDiameter, "km");
        parameters.link("echoTopThreshold", this->echoTopThreshold = echoTopThreshold, "km");
        parameters.link("echoTopDBZ", this->echoTopDBZ = echoTopDBZ, "dBZ");
 
        parameters.link("smoothAzm", this->smoothAzm = smoothAzm, "deg");
        parameters.link("smoothRad", this->smoothRad = smoothRad, "km");
 
        allowedEncoding.link("nbins", odim.area.width = 0l);
        allowedEncoding.link("rscale", odim.rscale = 0.0);
 
 
        allowedEncoding.link("undetect", odim.undetect = 0.0);
        allowedEncoding.link("nodata",   odim.nodata = 0.0);
 
        dataSelector.setQuantities("^DBZH$");
 
        odim.product = "CONVECTION";
        odim.quantity = "PROB";
        //odim.scaling.scale = 1.0/250.0;
        //odim.scaling.offset = 0;
    };
 
 
 
 
    double maxEchoThreshold;
    double echoTopDBZ;
    double cellDiameter;
    double echoTopThreshold;
 
    double smoothAzm;
    double smoothRad;
 
    const bool top;
 
protected:
 
    void computeSingleProduct(const DataSetMap<PolarSrc> & srcSweeps, DataSet<PolarDst> & dstProduct) const;
    // virtual
    // void filter(const Hi5Tree & src, const std::map<double,std::string> & srcPaths, Hi5Tree &dst) const;
 
 
};
 
 
 
 
 
} // ::rack
 
#endif /*POLARCbTOP_H_*/
 
// Rack