Accumulator.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_ACCUMULATOR_H_
#define DRAIN_ACCUMULATOR_H_
 
#include <drain/image/CoordinatePolicy.h>
#include <limits>
#include <math.h>
 
#include <stdexcept>
 
#include "drain/util/Point.h"
#include "drain/util/Rectangle.h"
 
#include "ImageT.h"
#include "AccumulationArray.h"
#include "AccumulationMethods.h"
#include "AccumulationConverter.h"
 
 
 
// TODO: image/
namespace drain
{
 
namespace image
{
 
 
 
 
// New
//class Accumulator : public AccumulationArray {
class Accumulator  {
public:
 
    enum FieldType {
        DATA      = 'd',          // Main data, of named quantity
        QUALITY   = 256,          // Marker for non-data (why not 128?)
        QUANTITY_SPECIFIC = 32,   // Bit marking upper-case chars, see below
        // Quality fields can be GLOBAL or QUANTITY_SPECIFIC
        WEIGHT_GLOBAL = 'W'|QUALITY,  // Quality
        COUNT_GLOBAL  = 'C'|QUALITY,  // Number of samples
        WEIGHT        = 'w'|QUALITY,  // Quality
        COUNT         = 'c'|QUALITY,  // Number of samples
        DEVIATION     = 's'|QUALITY   // Separation: std.dev or difference
        // DEVIATION = 's'|QUALITY,   // Separation: std.dev or difference
    };
 
    typedef drain::Enum<FieldType>::dict_t dict_t;
 
    //static
    // const dict_t dict;
 
    typedef std::list<FieldType> FieldList;
 
    // Deprecating?
    inline static
    char getFieldChar(FieldType field){
        return static_cast<char>(field & 127);
    }
 
    static
    FieldType getField(char field);
 
    inline static
    bool isQuality(FieldType field){
        return (field & QUALITY) != 0;
    }
 
    inline static
    bool isSpecific(FieldType field){
        return ((int)field & (int)QUANTITY_SPECIFIC) != 0;
    }
 
    static
    void getFields(const std::string & fieldStr, FieldList & fieldList);
 
    static
    void createFieldList(const std::string & fieldChars, FieldList & fieldList);
 
 
    AccumulationArray accArray;
 
    inline
    Accumulator() : methodPtr(&undefinedMethod) {
 
        /*
        addMethod(overwriteMethod);
        addMethod(maximumMethod);
        addMethod(minimumMethod);
        addMethod(averageMethod);
        addMethod(weightedAverageMethod);
        addMethod(maximumWeightMethod);
        */
        // setMethod(_overwriteMethod);
 
    };
 
    inline
    Accumulator(const Accumulator & acc) : methodPtr(&undefinedMethod) {
        setMethod(acc.getMethod()); // if unset, sets unset... ie. default method.
        accArray.setGeometry(acc.accArray.getGeometry());
    }
 
 
    virtual inline
    ~Accumulator(){};
 
    void setMethod(const std::string & method);
 
    void setMethod(const std::string & name, const std::string & params);
 
 
    inline
    void setMethod(const AccumulationMethod & method){
        setMethod(method.getName(), method.getParameters().getValues());
    }
 
    inline
    bool isMethodSet() const {
        return (methodPtr != & undefinedMethod);
    }
 
    inline
    const AccumulationMethod & getMethod() const {
        return *methodPtr;
    }
 
    inline
    AccumulationMethod & getMethod() {
        return *methodPtr;
    }
 
    /*
    void addMethod(AccumulationMethod & method){
        // std::cerr << "addMethod:" << method.name << '\t' << method << '\n';
        methods.insert(std::pair<std::string, AccumulationMethod &>(method.getName(), method));
    }
    */
 
    inline
    void add(const size_t i, double value, double weight) {
        methodPtr->add(accArray, i, value, weight);
    }
 
    inline
    void add(const size_t i, double value, double weight, unsigned int count) {
        methodPtr->add(accArray, i, value, weight, count);
    }
 
 
 
 
    void addData(const Image & src, const AccumulationConverter & converter, double weight = 1.0, int iOffset=0, int jOffset=0);
 
 
    void addData(const Image & src, const Image & srcQuality, const AccumulationConverter & converter, double weight = 1.0, int iOffset=0, int jOffset=0);
 
 
 
    void addData(const Image & src, const Image & srcQuality, const Image & srcCount, const AccumulationConverter & converter);
    // Could be easily added: ... double weight = 1.0, int iOffset=0, int jOffset=0
 
 
    inline
    void extractField(char field, const AccumulationConverter & converter, Image & dst, const drain::Rectangle<int> & crop) const {
            extractField(getField(field), converter, dst, crop);
    }
 
    void extractField(FieldType field, const AccumulationConverter & converter, Image & dst, const drain::Rectangle<int> & crop = {0,0,0,0}) const;
 
    virtual
    std::ostream & toStream(std::ostream & ostr) const;
 
public:
 
    //  std::map<std::string, AccumulationMethod &> methods;
 
protected:
 
    AccumulationMethod undefinedMethod;
 
    /*
    AccumulationMethod undefinedMethod;
    OverwriteMethod overwriteMethod;
    MaximumMethod   maximumMethod;
    MinimumMethod minimumMethod;
    AverageMethod   averageMethod;
    WeightedAverageMethod weightedAverageMethod;
    MaximumWeightMethod maximumWeightMethod;
    */
 
    AccumulationMethod * methodPtr;
 
    // Initialize destination image to match the accumulation array - cropped if requested.
    /*
     * \param dst – destination image to be cropped if cropArea supplied
     * \param cropArea – sub-area of the accumulation array; empty if no cropping requested.
     *
     * If cropArea geometry equals that of the accumulation array, it will be cleared and discarded in processing.
     *
     */
    void initDst(const AccumulationConverter & coder, Image & dst, drain::Rectangle<int> & cropArea) const;
 
 
};
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const Accumulator & accumulator){
    return accumulator.Accumulator::toStream(ostr);
}
 
DRAIN_ENUM_DICT(Accumulator::FieldType);
DRAIN_ENUM_OSTREAM(Accumulator::FieldType)
 
}  // image::
 
}  // drain::
 
 
#endif // Accumulator