DataTools.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_DATATOOLS_H
#define RACK_DATATOOLS_H
 
#include <map>
 
 
#include <drain/image/CoordinatePolicy.h>
#include <drain/util/ReferenceMap.h>
 
 
#include "ODIM.h"
#include "PolarODIM.h" // elangle
 
// #include "Data.h"
 
 
namespace rack {
 
 
class TreeFileInfo : public drain::FileInfo {
 
public:
 
    inline
    TreeFileInfo() : drain::FileInfo("tre"){
    }
 
 
    bool attributeColors = true;
    bool skipExcluded = true;
 
};
 
 
class DataTools { //: public drain::BeanLike {
 
public:
 
    static
    TreeFileInfo & getTreeFileInfo();
 
 
    // static
    // const drain::Variable & getAttribute(const Hi5Tree &src, const std::string & path, const std::string & group, const std::string & attributeName);
 
 
    // template <class M>
    // static
    // void getAttributesOLD(const Hi5Tree &src, const std::string & path, M & attributes, bool updateOnly = false);
 
    // consider: path is not a reference, it will be copied.
    template <class M>
    static
    void getAttributes(const Hi5Tree &src, const Hi5Tree::path_t & path, M & attributes, bool updateOnly = false);
 
    static
    void getQuantityMap(const Hi5Tree & srcDataset, ODIMPathElemMap & m);
 
 
    static
    void updateInternalAttributes(Hi5Tree & src);
 
 
    static inline
    void updateInternalAttributes(const Hi5Tree &){ // const drain::FlexVariableMap & attributes = drain::FlexVariableMap()){
        // drain::Logger mout("DataTools", __FUNCTION__);
        // mout.warn("somebody called me");
    };
 
 
    static
    void updateCoordinatePolicy(Hi5Tree & src, const drain::image::CoordinatePolicy & policy = drain::image::CoordinatePolicy(drain::image::EdgePolicy::LIMIT));
    //void updateCoordinatePolicy(Hi5Tree & src, const CoordinatePolicy & policy = CoordinatePolicy(EdgePolicy::LIMIT));
 
    static
    int getMaxRange(const Hi5Tree & src, bool projected=true);
 
    // static
    // bool dataToStream(const Hi5Tree::node_data_t & data, std::ostream &ostr);
 
    typedef std::map<std::string, ODIMPathElem> quantity_map;
 
    /*
     *
     */
    static
    void superDump(const Hi5Tree & src, std::ostream & ostr = std::cerr);
 
    static
    void adjustWhatObject(Hi5Tree & src);
 
 
    /*
    static
    void markExcluded(Hi5Tree &src, const Hi5Tree::path_t & path, bool exclude=true);
    */
 
 
    static
    bool treeToStream(const Hi5Tree::node_data_t & data, std::ostream &ostr);
 
 
    //static
    // std::list<std::string> & getMainAttributes();
 
 
    static
    drain::VariableMap & getAttributeStyles();
    // std::list<std::string>
    // std::map<std::string,std::string>
 
    // static
    // void createSimpleQualityData(const PlainData<DT> & data, drain::image::Image & qualityImage, double dataQuality=1.0, double undetectQuality=0.5, double nodataQuality=0.0);
 
    /* cyclic
    template <class DT>
    static inline
    void createSimpleQualityData(const PlainData<DT> & data, PlainData<DT> & qualityData, double dataQuality=1.0, double undetectQuality=0.5, double nodataQuality=0.0);//, double dataQuality=1.0, double nodataQuality=0.0); //  const {
        //qualityData.odim.scaling.scale   = qualityData.data.getScaling().scale;
        //qualityData.odim.scaling.offset = qualityData.data.getScaling().offset;
    // }
     *
     */
 
protected:
 
