ImageCodebook.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 DRAIN_CODEBOOK
#define DRAIN_CODEBOOK
 
 
#include <drain/Log.h>
#include <ostream>
#include <vector>
#include <map>
 
#include "drain/util/ValueScaling.h"
#include "drain/util/LookUp.h"
 
namespace drain
{
 
 
template <class T>
class ImageCodeMap : public std::map<double,T> { // : public std::vector<T> {
 
public:
 
    typedef std::map<double,T> cont_t;
    typedef typename cont_t::key_type     key_t;
    typedef typename cont_t::value_type entry_t;
 
    typedef drain::LookUp<typename cont_t::const_iterator> lookup_t;
 
    // Utility for initializer_list based inits: the threshold values are read in parallel.
    typedef typename std::list<entry_t> list_t;
 
 
    //ImageCodeMap(size_t n=0, const T & value=T()): cont_t(n, value), separator(0) {
    ImageCodeMap() : separator(0) {
    };
 
 
    ImageCodeMap(std::initializer_list<entry_t> l) : cont_t(l), separator(0) {
    };
 
 
    // ImageCodeMap(const cont_t & v): cont_t(v), separator(0) {
    ImageCodeMap(const cont_t & map): separator(0) { // COPY?
    };
 
 
 
    mutable
    lookup_t lookUp;
 
 
    lookup_t & createLookUp(const std::type_info & type, const ValueScaling & scaling) const;
    // inline
    typename cont_t::const_iterator retrieve(double d) const {
 
        typename cont_t::const_iterator it = this->begin();
        typename cont_t::const_iterator rit = it; // result
 
        while (it != this->end()){
            if (it->first > d)
                return rit;
            rit = it;
            ++it;
        }
 
        return rit; // may be invalid
 
    }
 
    // inline
    typename cont_t::iterator retrieve(double d) {
 
        typename cont_t::iterator  it = this->begin();
        typename cont_t::iterator rit = it;
 
        while (it != this->end()){
            if (it->first > d)
                return rit;
            rit = it;
            ++it;
        }
 
        return rit; // may be invalid
 
    }
 
 
 
 
    /*
     *    \param equal - typically =, :, or -
     *    \param start - typically hyphen or leading parenthesis (, {, [
     *    \param end   - typically hyphen or trailing parenthesis ), }, [
     *    \param separator - typically comma or semicolon
     */
 
    // ValueScaling scaling; more like property of image
 
    char separator;
};
 
/*
class ImageCodeEntry {
public:
 
    virtual inline
    ~ImageCodeEntry(){};
 
    virtual
    bool empty() const = 0;
};
*/
 
template <class T>
typename ImageCodeMap<T>::lookup_t & ImageCodeMap<T>::createLookUp(const std::type_info & type, const ValueScaling & scaling) const { // todo N?
 
        drain::Logger mout(__FILE__, __FUNCTION__);
 
        //mout.warn("first entry: " , sprinter(*pal.begin()) );
        //mout.warn("last  entry: " , sprinter(*pal.rbegin()) );
 
        lookUp.byteSize = drain::Type::call<drain::sizeGetter>(type);
 
        // Todo: add support for signed short and signed char ?
        if (type == typeid(unsigned short)){ // 1024 entries (not 65536)
            if ((scaling.scale == 1.0) && (scaling.offset == 0.0)){
                double first = this->begin()->first;
                double  last = this->rbegin()->first;
                if ((first >= 0.0) && (last <= 255.0)){
                    lookUp.bitShift = 0;
                    mout.note("short int, but not using 16 bits, coping with 256 entries" );
                }
                else
                    lookUp.bitShift = 6;
            }
            else
 
                lookUp.bitShift = 6; // note => 16 - 6 = 10 bits => 1024 entries
        }
        else if (type == typeid(unsigned char)){
            lookUp.bitShift = 0;
        }
        else {
            mout.note("not supported for type " , drain::Type::getTypeChar(type) );
            lookUp.byteSize = 0;
            lookUp.bitShift = 0;
            lookUp.clear();
            return lookUp;
        }
 
        const int n = (1 << (lookUp.byteSize*8 - lookUp.bitShift));
        mout.debug("type=" , drain::Type::getTypeChar(type) , ", creating " , n , " lookup entries" );
 
        typename cont_t::const_iterator itLower = this->begin();
 
        lookUp.resize(n, itLower);
 
        // Signed, because scaling physical values may cause underflow
        int index, indexLower=0;
 
        for (typename cont_t::const_iterator it=this->begin(); it!=this->end(); ++it){
        //for (const auto & entry: *this){
 
            index = static_cast<int>(scaling.inv(it->first));
 
            if (index < 0){
                mout.warn("underflow threshold " , it->first , " mapped to negative index " , index , " (before bitShift), skipping " );
                continue;
            }
 
            index = (index >> lookUp.bitShift);
 
            if (index >= n){
                mout.warn("overflow: threshold ", it->first, " mapped to index (", index, ") > max (", (n-1), "), skipping " );
                continue;
            }
 
            if (indexLower < index){
                mout.debug("adding index range [", indexLower, '-', index, "[ -> (", itLower->first, ") => {", itLower->second, '}');
            }
            else {
                mout.note("accuracy loss: skipped entry [" , index , "] => ", it->first );
            }
 
            for (int i=indexLower; i<index; ++i){
                lookUp[i] = itLower;
            }
 
            indexLower = index;
            itLower    = it;
 
        }
 
        index = n;
        if (indexLower < index){
            mout.debug() << "padding [" << indexLower << '-' << index << "[ -> \t";
            mout << '[' << itLower->first << "] // " << itLower->second << mout.endl;
        }
        for (int i=indexLower; i<index; ++i){
            lookUp[i] = itLower;
        }
 
        return lookUp;
    }
 
 
} // drain::
 
#endif