BlenderOp.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 BLENDER_OP
#define BLENDER_OP "BlenderOp Markus.Peura@iki.fi"
 
#include "WindowOp.h"
 
#include "DistanceTransformOp.h"
#include "DistanceTransformFillOp.h"
#include "FastAverageOp.h"
#include "FlowAverageWindowOp.h"
#include "GaussianAverageOp.h"
#include "QualityMixerOp.h"
#include "QualityOverrideOp.h"
 
#include "drain/util/FunctorPack.h"
//#include "SlidingStripeAverageOp.h"
 
namespace drain
{
namespace image
{
 
 
 
class BlenderOp: public WindowOp<> {
 
public:
 
    // TODO Rename, and use blender only for the op that mixes filtered t unfiltered
    // TODO: re-consider the order of params?
    // BlenderOp(int width=5, int height=0, char spreader='a', char mixer='m', unsigned short loops=1) :  // , double coeff=0.5
    BlenderOp(int width=5, int height=0, const std::string & spreader="avg", const std::string & blender="max",
            unsigned short loops=1, double expansionCoeff=1.0) :  // , double coeff=0.5
        WindowOp<>(__FUNCTION__, "Smoothes image repeatedly, mixing original image with the result at each round.", width, height){
        parameters.link("spreader", this->spreader = spreader, getSmootherAliasMap<false>().toStr()); //"a|g|d|D; avg, gaussianAvg, dist, distExp");
        parameters.link("mix", this->blender = blender, "max|<coeff>: (quality) max, (quality) blend");
        parameters.link("loops", this->loops = loops, "number of repetitions");
        parameters.link("expansionCoeff", this->expansionCoeff = expansionCoeff, "window enlargement");
    };
 
    // Every Op should have a copy const
    BlenderOp(const BlenderOp & op) : WindowOp<>(op) {
        parameters.copyStruct(op.getParameters(), op, *this);
    };
 
 
 
    inline
    const std::string & getSmootherKey(){
        return spreader;
    }
 
    virtual inline
    void initializeParameters(const ImageFrame &src, const ImageFrame &dst) const {
        if (conf.frame.height == 0){
            conf.frame.height = conf.frame.width;
        }
    }
 
    void traverseChannels(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const;
 
 
    inline
    virtual void traverseChannel(const Channel &src, Channel & dst) const {
        traverseAsChannelTrays(src, dst);
    }
 
    inline
    void traverseChannel(const Channel &src, const Channel &srcWeight, Channel & dst, Channel & dstWeight) const {
        traverseAsChannelTrays(src, srcWeight, dst, dstWeight);
    }
 
protected:
 
    //mutable   drain::SmartMap<std::string> aliasMap;
 
    template <bool WEIGHTED=false>
    static
    const drain::SmartMap<std::string> & getSmootherAliasMap() {
        static drain::SmartMap<std::string> aliasMap;
        if (aliasMap.empty()){
            /*
            aliasMap["a"] = "average";
            aliasMap["f"] = "flowAverage"; // magnitude/energy saving
            aliasMap["g"] = "gaussianAverage";
            aliasMap["d"] = WEIGHTED ? "distanceTransformFill"    : "distanceTransform";
            aliasMap["D"] = WEIGHTED ? "distanceTransformFillExp" : "distanceTransformExp";
            */
            // NEW
            aliasMap["avg"] = "average";
            aliasMap["avgFlow"] = "flowAverage"; // magnitude/energy saving
            aliasMap["avgGauss"] = "gaussianAverage";
            aliasMap["dist"] = WEIGHTED ? "distanceTransformFill"    : "distanceTransform";
            aliasMap["distExp"] = WEIGHTED ? "distanceTransformFillExp" : "distanceTransformExp";
        }
        return aliasMap;
    }
 
    template <bool WEIGHTED=false>
    static
    const drain::SmartMap<std::string> & getMixerAliasMap(){
        static drain::SmartMap<std::string> aliasMap;
        //aliasMap["b"] = WEIGHTED ? "qualityMixer"    : "mix";
        //aliasMap["m"] = WEIGHTED ? "qualityOverride" : "max";
        // NEW
        aliasMap["blend"] = WEIGHTED ? "qualityMixer"    : "mix";
        aliasMap["max"]   = WEIGHTED ? "qualityOverride" : "max";
        return aliasMap;
    }
 
 
    // SMOOTHING
    std::string spreader;
 
    // MIXING
    std::string blender;
 
    // int width=5, int height=0, char spreader='a', char blender='m', unsigned short loops=1
    //void initRefs();
 
    //double coeff;
    unsigned short loops;
 
    double expansionCoeff;
 
    //ImageOp & getSmoother(const std::string & key, bool weighted, unsigned short & loops) const;
 
    //ImageOp & getMixer(const std::string & key, bool weighted) const;
    // double coeff;
 
 
};
 
 
 
 
} // namespace drain
 
} //namespace image
 
 
#endif
 
// Drain