Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

d.legend: handle 0 for log (-l) #1507

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

d.legend: handle 0 for log (-l) #1507

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
b5e8c1d
d.legend: handle 0 for log (-l)
HuidaeCho Apr 6, 2021
0642c6b
Minor revision
HuidaeCho Apr 7, 2021
15374b3
Comments
HuidaeCho Apr 7, 2021
49db556
log support for label_values; fix min and max labels for non-positve …
HuidaeCho Apr 7, 2021
10b4e31
Add comments
HuidaeCho Apr 23, 2021
d70a3a6
Fatal error on max <= 0 (non-positive raster)
HuidaeCho Apr 23, 2021
0e337b6
Indent code
wenzeslaus Sep 7, 2022
77bcdd1
Merge main with indent into d_legend_log with indent on draw.c
wenzeslaus Sep 7, 2022
e8f0ab7
apply clang-format
nilason Feb 15, 2023
5cbbb30
Merge branch 'main' into d_legend_log
nilason Feb 15, 2023
bb285a6
Merge branch 'main' into d_legend_log
nilason Feb 15, 2023
79b2221
Merge remote-tracking branch 'upstream/main' into d_legend_log
neteler Nov 7, 2023
1e26114
Merge branch 'main' into d_legend_log
echoix Mar 21, 2024
6c271f7
Merge branch 'main' into d_legend_log
echoix Jun 26, 2024
74f0487
Merge branch 'main' into d_legend_log
echoix Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 81 additions & 27 deletions display/d.legend/draw.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
struct Range range;
struct FPRange fprange, render_range;
CELL min_ind, max_ind;
DCELL dmin, dmax, val;
DCELL dmin, dmax, val, eps_min, eps = 1.0;
CELL min_colr, max_colr;
DCELL min_dcolr, max_dcolr;
int x0, x1, y0, y1, xyTemp;
Expand Down Expand Up @@ -323,13 +323,20 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
}
}

/* In case of log. scale raster doesn't contain negative or zero values
*/
if (log_sc)
if ((dmin <= 0) || (dmax <= 0))
G_fatal_error(
_("Range [%.3f, %.3f] out of the logarithm domain."), dmin,
dmax);
if (log_sc) {
if (dmax <= 0)
G_fatal_error(_("No positive cell values found; "
"logarithmic legend cannot be displayed"));
if (dmin > 0)
eps_min = dmin;
else {
G_warning(_("Non-positive cell values found; "
"discarding colors for cells <= %g and "
"assuming a positive min cell value of %g"),
eps, eps);
eps_min = eps;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if you couldn't just use dmin = eps_min here, which would avoid all the changes below.

}
}

