ImageOp.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_IMAGE_OP_H_
#define DRAIN_IMAGE_OP_H_
 
#include "drain/util/BeanLike.h"
#include "drain/image/CoordinateHandler.h"
#include "ImageMod.h"
 
 
 
namespace drain {
 
namespace image {
 
 
class ImageOp : public ImageMod {
 
public:
 
 
    inline
    virtual ~ImageOp(){};
 
 
    //  const std::string & getName();
 
 
    virtual
    void process(const ImageFrame & src, Image & dst) const;
 
    virtual inline
    void process(Image & dst) const override final {
        process(dst, dst);
    }
 
 
    virtual
    void process(const ImageFrame & src, const ImageFrame & srcWeight, Image & dst, Image & dstWeight) const;
 
    /*
    virtual inline
    void process(const ImageTray<const Channel> & src, ImageTray<Image> & dst) const {
        processConditional(src, dst, true);
    }
    */
 
 
 
    virtual
    void process(const ImageTray<const Channel> & src, ImageTray<Image> & dst, bool checkOverlap = true) const;  // could be Tray<ModifiableChannel> ?
 
    // Note: only a default implementation.
    virtual inline
    void traverseChannels(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const {
        drain::Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL this->name+"(ImageOp::)[const ChannelTray &, ChannelTray &]", __FUNCTION__);
        mout.error() << "not implemented; consider processChannels[Equally|Repeated|Separately]" << mout.endl;
        // traverseChannelsEqually(src, dst);
        // traverseChannelsRepeated(src, dst);
        // traverseChannelsSeparately(src, dst);
        // traverseMultiChannel(src, dst);
    }
 
 
    virtual inline
    void traverseChannel(const Channel & src, Channel &dst) const {
        throw std::runtime_error(name+"(ImageOp)::"+__FUNCTION__+"(src,dst) unimplemented.");
    };
 
    virtual inline
    void traverseChannel(const Channel &src, const Channel &srcAlpha, Channel &dst, Channel &dstAlpha) const {
        //throw std::runtime_error(name+"(ImageOp)::"+__FUNCTION__+"(src,srcAlpha,dst,dstAlpha) unimplemented.");
        Logger mout(getImgLog(), __FILE__, __FUNCTION__);
        mout.note("using image channels only (discarding alpha channels)" );
        traverseChannel(src, dst);
    };
 
 
    virtual
    void getDstConf(const ImageConf & src, ImageConf & dst) const;
 
 
    /*  The old policy was to have this default implementation
     *  -# returns immediately, if dst==src.
     *  -# sets dst type, if unset, to that of src
     *  -# sets dst geometry to that of src
     */
    virtual // TODO: non-virtual, ie, final!
    void makeCompatible(const ImageConf & src, Image & dst) const;
 
    /*
     * This default implementation
     *  - returns immediately, if dst has overlap with src1 or src2.
     *  - else, calls makeCompatible(src1, dst); src2 has no effect.
     */
    virtual
    void makeCompatible2(const ImageFrame & src1, const ImageFrame & src2, Image & dst) const;
 
 
    virtual inline
    void help(std::ostream & ostr = std::cout) const {
        toStream(ostr);
    }
 
protected:
 
    inline  //  = std::string(__FUNCTION__).substr(0, ::strlen(__FUNCTION__)-2
    ImageOp(const std::string &name = __FUNCTION__, const std::string &description="")  : ImageMod(name, description){
    };
 
    inline
    ImageOp(const ImageOp & op)  : ImageMod(op.name, op.description){
    };
 
    virtual
    bool processOverlappingWithTemp(const ImageFrame & src, Image & dst) const;
 
    virtual
    bool processOverlappingWithTemp(const ImageTray<const Channel> & src, ImageTray<Image> & dst) const;
 
 
    // Final ?
    bool traverseOverlappingWithTemp(const Channel & src, Channel & dst) const;
 
    // Final ?
    bool traverseOverlappingWithTemp(const Channel & src, const Channel & srcWeight, Channel & dst, Channel & dstWeight) const;
 
 
    //  Final
    //bool processOverlappingWithTemp(const ImageFrame & srcFrame, Image & dstImage) const; // needed?
 
    //  Final
    //bool processOverlappingWithTemp(const ImageFrame & src, const ImageFrame & srcWeight, Image & dst, Image & dstWeight) const; // needed?
 
    //virtual   void traverse rame(const ImageFrame & src, ImageFrame & dst) const;
    // USE
 
 
    void traverseChannelsEqually(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const;
 
    void traverseChannelsRepeated(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const;
 
 
    void traverseChannelsSeparately(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const;
 
 
    inline
    void traverseAsChannelTrays(const ImageFrame &src, ImageFrame &dst) const {
        Logger mout(getImgLog(), __FILE__, __FUNCTION__);
        mout.debug("restoring to trays" );
 
        ImageTray<const Channel> s; //
        s.setChannels(src);
 
        ImageTray<Channel> d;
        d.setChannels(dst);
 
        traverseChannels(s, d);
    }
 
    inline
    void traverseAsChannelTrays(const ImageFrame &src, const ImageFrame & srcWeight, ImageFrame &dst, ImageFrame &dstWeight) const {
 
        Logger mout(getImgLog(), __FILE__, __FUNCTION__);
        mout.debug("restoring to trays" );
 
        ImageTray<const Channel> s;
        s.setChannels(src, srcWeight);
 
        ImageTray<Channel> d;
        d.setChannels(dst, dstWeight);
 
        traverseChannels(s, d);
    }
 
 
 
    static inline
    void adaptCoordinateHandler(const Channel & src, CoordinateHandler2D & handler){
        handler.set(src.getGeometry(), src.getCoordinatePolicy());
        // handler.setLimits(src.getWidth(), src.getHeight());
        // handler.setPolicy(src.getCoordinatePolicy());
    }
 
 
 
 
protected:
 
 
    virtual inline
    void initializeParameters(const ImageFrame &src, const ImageFrame &dst) const {
        drain::Logger mout(getImgLog(), __FILE__, __FUNCTION__); //  name+"(ImageOp) src,dst"
        mout.debug("nothing defined (ok)" );
    }
 
    inline virtual
    void initializeParameters(const ImageFrame &src, const ImageFrame &src2, const ImageFrame &dst) const {
        //drain::Logger mout(getImgLog(), __FILE__, __FUNCTION__); //REPL getImgLog(), name+"(ImageOp) src,src2,dst", __FUNCTION__);
        drain::Logger mout(getImgLog(), __FILE__, __FUNCTION__);
        mout.debug("nothing defined (ok)" );
    }
 
 
};
 
 
 
inline
std::ostream & operator<<(std::ostream & ostr, const ImageOp &op){
    //op.help(ostr); // todo: name & params only
    ostr << op.getName() << '(' << op.getParameters() << ')';
    return ostr;
}
 
}  // namespace image
 
}  // namespace drain
 
 
#endif /* IMAGE_OP_H_ */
 
// Drain