AccumulationMethods.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 ACCUMULATION_H_
#define ACCUMULATION_H_
 
#include <limits>
#include <math.h>
 
#include <stdexcept>
 
#include <drain/util/Bank.h>
#include <drain/util/BeanLike.h>
#include <drain/util/Point.h>
#include <drain/util/Rectangle.h>
 
#include "ImageT.h"
#include "CoordinatePolicy.h"
#include "AccumulationArray.h"
#include "AccumulationConverter.h"
 
namespace drain
{
 
namespace image
{
 
 
 
class AccumulationMethod : public BeanLike {
public:
 
    inline
    AccumulationMethod() :  BeanLike("UNDEFINED", "Undefined method")  {
    };
 
    inline
    AccumulationMethod(const AccumulationMethod &method) : BeanLike(method.getName(), method.getDescription()){
    };
 
    virtual
    ~AccumulationMethod(){};
 
 
 
 
 
    virtual inline
    void add(AccumulationArray & accArray, const size_t i, double value, double weight) const {
        throw std::runtime_error("AccumulationMethod::add - method/rule UNDEFINED");
    };
 
 
    virtual inline
    void add(AccumulationArray & accArray, const size_t i, double value, double weight, unsigned int count) const {
        add(accArray, i, value, weight);
    };
 
 
 
 
    virtual
    void extractValue(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const;
 
 
 
    virtual
    void extractWeight(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const;
 
 
    virtual
    void extractCount(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const;
 
 
    virtual
    void extractDev(const AccumulationArray & accArray,  const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const;
 
 
protected:
 
 
    AccumulationMethod(const std::string & name, const std::string & description) :  BeanLike(name, description) {
    };
 
 
};
 
 
 
 
class OverwriteMethod : public AccumulationMethod {
 
public:
 
    //OverwriteMethod(AccumulationArray & c) : AccumulationMethod("LATEST", c) {};
    OverwriteMethod() : AccumulationMethod("OVERRIDE", "Latest data overrides") {};
 
    virtual
    void add(AccumulationArray & accArray, const size_t i, double value, double weight) const override;
 
    virtual
    void extractDev(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
 
};
 
class MaximumMethod : public AccumulationMethod {
 
public:
 
    //MaximumMethod(AccumulationArray & c) : AccumulationMethod("MAXIMUM", c) {};
    inline
    MaximumMethod() : AccumulationMethod("MAXIMUM", "Maximum of values") {};
 
    virtual
    void add(AccumulationArray & accArray, const size_t i, double value, double weight) const override;
 
};
 
class MinimumMethod : public AccumulationMethod {
 
public:
 
    //MinimumMethod(AccumulationArray & c) : AccumulationMethod("MINIMUM", c) {};
    inline
    MinimumMethod() : AccumulationMethod("MINIMUM", "Minimum of values") {};
 
    virtual
    void add(AccumulationArray & accArray, const size_t i, double value, double weight) const override;
 
};
 
 
class MinMaxMethod : public AccumulationMethod {
 
public:
 
    inline
    MinMaxMethod() : AccumulationMethod("MINMAX", "Minimum or maximum with larger absolute value") {};
 
    virtual
    void add(AccumulationArray & accArray, const size_t i, double value, double weight) const override;
 
    virtual
    void extractValue(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
    virtual
    void extractDev(const AccumulationArray & accArray,  const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
};
 
 
class AverageMethod : public AccumulationMethod {
 
public:
 
    //AverageMethod(AccumulationArray & c) : AccumulationMethod("AVERAGE", c) {};
    inline
    AverageMethod() : AccumulationMethod("AVERAGE", "Average of values") {};
 
    virtual
    void add(AccumulationArray & accArray,  const size_t i, double value, double weight) const override;
 
    virtual // inline
    void add(AccumulationArray & accArray,  const size_t i, double value, double weight, unsigned int count) const override;
 
    virtual
    void extractValue(const AccumulationArray & accArray,  const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
    virtual
    void extractWeight(const AccumulationArray & accArray,  const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
    virtual
    void extractDev(const AccumulationArray & accArray,  const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
};
 
 
 
class WeightedAverageMethod : public AccumulationMethod {
 
 
public:
 
    inline
    WeightedAverageMethod() : AccumulationMethod("WAVG", "Weighted average of data and quality values"), pInv(1.0), USE_P(false), rInv(1.0), USE_R(false) {
        parameters.link("p", p = 1.0, "exponent for data value");
        parameters.link("r", r = 1.0, "exponent for weight");
        parameters.link("bias", bias = 0.0, "origin, for non-negative value exponent");
        updateBean();
    };
 
    inline
    WeightedAverageMethod(const WeightedAverageMethod & method) : AccumulationMethod(method), pInv(1.0), USE_P(false), rInv(1.0), USE_R(false) {
        parameters.copyStruct(method.parameters, method, *this); // Does this copy descriptions?
        updateBean();
    };
 
 
    virtual
    void updateBean() const override;
 
    virtual
    void add(AccumulationArray & accArray,  const size_t i, double value, double weight) const override;
 
    virtual inline
    void add(AccumulationArray & accArray,  const size_t i, double value, double weight, unsigned int count) const override;
 
    virtual
    void extractValue(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
    virtual
    void extractWeight(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
    virtual
    void extractDev(const AccumulationArray & accArray, const AccumulationConverter & coder, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const override;
 
    /*
    virtual
    std::ostream & toStream(std::ostream & ostr) const {
        //ostr << name << '(' << p << ',' << r << ',' << dataScaling << ')';
        ostr << name << '(' << p << ',' << r << ',' << bias << ')';
        return ostr;
    };
    */
 
protected:
 
    double bias = 0.0;
 
    double p = 1.0;
    mutable double pInv = 1.0;
    mutable bool USE_P = false;
 
    double r = 1.0;
    mutable double rInv = 1.0;
    mutable bool USE_R = false;
 
};
 
 
class MaximumWeightMethod : public AccumulationMethod {
 
public:
 
    //MaximumWeightMethod(AccumulationArray & c) : AccumulationMethod("MAXW", c) {};
    inline
    MaximumWeightMethod() : AccumulationMethod("MAXW", "Maximum-weight (maximum-quality)") {};
 
    virtual
    void add(AccumulationArray & accArray, const size_t i, double value, double weight) const ;
 
};
 
 
typedef drain::Bank<AccumulationMethod> AccMethodBank;
 
extern
AccMethodBank & getAccMethodBank();
 
 
}
 
}
 
#endif /* Cumulator_H_ */
 
// Drain