if (use_catlist) {
for (i = 0; i < catlistCount; i++) {
Expand Down Expand Up @@ -395,7 +402,16 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
for (k = 0; k < lleg; k++) {
if (log_sc) { /* logarithmic scale */
num = k / lleg;
val = dmin * pow(dmax / dmin, num);
/* XXX: for log scale, if the entire raster is not
* positive, use the max color only; actually, this is
* incorrect because negative values can have different
* colors on the monitor; maybe, we should throw a fatal
* error in this case because using the max color only for
* displaying a raster and its legend is different and the
* legend must always match the display; well... unless the
* raster is colorized using r.colors -g, but how do we
* know that? */
val = dmax <= 0 ? dmax : eps_min * pow(dmax / eps_min, num);
Comment on lines +405 to +414
Copy link
Contributor

@petrasovaa petrasovaa Feb 20, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these comments are somewhat confusing and perhaps not updated after introducing the fatal error for rasters with all negative values. I would suggest to summarize the reasoning and perhaps move it somewhere close to the fatal error call.

Given the fatal error in the beginning, these expressions don't need to test for the negative cases and can be simplified. This applies to all/most of the changes below.

D_d_color(val, &colors);
if (!flip) {
if (horiz)
Expand Down Expand Up @@ -440,7 +456,13 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
}

/* Format text */
if (!fp) { /* cut down labelnum so they don't repeat */
if (fp) {
if (log_sc && dmax <= 0) /* label min and max only */
/* XXX: again, if the entire raster is not positive, maybe, we
* should quit */
steps = 2;
}
else { /* cut down labelnum so they don't repeat */
if (do_cats < steps)
steps = do_cats;
}
Expand Down Expand Up @@ -530,10 +552,16 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
buff[0] = 0; /* no text */
else {
if (log_sc) {
num =
log10(dmax) -
k * ((log10(dmax) - log10(dmin)) / (steps - 1));
val = pow(10, num);
if (dmax <= 0)
/* XXX: again, if the entire raster is not
* positive, maybe, we should quit */
val = k == 0 ? dmax : dmin;
else {
num = log10(dmax) -
k * ((log10(dmax) - log10(eps_min)) /
(steps - 1));
val = pow(10, num);
}
}
else {
if (!flip)
Expand All @@ -560,8 +588,13 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
D_get_text_box(buff, &bb, &bt, &bl, &br);
if (!horiz) {
if (log_sc) {
coef = (log10(val) - log10(dmin)) /
(log10(dmax) - log10(dmin));
if (dmax <= 0)
/* XXX: again, if the entire raster is not
* positive, maybe, we should quit */
coef = k == 0;
else
coef = (log10(val) - log10(eps_min)) /
(log10(dmax) - log10(eps_min));
if (flip)
D_pos_abs(x1 + label_indent,
y1 - coef * lleg + (bb - bt) / 2);
Expand Down Expand Up @@ -590,8 +623,13 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
}
else {
if (log_sc) {
coef = (log10(val) - log10(dmin)) /
(log10(dmax) - log10(dmin));
if (dmax <= 0)
/* XXX: again, if the entire raster is not
* positive, maybe, we should quit */
coef = k == 0;
else
coef = (log10(val) - log10(eps_min)) /
(log10(dmax) - log10(eps_min));
if (flip)
D_pos_abs(x1 - coef * wleg -
((br - bl) / 2),
Expand Down Expand Up @@ -642,6 +680,11 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
_("tick_value=%.3f out of range [%.3f, %.3f]"),
tick_values[i], dmin, dmax);
}
if (log_sc && tick_values[i] <= 0) {
G_warning(_("Skipping non-positive tick_value=%.3f"),
tick_values[i]);
continue;
}
sprintf(buff, DispFormat, tick_values[i]);
if (strlen(units) > 0)
strcat(buff, units);
Expand All @@ -653,10 +696,9 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
sprintf(MaxLabel, "%s", buff);
}

if (log_sc) {
coef = (log10(tick_values[i]) - log10(dmin)) /
(log10(dmax) - log10(dmin));
}
if (log_sc)
coef = (log10(tick_values[i]) - log10(eps_min)) /
(log10(dmax) - log10(eps_min));
else
coef = (tick_values[i] - dmin) / ((dmax - dmin) * 1.0);

Expand Down Expand Up @@ -713,9 +755,23 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
if (opt_tstep->answer) {
if (log_sc) { /* logarithmic */
t_start = 0;
while (log10(dmin) + t_start < log10(dmax)) {
num = ceil(log10(dmin)) + t_start;
val = pow(10, num);
while (
log10(eps_min) + t_start <
(dmax > 0 ? log10(dmax) : log10(eps_min) + 1.5 * t_step)) {
/* only twice if dmax <= 0 */
if (dmax <= 0) {
/* XXX: again, if the entire raster is not positive,
* maybe, we should quit */
/* dmax and dmin only if dmax <= 0 */
val = t_start == 0 ? dmax : dmin;
coef = t_start == 0;
}
else {
num = ceil(log10(eps_min)) + t_start;
val = pow(10, num);
coef = (log10(val) - log10(eps_min)) /
(log10(dmax) - log10(eps_min));
}
sprintf(buff, DispFormat, val);
if (strlen(units) > 0)
strcat(buff, units);
Expand All @@ -726,8 +782,6 @@ void draw(const char *map_name, int maptype, int color, int thin, int lines,
MaxLabelW = LabelW;
sprintf(MaxLabel, "%s", buff);
}
coef = (log10(val) - log10(dmin)) /
(log10(dmax) - log10(dmin));
if (draw) {
if (!flip) {
if (!horiz) {
Expand Down
Loading