Palette.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_PALETTE
#define DRAIN_PALETTE
 
#include "drain/Dictionary.h"
#include "drain/util/JSON.h"
#include "drain/util/StringMapper.h"
 
#include "Geometry.h"
#include "TreeSVG.h"
#include "TreeSLD.h"
#include "PaletteEntry.h"
 
 
namespace drain
{
 
 
namespace image
{
 
 
class Palette : public ImageCodeMap<PaletteEntry> {
 
public:
 
    static
    const SprinterLayout cppLayout2;
 
    inline
    Palette() : ImageCodeMap<PaletteEntry>(), refinement(0) {
    };
 
 
    Palette(std::initializer_list<std::pair<Variable, PaletteEntry> > inits);
 
    const value_type & getEntryByCode(const std::string & code, bool lenient=true) const;
 
    inline
    key_type getValueByCode(const std::string & code, bool lenient=true) const {
        const value_type & entry = getEntryByCode(code, lenient);
        return entry.first;
    }
 
    void reset();
 
    void addEntry(double min, double red=0.0, double green=0.0, double blue=0.0, const std::string &id="", const std::string & label =""); // alpha?
 
 
    void load(const std::string & filename, bool flexible = false);
 
    void loadTXT(std::istream & ifstr);
 
    void loadJSON(std::istream & ifstr);
 
    void write(const std::string & filename) const;
 
    void exportTXT(std::ostream & ostr, char separator='\t', char separator2=0) const;
 
    //void exportJSON(drain::JSONtree::tree_t & json) const;
    void exportJSON(drain::JSONtree & json) const;
 
    // Export formatted
    void exportFMT(std::ostream & ostr, const std::string & format) const;
 
    void exportSVGLegend(TreeSVG & svg, bool up = true) const;
 
    void exportSLD(TreeSLD & sld) const;
 
 
 
    // void convertJSON(const drain::JSONtree::tree_t & json);
 
    const ChannelGeometry & getChannels() const {
        update();
        return channels;
    }
 
    std::string title;
 
    //  std::string id; ?
 
    typedef std::map<std::string,PaletteEntry> spec_t;
    spec_t specialCodes; // To be read from palette
 
    void refine(size_t n=0);
 
    // typedef drain::Dictionary<key_t, std::string> dict_t;
 
 
 
    size_t refinement;
 
    // Metadata - for example, the file path of a loaded palette.
    std::string comment;
 
protected:
 
    // dict_t dictionary; // deprecating!
 
 
    void update() const;
 
    void importJSON(const drain::JSONtree & json);
 
    mutable
    ChannelGeometry channels;
 
 
};
 
 
inline
std::ostream & operator<<(std::ostream &ostr, const Palette & p){
    p.exportTXT(ostr);
    return ostr;
}
 
 
 
 
class PaletteMap : public std::map<std::string,drain::image::Palette> {
 
public:
 
    inline
    Palette & get(const std::string & key){
        if (aliases.hasKey(key)){
            return (*this)[aliases.getValue(key)];
        }
        else {
            return (*this)[key];
        }
    }
 
    inline
    void addAlias(const std::string & key, const std::string & aliasKey){
        aliases.add(aliasKey,key);
    }
 
// protected:
 
    drain::Dictionary<std::string, std::string> aliases;
    // std::map<std::string,std::string> aliasMap;
 
};
 
} // image::
 
template <>
std::ostream & drain::Sprinter::toStream(std::ostream & ostr, const drain::image::Palette & map, const drain::SprinterLayout & layout);
 
} // drain::
 
 
#endif