FunctorPack.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 FUNCTOR_PACK_H_
#define FUNCTOR_PACK_H_
 
#include <cmath>
 
#include "Functor.h"
 
 
namespace drain
{
 
 
 
 
 
// Inversely: f = (f'-offset)/scale = a*f+b, where a=1/scale and b=-offset/scale.
class ScalingFunctor : public UnaryFunctor {
 
public:
 
    ScalingFunctor(double scale = 1.0, double bias = 0.0) : UnaryFunctor(__FUNCTION__, "Rescales values linerarly: y = scale*x + bias", scale, bias){
        this->getParameters().link("scale", this->scale);
        this->getParameters().link("bias", this->bias);
        this->setScale(scale, bias);
    };
 
    ScalingFunctor(const ScalingFunctor & ftor) : UnaryFunctor(ftor) {
        this->parameters.copyStruct(ftor.getParameters(), ftor, *this);
        updateBean();
    }
 
    //virtual
    inline
    double operator()(double s) const {
        return this->scaleFinal*s + this->biasFinal;
    };
 
protected:
 
    ScalingFunctor(const std::string & name, const std::string & description, double scale = 1.0, double bias = 0.0) :
        UnaryFunctor(name, description, scale, bias){
        this->setScale(scale, bias);
    };
 
};
 
 
 
 
class NegateFunctor : public ScalingFunctor {
 
public:
 
    NegateFunctor() : ScalingFunctor(__FUNCTION__, "Inverts values.", -1.0, 1.0) {
        //updateScale(); // needed?
    }
 
 
 
};
 
 
class RemappingFunctor : public UnaryFunctor {
 
public:
 
    RemappingFunctor(double fromValue = 0.0, double toValue = 0.0) : UnaryFunctor(__FUNCTION__, "Rescales intensities linerarly") , fromValue(fromValue), toValue(toValue) {
        this->getParameters().link("fromValue", this->fromValue = fromValue);
        this->getParameters().link("toValue", this->toValue = toValue);
    };
 
    RemappingFunctor(const RemappingFunctor & ftor) : UnaryFunctor(ftor){
        parameters.copyStruct(ftor.parameters, ftor, *this);
    }
 
 
    inline
    double operator()(double s) const {
        // this->scale*s + this->bias;
        if (s == fromValue)
            return toValue;
        else
            return s;
    };
 
    double fromValue = 0.0;
    double toValue   = 0.0;
 
};
 
 
 
class ThresholdFunctor : public UnaryFunctor {
 
public:
 
    ThresholdFunctor(double threshold = 0.5, double replace = 0.0) : UnaryFunctor(__FUNCTION__, "Resets values lower than a threshold") , threshold(threshold), replace(replace) {
        this->getParameters().link("threshold", this->threshold = threshold);
        this->getParameters().link("replace", this->replace = replace);
    };
 
    ThresholdFunctor(const ThresholdFunctor & ftor) : UnaryFunctor(ftor){
        parameters.copyStruct(ftor.parameters, ftor, *this);
    }
 
 
    virtual inline
    double operator()(double s) const override {
        if (s < threshold)
            return replace;
        else
            return s;
    };
 
    double threshold = 0.5;
    double replace   = 0.0;
 
};
 
 
class BinaryThresholdFunctor : public UnaryFunctor { // : public ThresholdFunctor {
 
public:
 
    BinaryThresholdFunctor(double threshold = 0.5, double replaceLow = 0.0, double replaceHigh = 1.0) : UnaryFunctor(__FUNCTION__, "Resets values lower and higher than a threshold")  {
        this->getParameters().link("threshold", this->threshold.tuple(threshold,threshold), "min[:max]").fillArray = true;
        this->getParameters().link("replace",   this->replace.tuple(replaceLow, replaceHigh), "min[:max]");
    };
 
    BinaryThresholdFunctor(const BinaryThresholdFunctor & ftor) : UnaryFunctor(ftor){
        parameters.copyStruct(ftor.parameters, ftor, *this);
    }
 
    virtual inline
    double operator()(double s) const override {
        if (s < threshold.min)
            return replace.min;
        else if (s > threshold.max)
            return replace.max;
        else
            return s;
    };
 
    Range<double> threshold  = {0.5, 0.5};
    Range<double> replace    = {0.0, 1.0};
 
};
 
 
 
 
class GammaFunctor : public drain::UnaryFunctor
{
 
public:
 
    GammaFunctor(double gamma = 1.0) : UnaryFunctor(__FUNCTION__, "Gamma correction for brightness."){
        this->getParameters().link("gamma", this->gamma = gamma, "0.0...");
    };
 
