PixelVectorOp.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 PixelVectorOP_H_
#define PixelVectorOP_H_
 
#include <cmath>
 
#include "ImageOp.h"
//#include "drain/util/Functor.h"
//#include "drain/util/Fuzzy.h"
//#include "drain/util/Registry.h"
#include "drain/util/FunctorBank.h"
 
#include "drain/util/FunctorPack.h"
 
namespace drain
{
 
namespace image
{
 
 
 
 
class PixelVectorOp : public ImageOp
{
public:
 
    virtual
    void getDstConf(const ImageConf &srcConf, ImageConf & dstConf) const;
    //void makeCompatible(const ImageFrame &src, Image &dst) const;
 
    std::string functorDef;
    // std::string functorParams;
 
protected:
 
    PixelVectorOp(const std::string & name, const std::string & description) :
        ImageOp(name, description + " Post-scaling with desired functor."), rescale(0.0), POW(1.0), INVPOW(1.0) { //, l(1){ , rescale(0.0),
        // parameters.separator = ':';
        parameters.link("functor", this->functorDef);
        // parameters.link("params", this->functorParams);
    };
 
    double rescale;
    double POW;
    double INVPOW;
 
};
 
 
 
class GrayOp : public PixelVectorOp
{
 
public:
 
    std::string coefficients;
    bool normalize;
 
    // static char coeffSeparator = ':';
 
    GrayOp() : PixelVectorOp(__FUNCTION__, "Convert multi-channel image to single."){
        parameters.clear();
        parameters.link("coeff", coefficients="1.0", "c[:c2:c3:...]");
        parameters.link("normalize", normalize=true, "true|false");
        //parameters.separator = 0;
    };
 
    virtual
    void traverseChannels(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const;
 
 
 
    virtual inline
    void traverseChannel(const Channel & src, Channel &dst) const {
        drain::Logger mout(getImgLog(), __FILE__, __FUNCTION__);
        mout.warn("already a single-channel image?");
        dst.copyData(src);
        //throw std::runtime_error(name+"(ImageOp)::"+__FUNCTION__+"(src,dst) unimplemented.");
    };
 
 
};
 
 
 
template <class F>
class BinaryPixelVectorOp : public PixelVectorOp
{
 
public:
 
    BinaryPixelVectorOp(const std::string & name, const std::string & description) : PixelVectorOp(name, description){
    };
 
    virtual
    inline
    void process(const ImageFrame &src, Image &dst) const {
        Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"(PixelVectorOp)", __FUNCTION__);
        mout.debug("delegating: process(src, dst, dst)" );
        process(src, dst, dst);
    };
 
    //double getValue(double src) const {return 0.0;};
 
    virtual
    inline
    void process(const ImageFrame &src1, const ImageFrame &src2, Image &dst) const {
 
        Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"(PixelVectorOp)", __FUNCTION__);
 
        mout.debug("imitating: " );
        //process2WithTemp(src, dst);
 
        if (src2.hasOverlap(dst)){
            Image tmp;
            tmp.copyDeep(src2);
            makeCompatible(src1.getConf(), dst);
            traverseFrame(src1, tmp, dst);
            /*
            const ImageTray<const Channel> srcTray1(src1);
            const ImageTray<const Channel> srcTray2(tmp);
            ImageTray<Channel> dstTray(dst);
            traverseChannels(srcTray1, srcTray2, dstTray);
            */
        }
        else {
            makeCompatible(src1.getConf(), dst);
            /*
            const ImageTray<const Channel> srcTray1(src1);
            const ImageTray<const Channel> srcTray2(src2);
            ImageTray<Channel> dstTray(dst);
            traverseChannels(srcTray1, srcTray2, dstTray); */
            traverseFrame(src1, src2, dst); // lower
        }
    };
 
    virtual
    void traverseChannels(const ImageTray<const Channel> & srcTray, ImageTray<Channel> & dstTray) const {
        Logger mout(getImgLog(), __FILE__, __FUNCTION__);
        mout.unimplemented("traverseChannels for one srcTray only " );
    }
 
    virtual
    void traverseChannels(const ImageTray<const Channel> & src, const ImageTray<const Channel> & src2,
            ImageTray<Channel> & dst) const;
 
    void traverseFrame(const ImageFrame &src1, const ImageFrame &src2, ImageFrame &dst) const {
 
        Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"(PixelVectorOp)", __FUNCTION__);
        mout.debug("delegate to: traverseChannels(src, dst, dst)" );
 
        ImageTray<const Channel> src1Channels;
        src1Channels.setChannels(src1);
 
        ImageTray<const Channel> src2Channels;
        src2Channels.setChannels(src2);
 
        ImageTray<Channel> dstChannels;
        dstChannels.setChannels(dst);
 
        traverseChannels(src1Channels, src2Channels, dstChannels);
    }
 
    /*
    inline
    double getValue(double src, double src2) const {
        const BinaryFunctor & f = functor;
        return f(src, src2);
    }
    */
protected:
 
    F binaryFunctor;
 
};
 
