ODIM.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 ODIM_STRUCT
#define ODIM_STRUCT
 
#include <ostream>
#include <cmath>
#include <string>
#include <set>
#include <algorithm>
//
#include <drain/util/VariableFormatter.h>  // for VariableHandler
#include <drain/util/ReferenceMap.h>
#include <drain/util/Rectangle.h>
#include <drain/util/Time.h>
#include <drain/image/Geometry.h>
 
#include "hi5/Hi5.h"
#include "radar/Constants.h"
 
#include "EncodingODIM.h"
 
namespace rack {
 
 
class ODIM : public EncodingODIM { //, public  {
 
public:
 
    typedef enum {
        KILOMETRES = 1,
        RACK_EXTENSIONS = 8, // like where:BBOX
        ODIM_2_2 = 16 | KILOMETRES, 
        ODIM_2_3 = 32 | KILOMETRES, 
        // ODIM_2_3_6 = 64
        ODIM_2_4 = 64    
    } Version;
 
    //typedef drain::EnumFlagger<drain::SingleFlagger<Version> > VersionFlagger;
    typedef drain::EnumFlagger<drain::MultiFlagger<Version> > VersionFlagger; // Multi, for KM's
 
    static VersionFlagger versionFlagger;
 
    typedef std::set<std::string> nameSet;
 
    static
    const nameSet timeKeys; // = {"time", "starttime", "endtime"};
 
    static
    const nameSet dateKeys; // = {"date", "startdate", "enddate"};
 
    static
    const nameSet locationKeys; // = {"site", "src", "lat", "lon", "PLC", "NOD", "WMO"};
 
 
 
    inline
    ODIM(group_t initialize = ODIMPathElem::ALL_LEVELS) : EncodingODIM(initialize){
        init(initialize);
    };
 
    // TODO: CHECK: -Wdeprecated-copy fires because this copy constructor is user-declared but
    // operator= is not. Unlike EncodingODIM's own operator= (which only copies a narrow set of
    // scalar encoding fields via copyEncoding()), this copy constructor calls initFromMap(odim),
    // copying the full set of registered ODIM attributes (date, time, source, product, etc.).
    // The implicit operator= (inherited from EncodingODIM's narrower one, plus memberwise NI)
    // would NOT replicate that - so adding a naive `=default`/inherited operator= here would be
    // semantically incomplete, not just a warning-silencing no-op. Needs a real decision.
    inline
    ODIM(const ODIM & odim) : EncodingODIM(ODIMPathElem::ALL_LEVELS), NI(odim.NI){
        initFromMap(odim);
    };
 
    inline
    ODIM(const drain::image::Image & image, const std::string & quantity="") : EncodingODIM(image) {
        initFromImage(image, quantity);
    };
 
    inline
    ODIM(drain::image::Image & image, const std::string & quantity="") : EncodingODIM(image) {
        initFromImage(image, quantity);
    };
 
    /*
    inline
    ODIM(const drain::image::Image & image, const std::string & quantity="") : EncodingODIM(image) {
        initFromImage(image, quantity);
    };
    */
 
    /*
    inline
    ODIM(drain::image::Image & image, const std::string & quantity="") : geometryREF(image.geometry) {
        initFromImage(image, quantity);
    };
    */
 
    inline
    ~ODIM(){};
 
    //const drain::image::AreaGeometry geometry;
 
    drain::image::AreaGeometry area;
 
 
    drain::Point2D<double> resolution;
 
    //const drain::image::AreaGeometry & geometryTEST;
 
    static
    const std::string dateformat;
 
    static
    const std::string timeformat;
 
 
    std::string object;
    std::string version;
 
    std::string date;
    std::string time;
    std::string source;
 
    std::string quantity;  // raise?
    std::string product;   // raise?
    std::string prodpar;   // raise?
    std::string startdate;
    std::string starttime;
    std::string enddate;
    std::string endtime;
 
    // Elevation angles.
    // In ODIM, defined for Cartesian but used more generally - for polar products - in Rack
    std::vector<double> angles;
    // double angles = 0.0; // FIX!
 
 
    // Number of images used in precipitation accumulation (lenient, not linked)
    long ACCnum = 0;
 
