EncodingODIM.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 ENC_ODIM_STRUCT
#define ENC_ODIM_STRUCT
 
#include <cmath>
#include <string>
//#include <drain/util/Options.h>
#include <drain/util/ReferenceMap.h>
#include <drain/util/Time.h>
#include <drain/util/ValueScaling.h>
 
#include "hi5/Hi5.h"
#include "ODIMPath.h"
 
namespace rack {
 
 
class EncodingODIM : public drain::ReferenceMap {  // public ODIMPathElem,
 
public:
 
    typedef ODIMPathElem::group_t group_t;
 
    drain::ValueScaling & scaling;
    const drain::ValueScaling & scalingConst;
 
    drain::ValueScaling ownScaling;
 
    typedef enum {NONE=0, SCALING=1, RANGE=2} ExplicitSetting;
 
    static
    const drain::FlagResolver::dict_t settingDict;
 
    //typedef drain::EnumFlagger<drain::SingleFlagger<TiffCompliance> > tiffComplianceFlagger;
    //typedef drain::EnumFlagger<drain::MultiFlagger<Adaption> > AdaptionFlagger;
 
    int explicitSettings = NONE;
 
    inline
    EncodingODIM(group_t initialize = ODIMPathElem::ALL_LEVELS) : scaling(ownScaling), scalingConst(ownScaling), explicitSettings(NONE){
        init(initialize);
    };
 
    EncodingODIM(const EncodingODIM & odim);
 
 
    EncodingODIM(char type, double scale=1.0, double offset=NAN, double nodata = NAN, double undetect = NAN, const drain::Range<double> & range = {0,0});
 
 
    EncodingODIM(char type, const drain::Range<double> & range, double scale=0.0, double offset=NAN, double nodata = NAN, double undetect = NAN);
 
 
    inline
    EncodingODIM(const drain::image::Image & image) : scaling(ownScaling), scalingConst(image.getScaling()), explicitSettings(NONE) {
        initFromImage(image);
    };
 
    inline
    EncodingODIM(drain::image::Image & image) : scaling(image.getScaling()), scalingConst(image.getScaling()), explicitSettings(NONE) {
        initFromImage(image);
    };
 
    inline
    void copyEncoding(const EncodingODIM & odim){
        // updateFromMap(odim); // risk: copies attribs also beyon ODIM?
        type     = odim.type;
        scaling.set(odim.scaling);
        nodata   = odim.nodata;
        undetect = odim.undetect;
        explicitSettings = odim.explicitSettings;
    }
 
    inline
    EncodingODIM & operator=(const EncodingODIM & odim) {
        // std::cerr << "EncodingODIM & operator=" << std::endl;
        // updateFromMap(odim);
        // explicitSettings = odim.explicitSettings;
        copyEncoding(odim);
        return *this;
    }
 
    // In case of const image this is not "true" ? But for const EncodingODIM, never called?
    operator drain::ValueScaling & (){
        return scaling;
    }
 
    operator const drain::ValueScaling & () const {
        return scalingConst;
    }
 
 
 
    std::string type;
 
    double nodata;
    double undetect;
 
    EncodingODIM & setScaling(double gain, double offset = NAN);
 
    EncodingODIM & setScaling(double gain, double offset, double undetect, double nodata);
 
    inline
    bool isSet() const {
        return ((scaling.scale != 0.0) && (!type.empty()) && (type.at(0) != '*'));
    }
 
    // todo: bool operator==(const EncodingODIM & odim);
    static
    inline
    bool haveSimilarEncoding(const EncodingODIM & odim1, const EncodingODIM & odim2){
        return  (odim1.type == odim2.type) &&
                (odim1.scaling.scale == odim2.scaling.scale) &&
                (odim1.scaling.offset == odim2.scaling.offset) &&
                (odim1.undetect == odim2.undetect) &&
                (odim1.nodata == odim2.nodata)
                ;
    };
 
    void setRange(double min, double max);
 
    //template <class T>
    inline
    void setType(const std::type_info & type){
        this->type = drain::Type::getTypeChar(type);
        scaling.set(1.0, 0.0);
        undetect = drain::Type::call<drain::typeMin, double>(type);
        nodata   = drain::Type::call<drain::typeMax, double>(type);
    }
 
    template <class T>
    inline
    void setTypeDefaults(const T & type, const std::string & values = ""){
 
        drain::Logger mout(__FILE__, __FUNCTION__);
 
        drain::Type t(type);
        const char typechar = drain::Type::getTypeChar(t);
        if (this->type.empty())
            this->type = typechar;
        else {
            if (this->type.at(0) != typechar)
                mout.warn("different types: " , this->type , '/' , typechar );
        }
 
        scaling.set(1.0, 0.0);
 
        //if (!type.empty()){ // ?
        if (typechar != '*'){
            undetect = drain::Type::call<drain::typeMin, double>(t); //drain::Type::getMin<double>(t);
            nodata   = drain::Type::call<drain::typeMax, double>(t); // drain::Type::call<drain::typeMax,double>(t);
        }
        else {
            undetect = drain::Type::call<drain::typeMin, double>(this->type); //drain::Type::getMin<double>(this->type);
            nodata   = drain::Type::call<drain::typeMax, double>(this->type); //drain::Type::call<drain::typeMax,double>(this->type);
        }
 
        setValues(values);
 
    }
 
    inline
    void setTypeDefaults(){
        setTypeDefaults(this->type);
    }
 
    inline
    bool isValue(double x) const {
        return (x != undetect) && (x != nodata);
    }
 
    inline
    double scaleForward(double x) const {
        return scaling.offset + scaling.scale*x; // TODO: direct
    }
 
    inline
    double scaleInverse(double y) const {
        return (y-scaling.offset)/scaling.scale; // TODO: direct
    }
 
    double getMin() const;
 
    double getMax() const;
 
    inline
    double operator()(double y) const {
        return (y-scaling.offset)/scaling.scale;
    }
 
 
    // ?virtual?
    void clear();
 
 
    /*
    inline
    void getShortKeys(std::map<std::string,std::string> & m){
         for (ReferenceMap::iterator it = begin(); it != end(); ++it){
             const std::string & longKey = it->first;
             const std::string  shortKey = longKey.substr(0,longKey.find(':'));
             m[shortKey] = longKey;
             std::cerr << shortKey << '#' << longKey << '\n';
         }
    }
    */
 
 
    virtual
    void updateLenient(const EncodingODIM & odim);
 
 
    /*
     *  Does not change the values of the map.
     *
     *  The object itself can be given as an argument, \see addShortKeys().
     */
    void grantShortKeys(drain::ReferenceMap & ref);
 
    /*
     *  Does not change the values of the map.
     */
    inline
    void addShortKeys(){
        grantShortKeys(*this);
    }
 
 
    void copyFrom(const drain::image::Image & data);
 
 
    static
    inline
    void checkType(Hi5Tree & dst){
        EncodingODIM odim;
        checkType(dst, odim);
    } // Temp for thread-safety.
 
 
 
    static
    const ODIMPathElemSeq & attributeGroups;
 
    //bool RANGE_DRIVEN;
 
protected:
 
 
 
    static
    void checkType(Hi5Tree & dst, EncodingODIM & odim); // SEE ABOVE?
 
 
    static
    const ODIMPathElemSeq & getAttributeGroups();
 
 
private:
 
    virtual // must
    void init(group_t initialize = ODIMPathElem::ALL_LEVELS);
 
    void initFromImage(const drain::image::Image & img);
 
};
 
 
 
}  // namespace rack
 
 
#endif
 
// Rack