template <class F>
void BinaryPixelVectorOp<F>::traverseChannels(const ImageTray<const Channel> & src1, const ImageTray<const Channel> & src2,
        ImageTray<Channel> & dst) const {
 
 
    Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"(PixelVectorOp)", __FUNCTION__);
 
    if (src1.empty())
        mout.error("src1 empty" );
 
    if (src2.empty())
        mout.error("src2 empty" );
 
    if (dst.empty())
        mout.error("dst empty" );
 
    Channel & dstChannel = dst.get();
 
    if (src1.getGeometry() != src2.getGeometry()){
        mout.warn("src1" , src1.getGeometry() );
        mout.warn("src2" , src2.getGeometry() );
        mout.note("dstChannel" , dstChannel );
        mout.error("src1 and src2 geometry error" );
        return;
    }
 
    const int width  = src1.getGeometry().getWidth(); //std::min(src1.getWidth(),src2.getWidth());
    const int height = src1.getGeometry().getHeight(); //std::min(src1.getHeight(),src2.getHeight());
    const size_t channels = src1.size(); // std::min(src1.getChannelCount(),src2.getChannelCount());
 
    double x=0.0, sum=0.0;
 
    mout.debug3(*this );
    //mout.debug3("src1: " , src1  );
    //mout.debug3("src2: " , src2 );
    //mout.debug3("dst:  " , dst  );
 
    FunctorBank & functorBank = getFunctorBank();
 
    std::string functorName;
    std::string functorParams;
 
    drain::StringTools::split2(functorDef, functorName, functorParams, "/");
 
 
    if (!functorBank.has(functorName)){
        //functorBank.help(std::cerr);
        mout.note(functorBank );
        mout.error("functor '" , functorName , "' not found: " , functorDef );
        return;
    }
 
    UnaryFunctor & scalingFunctor = functorBank.clone(functorName); // consider get? Or static from clone()
 
    //mout.debug(scalingFunctor.getName() , ':' , scalingFunctor.getDescription() );
    //scalingFunctor.setScale(dstChannel.scaling.getMax<double>(), 0.0);
    const std::type_info & t = dstChannel.getType();
    if (Type::call<drain::typeIsSmallInt>(t)){
        const double m = Type::call<typeMax, double>(t);
        scalingFunctor.setScale(m, 0.0); // TODO consider invScale, invOffset?
        mout.info("small int type, scaling with its maximum (" , m , ')' );
    }
 
    //scalingFunctor.setParameters(functorParams);
    try {
        scalingFunctor.setParameters(functorParams, '=', '/');
    } catch (const std::exception & e) {
        mout.info(scalingFunctor);
        mout.warn(scalingFunctor.getParameters());
        mout.error(e.what());
    }
 
    mout.debug2(scalingFunctor.getName() , ':' , scalingFunctor );
 
    const double coeff = (rescale>0.0) ? 1.0/rescale : 1.0/static_cast<double>(channels);
    const bool USE_POW    = (POW != 1.0);
    const bool USE_INVPOW = (INVPOW != 1.0);
    mout.debug3("coeff " , coeff );
    const BinaryFunctor & f = binaryFunctor;
    size_t a;
    for (int j = 0; j < height; j++) {
        for (int i = 0; i < width; i++) {
 
            sum = 0.0;
            a = dstChannel.address(i,j);
            for (size_t k = 0; k < channels; k++){
                // getValue( src1.get(k).get<double>(a) , src2.get(k).get<double>(a) );
                x = f(src1.get(k).get<double>(a) , src2.get(k).get<double>(a)) ;
                if (USE_POW)
                    sum += pow(x, POW);
                else
                    sum += x;
            }
            if (USE_INVPOW)
                dstChannel.put(a, scalingFunctor(pow(coeff*sum, INVPOW)));
            else
                dstChannel.put(a, scalingFunctor(coeff*sum));
        }
    }
 
}
 
 
 
class DistanceOp : public BinaryPixelVectorOp<SubtractionFunctor> {
 
public:
 
    DistanceOp() : BinaryPixelVectorOp<SubtractionFunctor>(__FUNCTION__, "Computes the distance of pixel vectors."){
        POW    = 2.0;
        INVPOW = 0.5;
        //functorDef="FuzzyStep/0:200";
    };
 
};
 
 
 
class ProductOp : public BinaryPixelVectorOp<MultiplicationFunctor>
{
public:
 
    ProductOp() : BinaryPixelVectorOp<MultiplicationFunctor>(__FUNCTION__, "Computes the dot product of pixel vectors."){
        POW    = 1.0;
        INVPOW = 0.5;
        //functorDef="FuzzyStep/0:200";
    };
 
};
 
 
class MagnitudeOp : public BinaryPixelVectorOp<MultiplicationFunctor> {
 
public:
 
    //MagnitudeOp(const std::string & mapping = "linear", double l=2.0) : PixelVectorOp(__FUNCTION__,"Computes the magnitude of a pixel vector."){
    MagnitudeOp() : BinaryPixelVectorOp<MultiplicationFunctor>(__FUNCTION__, "Computes the magnitude of a pixel vector."){
        POW = 1.0; // because x*x natively
        INVPOW = 0.5;
        //functorDef="FuzzyStep/0:200";
    };
 
    virtual
    inline
    void process(const ImageFrame &src, Image &dst) const {
        Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"(PixelVectorOp)", __FUNCTION__);
        mout.debug("delegating to: process(src, src, dst)" );
        BinaryPixelVectorOp<MultiplicationFunctor>::process(src, src, dst);
    };
 
    virtual
    inline
    void traverseFrame(const ImageFrame &src, ImageFrame & dst) const {
        Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"::PixelVectorOp[src, dst]", __FUNCTION__);
        mout.warn("delegating to: traverseFrame(src, src, dst)" );
        BinaryPixelVectorOp<MultiplicationFunctor>::traverseFrame(src, src, dst);
    }
 
    virtual
    inline
    void traverseChannels(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const {
        Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"::PixelVectorOp[src,dst]", __FUNCTION__);
        mout.debug("delegate to: traverseChannels(src, SRC, dst)" );
        BinaryPixelVectorOp<MultiplicationFunctor>::traverseChannels(src, src, dst);
    }
 
};
 
 
}
}
 
 
#endif /*PixelVectorOP_H_*/
 
// Drain