    GammaFunctor(const GammaFunctor & ftor) : UnaryFunctor(ftor){
        this->getParameters().link("gamma", this->gamma = ftor.gamma, "0.0..");
        //this->getParameters().copyStruct(ftor.getParameters(), ftor, *this);
    };
 
    //virtual
    inline
    double operator()(double s) const {
        return this->scale * pow(s, 1.0/gamma);
    };
 
    double gamma = 1.0;
 
};
 
 
 
class AdditionFunctor : public BinaryFunctor {
 
public:
 
    AdditionFunctor(double scale = 1.0, double bias = 0.0) : BinaryFunctor(__FUNCTION__, "Adds values", scale, bias){
        this->getParameters().link("scale", this->scale);
        this->getParameters().link("bias", this->bias);
    };
 
    inline
    double operator()(double s1, double s2) const {
        return this->scaleFinal*(s1 + s2) + this->biasFinal;
    };
};
 
 
 
class SubtractionFunctor : public BinaryFunctor {
 
public:
 
    SubtractionFunctor(double scale = 1.0, double bias = 0.0) : BinaryFunctor(__FUNCTION__, "Subtracts values", scale, bias){  // , bool LIMIT=false
        this->getParameters().link("scale", this->scale);
        this->getParameters().link("bias", this->bias);
    };
 
    inline
    double operator()(double s1, double s2) const {
        return this->scaleFinal*(s1 - s2) + this->biasFinal;
    };
};
 
 
 
 
class MultiplicationFunctor : public BinaryFunctor {
 
public:
 
    MultiplicationFunctor(double scale = 1.0, double bias = 0.0) : BinaryFunctor(__FUNCTION__, "Rescales intensities linerarly", scale, bias){
        this->getParameters().link("scale", this->scale);
        this->getParameters().link("bias", this->bias);
        // updateBean();
    };
 
    inline
    double operator()(double s1, double s2) const {
        return this->scaleFinal*(s1*s2) + this->biasFinal;
    };
};
 
 
class DivisionFunctor : public BinaryFunctor {
 
public:
 
    DivisionFunctor(double scale = 1.0, double bias = 0.0) : BinaryFunctor(__FUNCTION__, "Rescales intensities linerarly", scale, bias){
        this->getParameters().link("scale", this->scale);
        this->getParameters().link("bias", this->bias);
        //updateBean();
    };
 
    inline
    double operator()(double s1, double s2) const {
        if (s2 != 0.0)
            return this->scale*(s1/s2) + this->bias;
        else
            return NAN;
    };
};
 
 
 
class MixerFunctor : public BinaryFunctor {
 
public:
 
    MixerFunctor(double coeff=0.5, double scale=1.0, double bias=0.0) : BinaryFunctor(__FUNCTION__, "Rescales intensities linerarly", scale, bias), coeff(coeff), scaleFinal2(1.0){
        this->getParameters().link("coeff", this->coeff);
        this->getParameters().link("scale", this->scale);
        this->getParameters().link("bias", this->bias);
        updateBean();
        //updateScale();
    };
 
    MixerFunctor(const MixerFunctor & ftor) : BinaryFunctor(ftor){
        parameters.copyStruct(ftor.parameters, ftor, *this);  // ~coeff
        //std::cerr << "copy const" << __FUNCTION__ << std::endl;
    }
 
 
    inline
    double operator()(double s1, double s2) const {
        return this->scaleFinal*s1 + this->scaleFinal2*s2 + this->biasFinal;
    };
 
    inline
    virtual
    void updateScale() const {
        this->scaleFinal  = this->scale*this->coeff;
        this->scaleFinal2 = this->scale*(1.0-this->coeff);
        this->biasFinal   = this->bias;
    }
 
    double coeff = 1.0;
 
protected:
 
    mutable
    double scaleFinal2 = 1.0;
 
};
 
 
 
 
 
class MaximumFunctor : public BinaryFunctor {
 
public:
 
    MaximumFunctor(double scale = 1.0, double bias = 0.0) : BinaryFunctor(__FUNCTION__, "Maximum of two values.", scale, bias){
        updateBean();
    };
 
    inline
    double operator()(double s1, double s2) const {
        return this->scale * std::max(static_cast<double>(s1), static_cast<double>(s2)) + this->bias;
    };
};
 
 
 
 
class MinimumFunctor : public BinaryFunctor {
 
public:
 
    MinimumFunctor(double scale = 1.0, double bias = 0.0) : BinaryFunctor(__FUNCTION__, "Minimum of two values.", scale, bias){
        updateBean();
    };
 
    inline
    double operator()(double s1, double s2) const {
        return this->scale * std::min(static_cast<double>(s1), static_cast<double>(s2)) + this->bias;
    };
};
 
 
 
 
}
 
#endif /*  MATH_OP_PACK */
 
// Drain