    // NEW - moved from ProductBase: applyODIM
    void configureNEW(const ODIM & defaultODIM, bool useTypeDefaults=false);
 
    // Moved/copied from ProductBase::setODIMspecials(productODIM);
    void setSpecials();
 
    virtual inline
    void setGeometry(size_t cols, size_t rows){
        area.set(cols, rows);
    };
 
 
    virtual
    void setGeometry(const drain::image::AreaGeometry & g){
        setGeometry(g.getWidth(), g.getHeight());
    };
 
    virtual // ?
    const drain::image::AreaGeometry & getGeometry() const {
        return area;
    };
 
    virtual
    void adjustGeometry(size_t cols, size_t rows);
 
 
 
 
    virtual
    void updateLenient(const ODIM & odim);
 
    void completeEncoding(const std::string & encoding);
 
    inline
    bool getTime(drain::Time & t) const {
        return getTime(t, date, time);
    }
 
    inline
    bool getStartTime(drain::Time & t) const {
        return getTime(t, startdate, starttime);
    }
 
    inline
    bool getEndTime(drain::Time & t) const {
        return getTime(t, enddate, endtime);
    }
 
    bool setTime(const drain::Time & t);
 
    bool setTime(const std::string & s);
 
 
    virtual inline
    const drain::image::CoordinatePolicy & getCoordinatePolicy() const {
        //using namespace drain::image;
        static const drain::image::CoordinatePolicy policy(drain::image::EdgePolicy::LIMIT);
        return policy;
        //return rack::limit;
    }
 
 
    bool distinguishNodata(const std::string & quantityPrefix = "");
 
 
 
    template <group_t G, class T>
    static inline
    void updateH5AttributeGroups(const T &odim, Hi5Tree & dst) {
        static const T odimLimited(G);
        static const std::list<std::string> & keys = odimLimited.getKeyList();
        //odim.copyTo(odimLimited.getKeyList(), dst);
        odim.copyTo(keys, dst);
    }
 
    template <group_t G, class T>
    static inline
    void updateH5AttributeGroups(const T &, const Hi5Tree &) {
        // void updateH5AttributeGroups(const T &odim, const Hi5Tree & dst) {
        //static T odimLimited(G);
        //odim.copyTo(odimLimited.getKeyList(), dst);
    }
 
 
 
 
    // Maximum Nyquist velocity, mutable because may be updated with PolarODIM::getNyquist()
    mutable
    double NI;
 
 
 
//protected:
 
    static
    bool getTime(drain::Time & t, const std::string &dateStr, const std::string &timeStr); // const;
 
protected:
 
    void copyTo(const std::list<std::string> & keys, Hi5Tree & dst) const;
 
 
    template <class T>
    inline
    void initFromMap(const std::map<std::string,T> & m){
        init(ODIMPathElem::ALL_LEVELS);
        updateFromMap(m);
    }
 
    virtual inline
    void initFromImage(const drain::image::Image & img){  // =""
        init(ODIMPathElem::ALL_LEVELS);
        this->quantity = img.getProperties().get("what:quantity", "");
        copyFrom(img);
    }
 
    // deprec
    virtual inline
    void initFromImage(const drain::image::Image & img, const std::string & quantity){  // =""
        drain::Logger mout(__FILE__, __FUNCTION__);
        init(ODIMPathElem::ALL_LEVELS);
        this->quantity = quantity;
        copyFrom(img);
        //mout.warn("guantity finally=(" , this->quantity , '<' , quantity , ")" );
        //mout.warn(*this );
    }
 
private:
 
 
    virtual // must
    void init(group_t initialize =ODIMPathElem::ALL_LEVELS);
 
 
 
};
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const ODIM & odim){
    odim.drain::SmartMap<drain::Reference>::toStream(ostr);
    return ostr;
}
 
 
 
 
}  // namespace rack
 
DRAIN_ENUM_DICT(rack::ODIM::Version);
DRAIN_ENUM_OSTREAM(rack::ODIM::Version)
 
 
#endif