    // static
    // drain::VariableMap attributeStyles;
 
 
 
 
    //const drain::image::CoordinatePolicy & policy = drain::image::CoordinatePolicy(),
    static
    void updateInternalAttributes(Hi5Tree & src, const drain::FlexVariableMap & attributes);
    //void updateInternalAttributes(Hi5Tree & src, const drain::VariableMap & attributes);
 
 
 
 
};
 
/* cyclic include with Data.h
template <class DT>
void DataTools::createSimpleQualityData(const PlainData<DT> & data, PlainData<DT> & qualityData, double dataQuality, double undetectQuality, double nodataQuality){
 
    qualityData.setEncoding(typeid(unsigned char));
    // createSimpleQualityData(data, qualityData.data, dataQuality, undetectQuality, nodataQuality);
    qualityData.odim.scaling.set(qualityData.data.getScaling());
 
    qualityyData.data.setPhysicalRange(0.0, 1.0, true);
 
    const drain::ValueScaling & scaling = qualityData.data.getScaling();
 
    const bool DATA     = !std::isnan(dataQuality);
    const bool UNDETECT = !std::isnan(undetectQuality);
    const bool NODATA   = !std::isnan(nodataQuality);
 
    // Default ie. unset values are non_signaling_NAN's, but maybe more elegant to skip calculations:
    const double dataCode     = DATA     ? scaling.inv(dataQuality)     : 0.0;
    const double undetectCode = UNDETECT ? scaling.inv(undetectQuality) : 0.0;
    const double nodataCode   = NODATA   ? scaling.inv(nodataQuality)   : 0.0;
 
    qualityData.data.setGeometry(data.getWidth(), data.getHeight());
 
    drain::image::Image::iterator  it = data.data.begin();
    drain::image::Image::iterator wit = qualityData.data.begin();
    while (it != data.end()){
        //if ((*it != odim.nodata) && (*it != odim.undetect))
        if (UNDETECT && (*it == data.odim.undetect))
            *wit = undetectCode;
        else if (NODATA && (*it == data.odim.nodata))
            *wit = nodataCode;
        else if (DATA)
            *wit = dataCode;
        ++it;
        ++wit;
    }
}
*/
 
template <class M>
void DataTools::getAttributes(const Hi5Tree &src, const Hi5Tree::path_t & p, M & attributes, bool updateOnly){
 
    drain::Logger mout(__FILE__, __FUNCTION__);
 
    /*
    if (p.hasRoot()){
        mout.debug("add root and restart with path= '" , p , "'  (revised code)" );
        Hi5Tree::path_t pRooted(p);
        pRooted.ensureRoot();
        DataTools::getAttributes(src, pRooted, attributes, updateOnly);
        return;
    }
    */
 
    if (p.empty() || !p.front().isRoot()){
        mout.debug("add root and restart with path= '" , p , "'  (revised code)" );
        //Hi5Tree::path_t pRooted(Hi5Tree::path_t(Hi5Tree::path_t::elem_t::ROOT), p);
        Hi5Tree::path_t pRooted;
        pRooted.appendElem(Hi5Tree::path_t::elem_t::ROOT);
        pRooted.append(p);
        // pRooted.push_front(Hi5Tree::path_t::elem_t::ROOT);
        DataTools::getAttributes(src, pRooted, attributes, updateOnly);
        return;
    }
 
 
    mout.debug("path= '" , p , "'" );
 
    Hi5Tree::path_t path;
    std::stringstream sstr;
 
    //for (Hi5Tree::path_t::const_iterator pit = p.begin(); pit != p.end(); ++pit){
    for (Hi5Tree::path_t::elem_t elem: p){
 
        path.appendElem(elem); // *pit;
 
        mout.debug("check='" , path , "'" );
 
        const Hi5Tree & s = src(path);
 
        //for (ODIMPathElemSeq::const_iterator git = EncodingODIM::attributeGroups.begin(); git != EncodingODIM::attributeGroups.end(); ++git){
        for (const ODIMPathElem & elem: EncodingODIM::attributeGroups){
 
            const hi5::NodeHi5 & group = s[elem].data;
 
            //for(drain::VariableMap::const_iterator ait = group.attributes.begin(); ait != group.attributes.end(); ait++){
            for(const auto & entry: group.attributes){
 
                sstr.str("");
                sstr << elem << ':' << entry.first;  // key
                //mout.debug(8) << "getAttributes: " << sstr.toStr() << '=' << it->second << mout.endl;
 
                //drain::SmartMapTools::setValue(attributes, sstr.str(), entry.second);
                drain::SmartMapTools::setValue(attributes, sstr.str(), entry.second, !updateOnly);
                /*
                if (updateOnly){
                    //drain::SmartMapTools::setValue<false>(attributes, sstr.str(), entry.second);
 
                    typename M::iterator it = attributes.find(sstr.str());
                                        if (it != attributes.end())
                                            it->second = entry.second;
                }
                else {
                    // drain::SmartMapTools::setValue<true>(attributes, sstr.str(), entry.second);
                    attributes[sstr.str()] = entry.second; // value
                }
                */
            }
        }
 
        // ++pit;
        //  if (pit == p.end())
        // return;
        //   path << *pit;
 
    }
 
}
 
 
 
/*
template <class M>
void DataTools::getAttributesOLD(const Hi5Tree &src, const std::string & path, M & attributes, bool updateOnly){
 
    drain::Logger mout("DataTools", __FUNCTION__);
 
    //drain::VariableMap::const_iterator it;
 
    int iStart = 0;
    if (!path.empty())
        if (path[0] == '/')
            iStart = 1;
 
    mout.debug(5) << "'" << path << "'" << mout.endl;
 
    std::stringstream sstr; // for speed
    std::string s;
    size_t i = 0;
    while(true){
 
        const std::string subpath = path.substr(iStart, i);  // with i=npos
        mout.debug(5) << "'" << subpath << "'\t" << i << mout.endl;
        //attributes[std::string("@")+subpath] = 0;
 
        const Hi5Tree & s = src(subpath);
 
        for (std::set<ODIMPathElem>::const_iterator git = EncodingODIM::attributeGroups.begin(); git != EncodingODIM::attributeGroups.end(); ++git){
            const hi5::NodeHi5 & group = s[*git].data;
            for(drain::VariableMap::const_iterator ait = group.attributes.begin(); ait != group.attributes.end(); ait++){
                sstr.str("");
                sstr << *git << ':' << ait->first;
                //mout.debug(8) << "getAttributes: " << sstr.toStr() << '=' << it->second << mout.endl;
                if (!updateOnly)
                    attributes[sstr.str()] = ait->second;
                else {
                    typename M::iterator it = attributes.find(sstr.str());
                    if (it != attributes.end())
                        it->second = ait->second;
                }
            }
        }
 
 
        if (i == std::string::npos){
            //if (drain::Debug > 4){ std::cerr << "attributes " << attributes << '\n';  }
            return;
        }
 
        i = path.find('/', i+1);
    }
    //while (i < path.size()); //(i != std::string::npos);
}
*/
 
 
} // rack::
 
#endif /* DATASELECTOR_H_ */
 
// Rack