qualpal.h

Go to the documentation of this file.

 
#pragma once
 
#include <map>
#include <optional>
#include <qualpal/colors.h>
#include <qualpal/metrics.h>
#include <vector>
 
namespace qualpal {
 
enum class ColorspaceType
{
  HSL,
  LCHab
};
 
struct ColorspaceRegion
{
  std::array<double, 2> h_lim;      
  std::array<double, 2> s_or_c_lim; 
  std::array<double, 2> l_lim;      
};
 
class Qualpal
{
public:
  Qualpal() = default;
 
  Qualpal& setInputRGB(const std::vector<colors::RGB>& colors);
 
  Qualpal& setInputHex(const std::vector<std::string>& colors);
 
  Qualpal& setInputPalette(const std::string& palette_name);
 
  Qualpal& setInputColorspace(const std::array<double, 2>& h_lim,
                              const std::array<double, 2>& s_or_c_lim,
                              const std::array<double, 2>& l_lim,
                              ColorspaceType space = ColorspaceType::HSL);
 
  Qualpal& setInputColorspaceRegions(
    const std::vector<ColorspaceRegion>& regions,
    ColorspaceType space = ColorspaceType::HSL);
 
  Qualpal& setCvd(const std::map<std::string, double>& cvd_params);
 
  Qualpal& setBackground(const colors::RGB& bg_color);
 
  Qualpal& setMetric(metrics::MetricType metric);
 
  Qualpal& setMemoryLimit(double gb);
 
  Qualpal& setColorspaceSize(std::size_t n_points);
 
  Qualpal& setWhitePoint(WhitePoint wp);
 
  Qualpal& setWhitePoint(const std::array<double, 3>& white_point);
 
  std::vector<colors::RGB> generate(std::size_t n);
 
  std::vector<colors::RGB> extend(const std::vector<colors::RGB>& palette,
                                  std::size_t n);
 
private:
  std::vector<colors::RGB> selectColors(
    std::size_t n,
    const std::vector<colors::RGB>& fixed_palette = {});
 
  std::vector<colors::RGB> rgb_colors_in;
 
  std::vector<std::string> hex_colors;
 
  std::string palette;
 
  std::vector<ColorspaceRegion> colorspace_regions;
  std::size_t n_points = 1000;
 
  enum class Mode
  {
    NONE,
    RGB,
    HEX,
    PALETTE,
    COLORSPACE
  } mode = Mode::NONE;
 
  std::map<std::string, double> cvd;
  std::optional<colors::RGB> bg;
  metrics::MetricType metric = metrics::MetricType::CIEDE2000;
  double max_memory = 1;
  ColorspaceType colorspace_input = ColorspaceType::HSL;
  std::array<double, 3> white_point = { 0.95047, 1, 1.08883 }; // D65
};
 
} // namespace qualpal