DataCoder.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_DataCoder
#define RACK_DataCoder
 
 
//
//#include <drain/util/Rectangle.h>
#include <drain/image/AccumulationConverter.h>
#include "hi5/Hi5.h"
#include "data/ODIM.h"
#include "QuantityMap.h"
//#include "Coordinates.h"
 
 
namespace rack {
 
using namespace drain::image;
 
 
 
 
 
class DataCoder : public drain::BeanLike, public AccumulationConverter {
 
public:
 
    DataCoder() : BeanLike(__FUNCTION__), defaultQuality(0.5),
    dataODIM(defaultDataODIM), qualityODIM(defaultQualityODIM) {
        init();
    };
 
    DataCoder(const ODIM & dataODIM) : BeanLike(__FUNCTION__), defaultQuality(0.5),
            dataODIM(dataODIM), qualityODIM(defaultQualityODIM) {
        init();
        const QuantityMap & qm = getQuantityMap();
        qm.setQuantityDefaults(defaultQualityODIM, "QIND", "C");
    };
 
    DataCoder(const ODIM & dataODIM, const ODIM & qualityODIM) : BeanLike(__FUNCTION__), defaultQuality(0.5),
            dataODIM(dataODIM), qualityODIM(qualityODIM) {
        init();
    };
 
    DataCoder(const DataCoder & converter) : BeanLike(__FUNCTION__), defaultQuality(converter.defaultQuality),
            dataODIM(defaultDataODIM), qualityODIM(defaultQualityODIM) {
        defaultDataODIM    = converter.dataODIM;
        defaultQualityODIM = converter.qualityODIM;
        init();
    };
 
    virtual
    ~DataCoder(){};
 
 
    virtual
    bool isDataEncodingSet() const override {
        return dataODIM.isSet();
    }
 
    virtual
    bool isQualityEncodingSet() const override {
        return qualityODIM.isSet();
    }
 
 
    virtual
    double getNoReadingMarker() const override {
        return dataODIM.undetect;
    }
 
    virtual inline
    double getNoDataMarker() const override {
        return dataODIM.nodata;
    }
 
    virtual inline
    double getWeightNoDataMarker() const override {
        return qualityODIM.nodata;
    }
 
 
    virtual
    bool decode(double & value) const override;
 
    virtual
    bool decode(double & value, double & weight) const override;
 
 
    virtual
    void encode(double & value, double & weight) const override;
 
    virtual
    void encodeWeight(double & weight) const override;
 
    virtual
    void encodeDiff(double & diff) const override;
    /*
    virtual inline
    void encodeDiff(double & diff) const {
        diff = qualityODIM.scaleInverse(diff);
    };
    */
 
 
    void init();
 
    /*
    inline
    double setLimits(){
        dataODIM
    }
    double minValue;
    double maxValue;
    */
 
    double defaultQuality;
 
 
    double undetectValue;
 
    bool SKIP_UNDETECT;
 
    static double undetectQualityCoeff;
 
    const ODIM & dataODIM;
    const ODIM & qualityODIM;
 
    ODIM defaultDataODIM;
    ODIM defaultQualityODIM;
 
    /*
    virtual inline
    void toOStream(std::ostream & ostr) const {
        ostr << getName() << ':' << parameters.toStr() << '\n';
        //ostr << "DataConverter defaultQuality=" << defaultQuality << ", minDetectableValue=" << undetectValue << ", undetectQualityCoeff=" << undetectQualityCoeff << ", \n";
        ostr << "\t data: " << EncodingODIM(dataODIM) << '\n';
        ostr << "\t q:    " << EncodingODIM(qualityODIM) << '\n';
        //return ostr;
    }
    */
 
 
protected:
 
    double minCodeValue;
 
 
 
    double detectionThreshold;
 
};
 
 
inline
std::ostream & operator<<(std::ostream & ostr, const DataCoder & coder) {
    ostr << coder.getName() << ':' << coder.getParameters() << '\n';
    //ostr << "DataConverter defaultQuality=" << defaultQuality << ", minDetectableValue=" << undetectValue << ", undetectQualityCoeff=" << undetectQualityCoeff << ", \n";
    ostr << "\t data: " << EncodingODIM(coder.dataODIM) << '\n';
    ostr << "\t q:    " << EncodingODIM(coder.qualityODIM) << '\n';
    return ostr;
}
 
 
} // rack::
 
#endif
 
// Rack