PaletteOp.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_PALETTEOP_H
#define DRAIN_PALETTEOP_H
 
#include <map>
#include "drain/util/Bank.h"
#include "drain/image/Palette.h"
 
#include "ImageOp.h"
#include "CopyOp.h"
 
 
 
namespace drain
{
 
namespace image
{
 
 
class PaletteOp : public ImageOp
{
public:
 
    PaletteOp() : ImageOp(__FUNCTION__,"Applies colour palette to an image"), palettePtr(&myPalette) {
        this->parameters.link("scale", scale = 1.0);
        this->parameters.link("offset", offset = 0.0);
        specialCodes.title = "Special codes";
    };
 
    PaletteOp(const Palette & palette) : ImageOp(__FUNCTION__,"Applies colour palette to an image"), palettePtr(&myPalette) {
        this->parameters.link("scale", scale = 1.0);
        this->parameters.link("offset", offset = 0.0);
        specialCodes.title = "Special codes";
        setPalette(palette);
    };
 
 
    PaletteOp(const std::string & filename = "") : ImageOp(__FUNCTION__,"Applies colour palette to an image"), palettePtr(&myPalette) {
            this->parameters.link("scale", scale = 1.0);
            this->parameters.link("offset", offset = 0.0);
            specialCodes.title = "Special codes";
            myPalette.load(filename);
        };
 
    virtual ~PaletteOp(){};
 
 
    //void processOLD(const ImageFrame &src,Image &dst) const ;
 
    void traverseChannels(const ImageTray<const Channel> & src, ImageTray<Channel> & dst) const;
 
    virtual
    void help(std::ostream & ostr = std::cout) const;
 
 
    //void setPalette(const ImageFrame &palette) const; //,unsigned int maxColors = 256);
    void setPalette(const Palette &palette); //,unsigned int maxColors = 256);
 
    inline
    const Palette & getPalette() const {
        return *palettePtr;
    }
 
 
    static
    Palette & getPalette(const std::string & key);
 
    static
    Palette & loadPalette(const std::string & key);
 
    // static
    // Palette & getGrayPalette(const std::string & key);
 
    // TODO: Refinement. Or better in actual op exec, with lookup? Or: retrieve a lookup...
    // const Palette & getPalette(const std::string & key) const;
 
 
    // TODO T 256, T2 32768
    // void setGrayPalette(unsigned int iChannels=3, unsigned int aChannels=0, float brightness=0.0,float contrast=1.0) const;
 
 
    double scale;
 
    double offset;
 
 
    void registerSpecialCode(const std::string & code, double d);
 
    // protect:
    Palette specialCodes;
 
    /*
    static inline
    std::map<std::string,drain::image::Palette> & getPaletteMap(){
        return paletteMap;
    };
    */
    //typedef   std::map<std::string,drain::image::Palette> palette_map_t;
    typedef PaletteMap palette_map_t;
 
    static
    palette_map_t & getPaletteMap();
    /*
    static
    std::map<std::string,drain::image::Palette> paletteMap;
    */
protected:
 
 
    //void initialize() const {Image & dst};
 
    void getDstConf(const ImageConf &src, ImageConf &dst) const;
    //void makeCompatible(const ImageFrame &src, Image &dst) const;
 
    //mutable Image paletteImage;
    Palette myPalette;
    const Palette *palettePtr;
 
};
 
 
 
}
 
}
 
#endif /*PALETTEOP_H_*/
 
// Drain