Add export format options: CSV, JSON, PPM
[gencolormap.git] / cmdline.cpp
index a3adc77..4d8c753 100644 (file)
@@ -1,5 +1,6 @@
 /*
- * Copyright (C) 2015, 2016 Computer Graphics Group, University of Siegen
+ * Copyright (C) 2015, 2016, 2017, 2018, 2019
+ * Computer Graphics Group, University of Siegen
  * Written by Martin Lambers <martin.lambers@uni-siegen.de>
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -32,36 +33,47 @@ extern char *optarg;
 extern int optind;
 
 #include "colormap.hpp"
+#include "export.hpp"
 
 enum type {
-    brewer_seq = 0,
-    brewer_div = 1,
-    brewer_qual = 2,
-    isolum_seq = 3,
-    isolum_div = 4,
-    isolum_qual = 5,
-    blackbody = 6,
-    cubehelix = 7,
-    moreland = 8,
-    mcnames = 9
+    brewer_seq,
+    brewer_div,
+    brewer_qual,
+    plseq_lightness,
+    plseq_saturation,
+    plseq_rainbow,
+    plseq_blackbody,
+    pldiv_lightness,
+    pldiv_saturation,
+    plqual_hue,
+    cubehelix,
+    moreland,
+    mcnames
+};
+
+enum format {
+    csv,
+    json,
+    ppm
 };
 
 int main(int argc, char* argv[])
 {
     bool print_version = false;
     bool print_help = false;
-    int type = -1;
-    int n = -1;
+    int format = csv;
+    int type = brewer_seq;
+    int n = 256;
     float hue = -1.0f;
     float divergence = -1.0f;
     float contrast = -1.0f;
     float saturation = -1.0f;
     float brightness = -1.0f;
     float warmth = -1.0f;
-    float luminance = -1.0f;
+    float lightness = -1.0f;
+    float rotations = NAN;
     float temperature = -1.0f;
     float range = -1.0f;
-    float rotations = NAN;
     float gamma = -1.0f;
     bool have_color0 = false;
     unsigned char color0[3];
@@ -71,6 +83,7 @@ int main(int argc, char* argv[])
     struct option options[] = {
         { "version",     no_argument,       0, 'v' },
         { "help",        no_argument,       0, 'H' },
+        { "format",      required_argument, 0, 'f' },
         { "type",        required_argument, 0, 't' },
         { "n",           required_argument, 0, 'n' },
         { "hue",         required_argument, 0, 'h' },
@@ -79,10 +92,10 @@ int main(int argc, char* argv[])
         { "saturation",  required_argument, 0, 's' },
         { "brightness",  required_argument, 0, 'b' },
         { "warmth",      required_argument, 0, 'w' },
-        { "luminance",   required_argument, 0, 'l' },
+        { "lightness",   required_argument, 0, 'l' },
+        { "rotations",   required_argument, 0, 'r' },
         { "temperature", required_argument, 0, 'T' },
         { "range",       required_argument, 0, 'R' },
-        { "rotations",   required_argument, 0, 'r' },
         { "gamma",       required_argument, 0, 'g' },
         { "color0",      required_argument, 0, 'A' },
         { "color1",      required_argument, 0, 'O' },
@@ -91,7 +104,7 @@ int main(int argc, char* argv[])
     };
 
     for (;;) {
-        int c = getopt_long(argc, argv, "vHt:n:h:d:c:s:b:w:l:T:R:r:g:A:O:p:", options, NULL);
+        int c = getopt_long(argc, argv, "vHf:t:n:h:d:c:s:b:w:l:T:R:r:g:A:O:p:", options, NULL);
         if (c == -1)
             break;
         switch (c) {
@@ -101,18 +114,27 @@ int main(int argc, char* argv[])
         case 'H':
             print_help = true;
             break;
+        case 'f':
+            format = (strcmp(optarg, "csv") == 0 ? csv
+                    : strcmp(optarg, "json") == 0 ? json
+                    : strcmp(optarg, "ppm") == 0 ? ppm
+                    : -1);
+            break;
         case 't':
             type = (strcmp(optarg, "brewer-sequential") == 0 ? brewer_seq
                     : strcmp(optarg, "brewer-diverging") == 0 ? brewer_div
                     : strcmp(optarg, "brewer-qualitative") == 0 ? brewer_qual
-                    : strcmp(optarg, "isoluminant-sequential") == 0 ? isolum_seq
-                    : strcmp(optarg, "isoluminant-divergent") == 0 ? isolum_div
-                    : strcmp(optarg, "isoluminant-qualitative") == 0 ? isolum_qual
-                    : strcmp(optarg, "blackbody") == 0 ? blackbody
+                    : strcmp(optarg, "plsequential-lightness") == 0 ? plseq_lightness
+                    : strcmp(optarg, "plsequential-saturation") == 0 ? plseq_saturation
+                    : strcmp(optarg, "plsequential-rainbow") == 0 ? plseq_rainbow
+                    : strcmp(optarg, "plsequential-blackbody") == 0 ? plseq_blackbody
+                    : strcmp(optarg, "pldiverging-lightness") == 0 ? pldiv_lightness
+                    : strcmp(optarg, "pldiverging-saturation") == 0 ? pldiv_saturation
+                    : strcmp(optarg, "plqualitative-hue") == 0 ? plqual_hue
                     : strcmp(optarg, "cubehelix") == 0 ? cubehelix
                     : strcmp(optarg, "moreland") == 0 ? moreland
                     : strcmp(optarg, "mcnames") == 0 ? mcnames
-                    : -2);
+                    : -1);
             break;
         case 'n':
             n = atoi(optarg);
@@ -136,7 +158,10 @@ int main(int argc, char* argv[])
             warmth = atof(optarg);
             break;
         case 'l':
-            luminance = atof(optarg);
+            lightness = atof(optarg);
+            break;
+        case 'r':
+            rotations = atof(optarg);
             break;
         case 'T':
             temperature = atof(optarg);
@@ -144,9 +169,6 @@ int main(int argc, char* argv[])
         case 'R':
             range = atof(optarg);
             break;
-        case 'r':
-            rotations = atof(optarg);
-            break;
         case 'g':
             gamma = atof(optarg);
             break;
@@ -167,8 +189,9 @@ int main(int argc, char* argv[])
     }
 
     if (print_version) {
-        printf("gencolormap version 0.3\n"
-                "Copyright (C) 2016 Computer Graphics Group, University of Siegen.\n"
+        printf("gencolormap version 1.0\n"
+                "https://marlam.de/gencolormap\n"
+                "Copyright (C) 2019 Computer Graphics Group, University of Siegen.\n"
                 "Written by Martin Lambers <martin.lambers@uni-siegen.de>.\n"
                 "This is free software under the terms of the MIT/Expat License.\n"
                 "There is NO WARRANTY, to the extent permitted by law.\n");
@@ -176,54 +199,65 @@ int main(int argc, char* argv[])
     }
 
     if (print_help) {
-        printf("Usage: %s\n"
-                "  Common options, required for all types:\n"
-                "    -n|--n=N                         Set number of colors in the map\n"
-                "  Brewer-like color maps:\n"
-                "    -t|--type=brewer-sequential       Generate a sequential color map\n"
-                "    -t|--type=brewer-diverging        Generate a diverging color map\n"
-                "    -t|--type=brewer-qualitative      Generate a qualitative color map\n"
-                "    [-h|--hue=H]                      Set default hue in [0,360] degrees\n"
-                "    [-c|--contrast=C]                 Set contrast in [0,1]\n"
-                "    [-s|--saturation=S]               Set saturation in [0,1]\n"
-                "    [-b|--brightness=B]               Set brightness in [0,1]\n"
-                "    [-w|--warmth=W]                   Set warmth in [0,1] for seq. and div. maps\n"
-                "    [-d|--divergence=D]               Set divergence in deg. for div. and qual. maps\n"
-                "  Isoluminant color maps:\n"
-                "    -t|--type=isoluminant-sequential  Generate a sequential color map\n"
-                "    -t|--type=isoluminant-diverging   Generate a diverging color map\n"
-                "    -t|--type=isoluminant-qualitative Generate a qualitative color map\n"
-                "    [-l|--luminance=L]                Set luminance in [0,1]\n"
-                "    [-s|--saturation=S]               Set saturation in [0,1]\n"
-                "    [-h|--hue=H]                      Set default hue in [0,360] degrees\n"
-                "    [-d|--divergence=D]               Set divergence in deg. for div. and qual. maps\n"
-                "  Black Body color maps:\n"
-                "    -t|--type=blackbody               Generate a Black Body color map\n"
-                "    [-T|--temperature=T]              Start temperature of the map in Kelvin\n"
-                "    [-R|--range=R]                    Range of temperatures of the map in Kelvin\n"
-                "  CubeHelix color maps:\n"
-                "    -t|--type=cubehelix               Generate a CubeHelix color map\n"
-                "    [-r|--rotations=R]                Set number of rotations, in (-infty,infty)\n"
-                "    [-s|--saturation=S]               Set saturation, in [0,1]\n"
-                "    [-g|--gamma=G]                    Set gamma correction, in (0,infty)\n"
-                "  Moreland diverging color maps:\n"
-                "    -t|--type=moreland                Generate a Moreland diverging color map\n"
-                "    [-A|--color0=sr,sg,sb             Set the first color as sRGB values in [0,255]\n"
-                "    [-O|--color1=sr,sg,sb             Set the last color as sRGB values in [0,255]\n"
-                "  McNames sequential color maps:\n"
-                "    -t|--type=mcnames                 Generate a McNames sequential color map\n"
-                "    [-p|--periods=P]                  Set the number of periods in (0, infty)\n"
-                "Generates a color map and prints it to standard output as sRGB triplets.\n"
-                "Report bugs to <martin.lambers@uni-siegen.de>.\n", argv[0]);
+        printf("Usage: %s [option...]\n"
+                "Generates a color map and prints it to standard output.\n"
+                "Prints the number of colors that had to be clipped to standard error.\n"
+                "Common options:\n"
+                "  [-f|--format=csv|json|ppm]          Set output format\n"
+                "  [-n|--n=N]                          Set number of colors in the map\n"
+                "Brewer-like color maps:\n"
+                "  [-t|--type=brewer-sequential]       Generate a sequential color map\n"
+                "  [-t|--type=brewer-diverging]        Generate a diverging color map\n"
+                "  [-t|--type=brewer-qualitative]      Generate a qualitative color map\n"
+                "  [-h|--hue=H]                        Set default hue in [0,360] degrees\n"
+                "  [-c|--contrast=C]                   Set contrast in [0,1]\n"
+                "  [-s|--saturation=S]                 Set saturation in [0,1]\n"
+                "  [-b|--brightness=B]                 Set brightness in [0,1]\n"
+                "  [-w|--warmth=W]                     Set warmth in [0,1] for seq. and div. maps\n"
+                "  [-d|--divergence=D]                 Set diverg. in deg for div. and qual. maps\n"
+                "Perceptually linear color maps:\n"
+                "  [-t|--type=plsequential-lightness]  Sequential map, varying lightness\n"
+                "  [-t|--type=plsequential-saturation] Sequential map, varying saturation\n"
+                "  [-t|--type=plsequential-rainbow]    Sequential map, varying hue (rainbow)\n"
+                "  [-t|--type=plsequential-blackbody]  Sequential map, varying hue (black body)\n"
+                "  [-t|--type=pldiverging-lightness]   Diverging map, varying lightness\n"
+                "  [-t|--type=pldiverging-saturation]  Diverging map, varying saturation\n"
+                "  [-t|--type=plqualitative-hue]       Qualitative map, evenly distributed hue\n"
+                "  [-l|--lightness=L]                  Set lightness in [0,1]\n"
+                "  [-s|--saturation=S]                 Set saturation in [0,1]\n"
+                "  [-h|--hue=H]                        Set default hue in [0,360] degrees\n"
+                "  [-d|--divergence=D]                 Set diverg. in deg for div. and qual. maps\n"
+                "  [-r|--rotations=R]                  Set number of rotations for rainbow maps\n"
+                "  [-T|--temperature=T]                Set start temp. in K for black body maps\n"
+                "  [-R|--range=R]                      Set temp. range in K for black body maps\n"
+                "CubeHelix color maps:\n"
+                "  [-t|--type=cubehelix]               Generate a CubeHelix color map\n"
+                "  [-h|--hue=H]                        Set start hue in [0,180] degrees\n"
+                "  [-r|--rotations=R]                  Set number of rotations, in (-infty,infty)\n"
+                "  [-s|--saturation=S]                 Set saturation, in [0,1]\n"
+                "  [-g|--gamma=G]                      Set gamma correction, in (0,infty)\n"
+                "Moreland diverging color maps:\n"
+                "  [-t|--type=moreland]                Generate a Moreland diverging color map\n"
+                "  [-A|--color0=sr,sg,sb]              Set the first color as sRGB in [0,255]\n"
+                "  [-O|--color1=sr,sg,sb]              Set the last color as sRGB in [0,255]\n"
+                "McNames sequential color maps:\n"
+                "  [-t|--type=mcnames]                 Generate a McNames sequential color map\n"
+                "  [-p|--periods=P]                    Set the number of periods in (0, infty)\n"
+                "Defaults: format=csv, n=256, type=brewer-sequential\n"
+                "https://marlam.de/gencolormap\n", argv[0]);
         return 0;
     }
 
-    if (type < 0) {
-        fprintf(stderr, "Invalid or missing option -t|--type.\n");
+    if (format < 0) {
+        fprintf(stderr, "Invalid argument for option -f|--format.\n");
         return 1;
     }
     if (n < 2) {
-        fprintf(stderr, "Invalid or missing option -n|--n.\n");
+        fprintf(stderr, "Invalid argument for option -n|--n.\n");
+        return 1;
+    }
+    if (type < 0) {
+        fprintf(stderr, "Invalid argument for option -t|--type.\n");
         return 1;
     }
     if (hue < 0.0f) {
@@ -233,12 +267,18 @@ int main(int argc, char* argv[])
             hue = ColorMap::BrewerDivergingDefaultHue;
         else if (type == brewer_qual)
             hue = ColorMap::BrewerQualitativeDefaultHue;
-        else if (type == isolum_seq)
-            hue = ColorMap::IsoluminantSequentialDefaultHue;
-        else if (type == isolum_div)
-            hue = ColorMap::IsoluminantDivergingDefaultHue;
-        else if (type == isolum_qual)
-            hue = ColorMap::IsoluminantQualitativeDefaultHue;
+        else if (type == plseq_lightness)
+            hue = ColorMap::PLSequentialLightnessDefaultHue;
+        else if (type == plseq_saturation)
+            hue = ColorMap::PLSequentialSaturationDefaultHue;
+        else if (type == plseq_rainbow)
+            hue = ColorMap::PLSequentialRainbowDefaultHue;
+        else if (type == pldiv_lightness)
+            hue = ColorMap::PLDivergingLightnessDefaultHue;
+        else if (type == pldiv_saturation)
+            hue = ColorMap::PLDivergingSaturationDefaultHue;
+        else if (type == plqual_hue)
+            hue = ColorMap::PLQualitativeHueDefaultHue;
         else if (type == cubehelix)
             hue = ColorMap::CubeHelixDefaultHue;
     }
@@ -247,8 +287,12 @@ int main(int argc, char* argv[])
             divergence = ColorMap::BrewerDivergingDefaultDivergence;
         else if (type == brewer_qual)
             divergence = ColorMap::BrewerQualitativeDefaultDivergence;
-        else if (type == isolum_div)
-            divergence = ColorMap::IsoluminantDivergingDefaultDivergence;
+        else if (type == pldiv_lightness)
+            divergence = ColorMap::PLDivergingLightnessDefaultDivergence;
+        else if (type == pldiv_saturation)
+            divergence = ColorMap::PLDivergingSaturationDefaultDivergence;
+        else if (type == plqual_hue)
+            divergence = ColorMap::PLQualitativeHueDefaultDivergence;
     }
     if (contrast < 0.0f) {
         if (type == brewer_seq)
@@ -267,12 +311,20 @@ int main(int argc, char* argv[])
             saturation = ColorMap::BrewerDivergingDefaultSaturation;
         else if (type == brewer_qual)
             saturation = ColorMap::BrewerQualitativeDefaultSaturation;
-        else if (type == isolum_seq)
-            saturation = ColorMap::IsoluminantSequentialDefaultSaturation;
-        else if (type == isolum_div)
-            saturation = ColorMap::IsoluminantDivergingDefaultSaturation;
-        else if (type == isolum_qual)
-            saturation = ColorMap::IsoluminantQualitativeDefaultSaturation;
+        else if (type == plseq_lightness)
+            saturation = ColorMap::PLSequentialLightnessDefaultSaturation;
+        else if (type == plseq_saturation)
+            saturation = ColorMap::PLSequentialSaturationDefaultSaturation;
+        else if (type == plseq_rainbow)
+            saturation = ColorMap::PLSequentialRainbowDefaultSaturation;
+        else if (type == plseq_blackbody)
+            saturation = ColorMap::PLSequentialBlackBodyDefaultSaturation;
+        else if (type == pldiv_lightness)
+            saturation = ColorMap::PLDivergingLightnessDefaultSaturation;
+        else if (type == pldiv_saturation)
+            saturation = ColorMap::PLDivergingSaturationDefaultSaturation;
+        else if (type == plqual_hue)
+            saturation = ColorMap::PLQualitativeHueDefaultSaturation;
         else if (type == cubehelix)
             saturation = ColorMap::CubeHelixDefaultSaturation;
     }
@@ -290,25 +342,29 @@ int main(int argc, char* argv[])
         else if (type == brewer_div)
             warmth = ColorMap::BrewerDivergingDefaultWarmth;
     }
-    if (luminance < 0.0f) {
-        if (type == isolum_seq)
-            luminance = ColorMap::IsoluminantSequentialDefaultLuminance;
-        else if (type == isolum_div)
-            luminance = ColorMap::IsoluminantDivergingDefaultLuminance;
-        else if (type == isolum_qual)
-            luminance = ColorMap::IsoluminantQualitativeDefaultLuminance;
+    if (lightness < 0.0f) {
+        if (type == plseq_saturation)
+            lightness = ColorMap::PLSequentialSaturationDefaultLightness;
+        else if (type == pldiv_lightness)
+            lightness = ColorMap::PLDivergingLightnessDefaultLightness;
+        else if (type == pldiv_saturation)
+            lightness = ColorMap::PLDivergingSaturationDefaultLightness;
+        else if (type == plqual_hue)
+            lightness = ColorMap::PLQualitativeHueDefaultLightness;
+    }
+    if (std::isnan(rotations)) {
+        if (type == plseq_rainbow)
+            rotations = ColorMap::PLSequentialRainbowDefaultRotations;
+        else if (type == cubehelix)
+            rotations = ColorMap::CubeHelixDefaultRotations;
     }
     if (temperature < 0.0f) {
-        if (type == blackbody)
-            temperature = ColorMap::BlackBodyDefaultTemperature;
+        if (type == plseq_blackbody)
+            temperature = ColorMap::PLSequentialBlackBodyDefaultTemperature;
     }
     if (range < 0.0f) {
-        if (type == blackbody)
-            range = ColorMap::BlackBodyDefaultRange;
-    }
-    if (std::isnan(rotations)) {
-        if (type == cubehelix)
-            rotations = ColorMap::CubeHelixDefaultRotations;
+        if (type == plseq_blackbody)
+            range = ColorMap::PLSequentialBlackBodyDefaultRange;
     }
     if (gamma < 0.0f) {
         if (type == cubehelix)
@@ -334,44 +390,61 @@ int main(int argc, char* argv[])
     }
 
     std::vector<unsigned char> colormap(3 * n);
+    int clipped;
     switch (type) {
     case brewer_seq:
-        ColorMap::BrewerSequential(n, &(colormap[0]), hue, contrast, saturation, brightness, warmth);
+        clipped = ColorMap::BrewerSequential(n, &(colormap[0]), hue, contrast, saturation, brightness, warmth);
         break;
     case brewer_div:
-        ColorMap::BrewerDiverging(n, &(colormap[0]), hue, divergence, contrast, saturation, brightness, warmth);
+        clipped = ColorMap::BrewerDiverging(n, &(colormap[0]), hue, divergence, contrast, saturation, brightness, warmth);
         break;
     case brewer_qual:
-        ColorMap::BrewerQualitative(n, &(colormap[0]), hue, divergence, contrast, saturation, brightness);
+        clipped = ColorMap::BrewerQualitative(n, &(colormap[0]), hue, divergence, contrast, saturation, brightness);
+        break;
+    case plseq_lightness:
+        clipped = ColorMap::PLSequentialLightness(n, &(colormap[0]), saturation, hue);
+        break;
+    case plseq_saturation:
+        clipped = ColorMap::PLSequentialSaturation(n, &(colormap[0]), lightness, saturation, hue);
+        break;
+    case plseq_rainbow:
+        clipped = ColorMap::PLSequentialRainbow(n, &(colormap[0]), hue, rotations, saturation);
         break;
-    case isolum_seq:
-        ColorMap::IsoluminantSequential(n, &(colormap[0]), luminance, saturation, hue);
+    case plseq_blackbody:
+        clipped = ColorMap::PLSequentialBlackBody(n, &(colormap[0]), temperature, range, saturation);
         break;
-    case isolum_div:
-        ColorMap::IsoluminantDiverging(n, &(colormap[0]), luminance, saturation, hue, divergence);
+    case pldiv_lightness:
+        clipped = ColorMap::PLDivergingLightness(n, &(colormap[0]), lightness, saturation, hue, divergence);
         break;
-    case isolum_qual:
-        ColorMap::IsoluminantQualitative(n, &(colormap[0]), luminance, saturation, hue);
+    case pldiv_saturation:
+        clipped = ColorMap::PLDivergingSaturation(n, &(colormap[0]), lightness, saturation, hue, divergence);
         break;
-    case blackbody:
-        ColorMap::BlackBody(n, &(colormap[0]), temperature, range);
+    case plqual_hue:
+        clipped = ColorMap::PLQualitativeHue(n, &(colormap[0]), hue, divergence, lightness, saturation);
         break;
     case cubehelix:
-        ColorMap::CubeHelix(n, &(colormap[0]), hue, rotations, saturation, gamma);
+        clipped = ColorMap::CubeHelix(n, &(colormap[0]), hue, rotations, saturation, gamma);
         break;
     case moreland:
-        ColorMap::Moreland(n, &(colormap[0]),
+        clipped = ColorMap::Moreland(n, &(colormap[0]),
                 color0[0], color0[1], color0[2],
                 color1[0], color1[1], color1[2]);
         break;
     case mcnames:
-        ColorMap::McNames(n, &(colormap[0]), periods);
+        clipped = ColorMap::McNames(n, &(colormap[0]), periods);
         break;
     }
 
-    for (int i = 0; i < n; i++) {
-        printf("%d, %d, %d\n", colormap[3 * i + 0], colormap[3 * i + 1], colormap[3 * i + 2]);
+    std::string output;
+    if (format == csv) {
+        output = ColorMap::ToCSV(n, colormap.data());
+    } else if (format == json) {
+        output = ColorMap::ToJSON(n, colormap.data());
+    } else {
+        output = ColorMap::ToPPM(n, colormap.data());
     }
+    fputs(output.c_str(), stdout);
+    fprintf(stderr, "%d color(s) were clipped\n", clipped);
 
     return 0;
 }