1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
|
/*
* This file is part of the ESO Common Pipeline Library
* Copyright (C) 2001-2017 European Southern Observatory
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
/*-----------------------------------------------------------------------------
Includes
-----------------------------------------------------------------------------*/
#include "cpl_plot.h"
#include "cpl_memory.h"
#include "cpl_error_impl.h"
#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <string.h>
#include <stdlib.h>
#include <assert.h>
#include <float.h>
/*-----------------------------------------------------------------------------
Defines
-----------------------------------------------------------------------------*/
#ifndef CPL_PLOT_TMPFILE
#define CPL_PLOT_TMPFILE "cpl_plot.txt"
#endif
/*----------------------------------------------------------------------------*/
/**
* @defgroup cpl_plot Plotting of CPL objects
*
* This module provides functions to plot basic CPL objects
*
* This module is offered to help during the development process.
* The functions offered should NOT be used in any operational environment.
* For that reason, the support of those remains limited, and no functionality
* extension can be expected from the CPL team.
*
* The created plot windows can be closed by pressing the 'q' key like
* you would do with a normal gnuplot window.
*
* The default behaviour of the plotting is to use gnuplot (with option
* -persist). The user can control the actual plotting-command used to create
* the plot by setting the environment variable CPL_PLOTTER. Currently, if
* CPL_PLOTTER is set it must contain the string 'gnuplot'. Setting
* it to 'cat > my_gnuplot_$$.txt' causes a number of ASCII-files to be
* created, which each produce a plot when given as standard input to gnuplot.
*
* A finer control of the plotting options can be obtained by writing an
* executable script, e.g. my_gnuplot, that executes gnuplot after setting
* the desired gnuplot options (e.g. set terminal pslatex color) and then
* setting CPL_PLOTTER to my_gnuplot.
*
* Images can be plotted not only with gnuplot, but also using the pnm format.
* This is controlled with the environment variable CPL_IMAGER. If CPL_IMAGER
* is set to a string that does not contain the word gnuplot, the recipe
* will generate the plot in pnm format. E.g. setting CPL_IMAGER to
* 'display - &' will produce a gray-scale image using the image viewer display.
*
* @code
* #include "cpl_plot.h"
* @endcode
*/
/*----------------------------------------------------------------------------*/
/**@{*/
/*-----------------------------------------------------------------------------
Type definition
-----------------------------------------------------------------------------*/
typedef struct _cpl_plot_ cpl_plot;
struct _cpl_plot_ {
/* File with data to be sent to plotting command's stdin */
FILE * data;
/* Name of command capable of reading the plot on stdin */
const char * exe;
/* Name of temporary file for storing the plot commands */
const char * tmp;
};
/*-----------------------------------------------------------------------------
Private function prototypes
-----------------------------------------------------------------------------*/
static cpl_error_code cpl_mplot_puts(cpl_plot *, const char *);
static cpl_error_code cpl_mplot_write(cpl_plot *, const char *, size_t);
static cpl_plot * cpl_mplot_open(const char *);
static cpl_plot * cpl_image_open(const char *);
static cpl_error_code cpl_mplot_close(cpl_plot *, const char *);
static const char * cpl_mplot_plotter(void);
static const char * cpl_mplot_imager(void);
/*-----------------------------------------------------------------------------
Functions code
-----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/**
@brief Plot a vector
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param vector The vector to plot
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
The vector must have a positive number of elements.
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_vector(const char * pre,
const char * options,
const char * post,
const cpl_vector * vector)
{
const double * pvec = cpl_vector_get_data_const(vector);
const cpl_size n = cpl_vector_get_size(vector);
cpl_error_code error = CPL_ERROR_NONE;
cpl_size i;
cpl_plot * plot;
if (n <= 0) return cpl_error_set_where_();
plot = cpl_mplot_open(pre);
if (plot == NULL) return cpl_error_set_where_();
error |= cpl_mplot_puts(plot, "plot '-' ");
if (options != NULL) {
error |= cpl_mplot_puts(plot, options);
} else {
char * myoptions = cpl_sprintf("t '%" CPL_SIZE_FORMAT"-vector (%p)", n,
(const void*)vector);
assert(myoptions != NULL);
error |= cpl_mplot_puts(plot, myoptions);
cpl_free(myoptions);
}
error |= cpl_mplot_puts(plot, ";\n");
for (i = 0; i < n; i++) {
char * snumber = cpl_sprintf("%g\n", pvec[i]);
error |= cpl_mplot_puts(plot, snumber);
cpl_free(snumber);
if (error) break;
}
error |= cpl_mplot_puts(plot, "e\n");
error |= cpl_mplot_close(plot, post);
return error ? cpl_error_set_where_() : CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot a bivector
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param bivector The bivector to plot
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
The bivector must have a positive number of elements.
@see also @c cpl_mplot_open().
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_bivector(const char * pre,
const char * options,
const char * post,
const cpl_bivector * bivector)
{
const cpl_size n = cpl_bivector_get_size(bivector);
const double * pvecx = cpl_bivector_get_x_data_const(bivector);
const double * pvecy = cpl_bivector_get_y_data_const(bivector);
cpl_error_code error = CPL_ERROR_NONE;
cpl_plot * plot;
cpl_size i;
if (n <= 0) return cpl_error_set_where_();
plot = cpl_mplot_open(pre);
if (plot == NULL) return cpl_error_set_where_();
error |= cpl_mplot_puts(plot, "plot '-' ");
if (options != NULL) {
error |= cpl_mplot_puts(plot, options);
} else {
char * myoptions = cpl_sprintf("t '%" CPL_SIZE_FORMAT "-bivector (%p)",
n, (const void*)bivector);
assert(myoptions != NULL);
error |= cpl_mplot_puts(plot, myoptions);
cpl_free(myoptions);
}
error |= cpl_mplot_puts(plot, ";\n");
for (i = 0; i < n; i++) {
char * snumber = cpl_sprintf("%g %g\n", pvecx[i], pvecy[i]);
error |= cpl_mplot_puts(plot, snumber);
cpl_free(snumber);
if (error) break;
}
error |= cpl_mplot_puts(plot, "e\n");
error |= cpl_mplot_close(plot, post);
return error ? cpl_error_set_where_() : CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot an array of vectors
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param vectors The vectors array to plot
@param nvec The number of vectors
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
The array should contain at least 3 vectors, the first one can be
NULL.
The non-NULL vectors must have the same number of elements.
The first vector gives the x-axis. If NULL, the index is used.
@see also @c cpl_mplot_open().
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_vectors(const char * pre,
const char * options,
const char * post,
const cpl_vector ** vectors,
cpl_size nvec)
{
cpl_errorstate prestate = cpl_errorstate_get();
const double * pvecx;
const double * pvecy;
cpl_size vec_size = 0; /* Avoid uninit warning */
char ** names;
char * sval;
FILE * tmpfd;
cpl_plot * plot;
cpl_size i, j;
/* Check entries */
cpl_ensure_code(vectors != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(nvec>=3, CPL_ERROR_ILLEGAL_INPUT);
for (i=1; i<nvec; i++) {
cpl_ensure_code(vectors[i] != NULL, CPL_ERROR_NULL_INPUT);
if (i==1) vec_size = cpl_vector_get_size(vectors[i]);
else cpl_ensure_code(vec_size==cpl_vector_get_size(vectors[i]),
CPL_ERROR_ILLEGAL_INPUT);
}
if (vectors[0] != NULL) {
cpl_ensure_code(vec_size==cpl_vector_get_size(vectors[0]),
CPL_ERROR_ILLEGAL_INPUT);
}
/* Get the X axis if passed */
pvecx = vectors[0] ? cpl_vector_get_data_const(vectors[0]) : NULL;
/* Hold the files names */
names = cpl_malloc((size_t)(nvec-1)*sizeof(char*));
for (i=1; i<nvec; i++)
names[i-1] = cpl_sprintf("cpl_plot-%" CPL_SIZE_FORMAT, i);
/* Open the plot */
plot = cpl_mplot_open(pre);
/* Loop on the signals to plot */
for (i=1; i<nvec; i++) {
/* Get the current Y axis */
pvecy = cpl_vector_get_data_const(vectors[i]);
/* Open temporary file for output */
if ((tmpfd=fopen(names[i-1], "w"))==NULL) {
cpl_mplot_close(plot, post);
for (i=1; i<nvec; i++) (void) remove(names[i-1]);
for (i=1; i<nvec; i++) cpl_free(names[i-1]);
cpl_free(names);
return CPL_ERROR_FILE_IO;
}
/* Write data to this file */
for (j=0; j<vec_size; j++) {
char * snumber = cpl_sprintf("%g %g\n",
pvecx == NULL ? (double)(j+1)
: pvecx[j], pvecy[j]);
const int nstat = fputs(snumber, tmpfd);
cpl_free(snumber);
if (nstat < 0) break;
}
if (fclose(tmpfd) != 0) break;
if (j != vec_size) break;
/* Plot the file */
if (i==1) {
/* Plot the first signal */
sval = cpl_sprintf("plot '%s' %s;\n", names[i-1],
options ? options : "");
} else {
sval = cpl_sprintf("replot '%s' t 'Vector %" CPL_SIZE_FORMAT
"' w lines;\n", names[i-1], i);
}
cpl_mplot_puts(plot, sval);
cpl_free(sval);
}
cpl_mplot_close(plot, post);
for (i=1; i<nvec; i++) (void) remove(names[i-1]);
for (i=1; i<nvec; i++) cpl_free(names[i-1]);
cpl_free(names);
return cpl_errorstate_is_equal(prestate) ? CPL_ERROR_NONE
: cpl_error_set_where_();
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot an array of bivectors
@param pre An optional string with pre-plot commands
@param options Array of strings with plotting options
@param post An optional string with post-plot commands
@param bivectors The bivectors array to plot
@param nbvec The number of bivectors, at least one is
required
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
Each bivector in the array defines a sequence of points to be plotted. The
bivectors can have different size.
The @em options array must be of same size as the @em bivectors array. The
i'th string in the array specifies the plotting options for the i'th
bivector.
@see also @c cpl_mplot_open().
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_DATA_NOT_FOUND
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_bivectors(const char * pre,
const char ** options,
const char * post,
const cpl_bivector ** bivectors,
cpl_size nbvec)
{
cpl_errorstate prestate = cpl_errorstate_get();
const double * pvecx;
const double * pvecy;
char ** names;
char * sval;
FILE * tmpfd;
cpl_plot * plot;
cpl_size i;
cpl_size j;
/* Check entries */
cpl_ensure_code(bivectors != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(options != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(nbvec >= 1, CPL_ERROR_DATA_NOT_FOUND);
for (i=0; i<nbvec; i++) {
cpl_ensure_code(bivectors[i] != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code( options[i] != NULL, CPL_ERROR_NULL_INPUT);
}
/* Hold the files names */
names = cpl_malloc((size_t)nbvec * sizeof(char*));
for (i=0; i<nbvec; i++)
names[i] = cpl_sprintf("cpl_plot-%" CPL_SIZE_FORMAT, i + 1);
/* Open the plot */
plot = cpl_mplot_open(pre);
/* Loop on the signals to plot */
for (i=0; i<nbvec; i++) {
cpl_size vec_size;
/* Get current vectors */
pvecx = cpl_bivector_get_x_data_const(bivectors[i]);
pvecy = cpl_bivector_get_y_data_const(bivectors[i]);
vec_size = cpl_bivector_get_size(bivectors[i]);
/* Open temporary file for output */
if ((tmpfd=fopen(names[i], "w"))==NULL) {
cpl_mplot_close(plot, post);
for (i=0; i<nbvec; i++) (void) remove(names[i]);
for (i=0; i<nbvec; i++) cpl_free(names[i]);
cpl_free(names);
return CPL_ERROR_FILE_IO;
}
/* Write data to this file */
for (j=0; j<vec_size; j++) {
char * snumber = cpl_sprintf("%g %g\n", pvecx[j], pvecy[j]);
const int nstat = fputs(snumber, tmpfd);
cpl_free(snumber);
if (nstat < 0) break;
}
if (fclose(tmpfd) != 0) break;
if (j != vec_size) break;
/* Plot the file using 'plot' the first time,
otherwise use 'replot' */
sval = cpl_sprintf("%splot '%s' %s;\n",
i==0 ? "" : "re", names[i], options[i]);
cpl_mplot_puts(plot, sval);
cpl_free(sval);
}
cpl_mplot_close(plot, post);
for (i=0; i<nbvec; i++) (void) remove(names[i]);
for (i=0; i<nbvec; i++) cpl_free(names[i]);
cpl_free(names);
return cpl_errorstate_is_equal(prestate) ? CPL_ERROR_NONE
: cpl_error_set_where_();
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot a mask
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param mask The mask to plot
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
If the specified plotting command does not contain the string 'gnuplot',
the plotting command is assumed to be able to parse a pgm
(P5) mask from stdin. Valid examples of such a command may include
'cat > myplot$$.pgm' and 'display - &'.
The 'pre' and 'post' commands are ignored in PGM-plots, while the
'options' string is written as a comment in the header of the mask.
See also cpl_plot_vector().
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_mask(const char * pre,
const char * options,
const char * post,
const cpl_mask * mask)
{
const cpl_size nx = cpl_mask_get_size_x(mask);
const cpl_size ny = cpl_mask_get_size_y(mask);
cpl_plot * plot;
const cpl_binary * pmask = cpl_mask_get_data_const(mask);
char * dvi_options = (char *)options;
char * myoptions = (char *)options;
cpl_error_code error = CPL_ERROR_NONE;
cpl_size i, j;
if (nx <= 0) return cpl_error_set_where_();
plot = cpl_image_open(pre);
if (plot == NULL) return cpl_error_set_where_();
if (options == NULL || strlen(options) < 1) {
dvi_options = cpl_sprintf("%" CPL_SIZE_FORMAT "X%" CPL_SIZE_FORMAT
"-mask (%p)", nx, ny, (const void*)mask);
assert( dvi_options != NULL);
}
assert(plot->exe != NULL);
if (strstr(plot->exe, "gnuplot")) {
error |= cpl_mplot_puts(plot, "splot '-' matrix ");
if (myoptions == NULL || strlen(myoptions) < 1) {
myoptions = cpl_sprintf("t '%s';", dvi_options);
assert( myoptions != NULL);
}
error |= cpl_mplot_puts(plot, myoptions);
error |= cpl_mplot_puts(plot, ";\n");
for (j = 0; j < ny; j++) {
for (i = 0; i < nx; i++) {
char * snumber = cpl_sprintf("%d ", pmask[i + j * nx]);
error |= cpl_mplot_puts(plot, snumber);
cpl_free(snumber);
if (error) break;
}
error |= cpl_mplot_puts(plot, "\n");
if (error) break;
}
error |= cpl_mplot_puts(plot, "e\n");
} else {
const size_t bsize = (size_t)(ny * nx); /* Octets in raster */
unsigned char * raster = (unsigned char *)cpl_malloc(bsize);
/* Create a PGM P5 header - with a maxval of 1 */
myoptions = cpl_sprintf("P5\n%" CPL_SIZE_FORMAT " %" CPL_SIZE_FORMAT
"\n", nx, ny);
error |= cpl_mplot_puts(plot, myoptions);
cpl_free(myoptions);
myoptions = cpl_sprintf("# %s\n1\n", dvi_options);
error |= cpl_mplot_puts(plot, myoptions);
for (j = 0; j < ny; j++) for (i = 0; i < nx; i++)
raster[i + (ny-j-1) * nx] = (unsigned char) pmask[i + j * nx];
error |= cpl_mplot_write(plot, (const void *) raster, bsize);
cpl_free(raster);
}
if (dvi_options != options) cpl_free(dvi_options);
if (myoptions != options) cpl_free(myoptions);
error |= cpl_mplot_close(plot, post);
return error ? cpl_error_set_where_() : CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot an image
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param image The image to plot
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
The image must have a positive number of pixels.
@see also @c cpl_image_open().
If the specified plotting command does not contain the string 'gnuplot',
the plotting command is assumed to be able to parse a pgm
(P5) image from stdin. Valid examples of such a command may include
'cat > myplot$$.pgm' and 'display - &'.
The 'pre' and 'post' commands are ignored in PGM-plots, while the
'options' string is written as a comment in the header of the image.
See also cpl_plot_vector().
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_image(const char * pre,
const char * options,
const char * post,
const cpl_image * image)
{
const cpl_size nx = cpl_image_get_size_x(image);
const cpl_size ny = cpl_image_get_size_y(image);
cpl_plot * plot;
cpl_image * temp;
const double * pimage;
unsigned char * raster = NULL;
char * dvi_options = (char *)options;
char * myoptions = (char *)options;
cpl_error_code error = CPL_ERROR_NONE;
cpl_size i, j;
if (nx <= 0) return cpl_error_set_where_();
plot = cpl_image_open(pre);
if (plot == NULL) return cpl_error_set_where_();
if (options == NULL || strlen(options) < 1) {
dvi_options = cpl_sprintf("%" CPL_SIZE_FORMAT "X%" CPL_SIZE_FORMAT
"-image-(%d) (%p)", nx, ny,
(int)cpl_image_get_type(image),
(const void*)image);
assert( dvi_options != NULL);
}
assert(plot->exe != NULL);
if (strstr(plot->exe, "gnuplot")) {
if (cpl_image_get_type(image) == CPL_TYPE_DOUBLE) {
temp = NULL;
pimage = cpl_image_get_data_double_const(image);
} else {
temp = cpl_image_cast(image, CPL_TYPE_DOUBLE);
pimage = cpl_image_get_data_double(temp);
}
error |= cpl_mplot_puts(plot, "splot '-' matrix ");
if (myoptions == NULL || strlen(myoptions) < 1) {
myoptions = cpl_sprintf("t '%s';",
dvi_options);
assert( myoptions != NULL);
}
error |= cpl_mplot_puts(plot, myoptions);
error |= cpl_mplot_puts(plot, ";\n");
for (j = 0; j < ny; j++) {
for (i = 0; i < nx; i++) {
char * snumber = cpl_sprintf("%g ", pimage[j*nx + i]);
error |= cpl_mplot_puts(plot, snumber);
cpl_free(snumber);
if (error) break;
}
error |= cpl_mplot_puts(plot, "\n");
if (error) break;
}
error |= cpl_mplot_puts(plot, "e\n");
} else {
const size_t bsize = (size_t)(ny * nx); /* Octets in raster */
const double tmin = cpl_image_get_min(image);
double tmax;
/* Convert the image to one in the range [0; 256[ */
if (cpl_image_get_type(image) == CPL_TYPE_DOUBLE) {
temp = cpl_image_subtract_scalar_create(image, tmin);
} else {
temp = cpl_image_cast(image, CPL_TYPE_DOUBLE);
error |= cpl_image_subtract_scalar(temp, tmin);
}
tmax = cpl_image_get_max(temp);
if (tmax > 0.0)
error |= cpl_image_multiply_scalar(temp, 256.0*(1.0-DBL_EPSILON)
/tmax);
pimage = cpl_image_get_data_double(temp);
assert(pimage != NULL);
/* Create a PGM P5 header - with a maxval of 255 */
myoptions = cpl_sprintf("P5\n%" CPL_SIZE_FORMAT " %" CPL_SIZE_FORMAT
"\n", nx, ny);
error |= cpl_mplot_puts(plot, myoptions);
cpl_free(myoptions);
myoptions = cpl_sprintf("# True Value Range: [%g;%g]\n",
tmin, tmin+tmax);
assert( myoptions != NULL);
error |= cpl_mplot_puts(plot, myoptions);
cpl_free(myoptions);
myoptions = cpl_sprintf("# %s\n255\n", dvi_options);
error |= cpl_mplot_puts(plot, myoptions);
raster = (unsigned char *)cpl_malloc(bsize);
for (j = 0; j < ny; j++) for (i = 0; i < nx; i++)
raster[(ny-j-1)*nx + i] = (unsigned char) pimage[j*nx + i];
error |= cpl_mplot_write(plot, (const char *) raster, bsize);
}
if (dvi_options != options) cpl_free(dvi_options);
if (myoptions != options) cpl_free(myoptions);
cpl_free(raster);
cpl_image_delete(temp);
error |= cpl_mplot_close(plot, post);
return error ? cpl_error_set_where_() : CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot a range of image rows
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param image The image to plot
@param firstrow The first row to plot (1 for first)
@param lastrow The last row to plot
@param rowstep The positive row stride
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
The image must have a positive number of pixels.
lastrow shall be greater than or equal to firstrow.
@see also @c cpl_mplot_open().
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_ACCESS_OUT_OF_RANGE (firstrow or lastrow are out of range)
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_image_row(const char * pre,
const char * options,
const char * post,
const cpl_image * image,
cpl_size firstrow,
cpl_size lastrow,
cpl_size rowstep)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_size nx, ny;
cpl_ensure_code(image != NULL, CPL_ERROR_NULL_INPUT);
nx = cpl_image_get_size_x(image);
ny = cpl_image_get_size_y(image);
cpl_ensure_code( nx > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code( ny > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code( rowstep > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code( firstrow > 0, CPL_ERROR_ACCESS_OUT_OF_RANGE);
cpl_ensure_code( firstrow <= lastrow, CPL_ERROR_ACCESS_OUT_OF_RANGE);
cpl_ensure_code( lastrow <= ny, CPL_ERROR_ACCESS_OUT_OF_RANGE);
do {
const double * pimage;
cpl_image * temp = NULL;
char * myoptions = NULL;
cpl_size i, j;
cpl_plot * plot = cpl_mplot_open(pre);
do {
if (plot == NULL) break;
if (cpl_mplot_puts(plot, "plot")) break;
for (j = firstrow-1; j < lastrow; j += rowstep) {
const char * useoptions = options;
if (j > firstrow-1 && cpl_mplot_puts(plot, ",")) break;
if (cpl_mplot_puts(plot, " '-' ")) break;
if (useoptions == NULL || strlen(useoptions) < 1) {
cpl_free(myoptions);
myoptions = (j == firstrow-1)
? cpl_sprintf("t 'Row %" CPL_SIZE_FORMAT " %"
CPL_SIZE_FORMAT "X%" CPL_SIZE_FORMAT
"-image-(%d) (%p)'", j, nx, ny,
(int)cpl_image_get_type(image),
(const void*)image)
: cpl_sprintf("t 'Row %" CPL_SIZE_FORMAT
" of the same image'", j);
assert( myoptions != NULL);
useoptions = myoptions;
}
if (cpl_mplot_puts(plot, useoptions)) break;
}
if (cpl_mplot_puts(plot, ";\n ")) break;
if (cpl_image_get_type(image) == CPL_TYPE_DOUBLE) {
pimage = cpl_image_get_data_double_const(image);
} else {
temp = cpl_image_cast(image, CPL_TYPE_DOUBLE);
pimage = cpl_image_get_data_double_const(temp);
}
assert(pimage != NULL);
for (j = firstrow-1; j < lastrow; j += rowstep) {
for (i = 0; i < nx; i++) {
char * snumber = cpl_sprintf("%g\n", pimage[j * nx + i]);
const int nstat = cpl_mplot_puts(plot, snumber);
cpl_free(snumber);
if (nstat) break;
}
if (i != nx) break;
if (cpl_mplot_puts(plot, "e\n")) break;
}
if (j != lastrow) break;
} while (0);
cpl_free(myoptions);
cpl_image_delete(temp);
cpl_mplot_close(plot, post);
} while (0);
return cpl_errorstate_is_equal(prestate) ? CPL_ERROR_NONE
: cpl_error_set_where_();
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot a range of image columns
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param image The image to plot
@param firstcol The first column to plot (1 for first)
@param lastcol The last column to plot
@param colstep The positive column stride
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
The image must have a positive number of pixels.
lastcol shall be greater than or equal to firstcol.
@see also @c cpl_mplot_open().
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_ACCESS_OUT_OF_RANGE (firstcol or lastcol are out of range)
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_image_col(const char * pre,
const char * options,
const char * post,
const cpl_image * image,
cpl_size firstcol,
cpl_size lastcol,
cpl_size colstep)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_size nx, ny;
cpl_ensure_code(image != NULL, CPL_ERROR_NULL_INPUT);
nx = cpl_image_get_size_x(image);
ny = cpl_image_get_size_y(image);
cpl_ensure_code( nx > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code( ny > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code( colstep > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code( firstcol > 0, CPL_ERROR_ACCESS_OUT_OF_RANGE);
cpl_ensure_code( firstcol <= lastcol, CPL_ERROR_ACCESS_OUT_OF_RANGE);
cpl_ensure_code( lastcol <= nx, CPL_ERROR_ACCESS_OUT_OF_RANGE);
do {
const double * pimage;
cpl_image * temp = NULL;
char * myoptions = NULL;
cpl_size i, j;
cpl_plot * plot = cpl_mplot_open(pre);
do {
if (cpl_error_get_code()) break;
if (cpl_mplot_puts(plot, "plot")) break;
for (i = firstcol-1; i < lastcol; i += colstep) {
const char * useoptions = options;
if (i > firstcol-1 && cpl_mplot_puts(plot, ",")) break;
if (cpl_mplot_puts(plot, " '-' ")) break;
if (useoptions == NULL || strlen(useoptions) < 1) {
cpl_free(myoptions);
myoptions = (i == firstcol-1)
? cpl_sprintf("t 'Column %" CPL_SIZE_FORMAT " of a "
"%" CPL_SIZE_FORMAT "X%" CPL_SIZE_FORMAT
"-image-(%d) (%p) ", i, nx, ny,
(int)cpl_image_get_type(image),
(const void*)image)
: cpl_sprintf("t 'Column %" CPL_SIZE_FORMAT " of the "
"same image'", i);
assert( myoptions != NULL);
useoptions = myoptions;
}
if (cpl_mplot_puts(plot, useoptions )) break;
}
if (cpl_mplot_puts(plot, ";\n ")) break;
if (cpl_image_get_type(image) == CPL_TYPE_DOUBLE) {
pimage = cpl_image_get_data_double_const(image);
} else {
temp = cpl_image_cast(image, CPL_TYPE_DOUBLE);
pimage = cpl_image_get_data_double_const(temp);
}
for (i = firstcol-1; i < lastcol; i += colstep) {
for (j = 0; j < ny; j++) {
char * snumber = cpl_sprintf("%g\n", pimage[j * nx + i]);
const int nstat = cpl_mplot_puts(plot, snumber);
cpl_free(snumber);
if (nstat) break;
}
if (j != ny) break;
if (cpl_mplot_puts(plot, "e\n")) break;
}
if (i != lastcol) break;
} while (0);
cpl_free(myoptions);
cpl_image_delete(temp);
cpl_mplot_close(plot, post);
} while (0);
return cpl_errorstate_is_equal(prestate) ? CPL_ERROR_NONE
: cpl_error_set_where_();
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot a column of a table
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param tab The table to plot
@param xlab The label of the column used in x
@param ylab The label of the column used in y
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
@see also @c cpl_mplot_open().
If xlab is NULL, the sequence number is used for X.
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_DATA_NOT_FOUND
- CPL_ERROR_INVALID_TYPE
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_column(
const char * pre,
const char * options,
const char * post,
const cpl_table * tab,
const char * xlab,
const char * ylab)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_size n;
cpl_table * tempx;
cpl_table * tempy;
cpl_bivector * bivect;
cpl_vector * xvec;
cpl_vector * yvec;
cpl_type type_x;
cpl_type type_y;
cpl_size invalid_x;
cpl_size invalid_y;
/* Check input */
cpl_ensure_code(tab, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(ylab, CPL_ERROR_NULL_INPUT);
n = cpl_table_get_nrow(tab);
cpl_ensure_code(n>0, CPL_ERROR_ILLEGAL_INPUT);
if (xlab)
cpl_ensure_code(cpl_table_has_column(tab, xlab),
CPL_ERROR_DATA_NOT_FOUND);
cpl_ensure_code(cpl_table_has_column(tab, ylab), CPL_ERROR_DATA_NOT_FOUND);
if (xlab != NULL) {
invalid_x = cpl_table_count_invalid(tab, xlab);
type_x = cpl_table_get_column_type(tab, xlab);
} else {
invalid_x = 0;
type_x = CPL_TYPE_DOUBLE;
}
invalid_y = cpl_table_count_invalid(tab, ylab);
type_y = cpl_table_get_column_type(tab, ylab);
cpl_ensure_code(type_x == CPL_TYPE_INT ||
type_x == CPL_TYPE_FLOAT ||
type_x == CPL_TYPE_DOUBLE, CPL_ERROR_INVALID_TYPE);
cpl_ensure_code(type_y == CPL_TYPE_INT ||
type_y == CPL_TYPE_FLOAT ||
type_y == CPL_TYPE_DOUBLE, CPL_ERROR_INVALID_TYPE);
cpl_ensure_code(invalid_x < n && invalid_y < n, CPL_ERROR_DATA_NOT_FOUND);
/* Cast columns to CPL_TYPE_DOUBLE and remove invalid entries */
if (type_y != CPL_TYPE_DOUBLE || invalid_y > 0) {
tempy = cpl_table_new(n);
cpl_table_duplicate_column(tempy, "Y", tab, ylab);
cpl_table_cast_column(tempy, "Y", "Ydouble", CPL_TYPE_DOUBLE);
/* Remove rows with one or more invalid elements.
No columns will be removed because each column
contains at least one valid element. */
cpl_table_erase_invalid(tempy);
yvec = cpl_vector_wrap(cpl_table_get_nrow(tempy),
cpl_table_get_data_double(tempy, "Ydouble"));
}
else
{
tempy = NULL;
CPL_DIAG_PRAGMA_PUSH_IGN(-Wcast-qual);
yvec = cpl_vector_wrap(n,
(double*)cpl_table_get_data_double_const(tab,
ylab));
CPL_DIAG_PRAGMA_POP;
}
/* Cast columns to CPL_TYPE_DOUBLE and remove invalid entries */
if (type_x != CPL_TYPE_DOUBLE || invalid_x > 0) {
tempx = cpl_table_new(n);
cpl_table_duplicate_column(tempx, "X", tab, xlab);
cpl_table_cast_column(tempx, "X", "Xdouble", CPL_TYPE_DOUBLE);
/* Remove rows with one or more invalid elements.
No columns will be removed because each column
contains at least one valid element. */
cpl_table_erase_invalid(tempx);
xvec = cpl_vector_wrap(cpl_table_get_nrow(tempx),
cpl_table_get_data_double(tempx, "Xdouble"));
}
else
{
tempx = NULL;
if (xlab == NULL) {
cpl_size i;
xvec = cpl_vector_duplicate(yvec);
for (i=0; i<cpl_vector_get_size(xvec); i++) {
cpl_vector_set(xvec, i, (double)i+1);
}
} else {
CPL_DIAG_PRAGMA_PUSH_IGN(-Wcast-qual);
xvec = cpl_vector_wrap(n,(double*)
cpl_table_get_data_double_const(tab, xlab));
CPL_DIAG_PRAGMA_POP;
}
}
bivect = cpl_bivector_wrap_vectors(xvec, yvec);
cpl_plot_bivector(pre, options, post, bivect);
cpl_bivector_unwrap_vectors(bivect);
if (xlab == NULL) cpl_vector_delete(xvec);
else (void)cpl_vector_unwrap(xvec);
cpl_vector_unwrap(yvec);
if (tempx != NULL) cpl_table_delete(tempx);
if (tempy != NULL) cpl_table_delete(tempy);
return cpl_errorstate_is_equal(prestate) ? CPL_ERROR_NONE
: cpl_error_set_where_();
}
/*----------------------------------------------------------------------------*/
/**
@brief Plot severals column of a table
@param pre An optional string with pre-plot commands
@param options An optional string with plotting options
@param post An optional string with post-plot commands
@param tab The table to plot
@param labels The labels of the columns
@param nlabels The number of labels
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
@see also @c cpl_mplot_open().
If xlab is NULL, the sequence number is used for X.
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_ILLEGAL_INPUT
- CPL_ERROR_DATA_NOT_FOUND
- CPL_ERROR_INVALID_TYPE
- CPL_ERROR_UNSUPPORTED_MODE if plotting is unsupported on the specific
run-time system.
*/
/*----------------------------------------------------------------------------*/
cpl_error_code cpl_plot_columns(const char * pre,
const char * options,
const char * post,
const cpl_table * tab,
const char ** labels,
cpl_size nlabels)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_size n;
cpl_table * tempx;
cpl_table * tempy;
cpl_type type_x;
cpl_type type_y;
const double * px;
const double * py;
char ** names;
char * sval;
FILE * tmpfd;
cpl_plot * plot;
cpl_size i, j;
/* Check input */
cpl_ensure_code(tab != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(labels != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(nlabels >= 3, CPL_ERROR_DATA_NOT_FOUND);
for (i = 1; i < nlabels; i++) {
cpl_ensure_code(labels[i] != NULL, CPL_ERROR_NULL_INPUT);
}
/* Initialise */
n = cpl_table_get_nrow(tab);
tempx = cpl_table_new(n);
tempy = cpl_table_new(n);
/* Get the X axis if passed */
if (labels[0] == NULL) px = NULL;
else {
cpl_ensure_code(cpl_table_has_column(tab, labels[0]),
CPL_ERROR_DATA_NOT_FOUND);
type_x = cpl_table_get_column_type(tab, labels[0]);
cpl_ensure_code(type_x == CPL_TYPE_INT || type_x == CPL_TYPE_FLOAT ||
type_x == CPL_TYPE_DOUBLE, CPL_ERROR_INVALID_TYPE);
if (type_x != CPL_TYPE_DOUBLE) {
cpl_table_duplicate_column(tempx, "X", tab, labels[0]);
cpl_table_cast_column(tempx, "X", "Xdouble", CPL_TYPE_DOUBLE);
px = cpl_table_get_data_double_const(tempx, "Xdouble");
} else {
px = cpl_table_get_data_double_const(tab, labels[0]);
}
}
/* Hold the files names */
names = cpl_malloc((size_t)(nlabels-1) * sizeof(char*));
for (i=1; i < nlabels; i++)
names[i-1] = cpl_sprintf("cpl_plot-%" CPL_SIZE_FORMAT, i);
/* Open the plot */
plot = cpl_mplot_open(pre);
/* Loop on the signals to plot */
for (i=1; i<nlabels; i++) {
/* Get the current Y axis */
cpl_ensure_code(cpl_table_has_column(tab, labels[i]),
CPL_ERROR_DATA_NOT_FOUND);
type_y = cpl_table_get_column_type(tab, labels[i]);
if (type_y != CPL_TYPE_INT && type_y != CPL_TYPE_FLOAT &&
type_y != CPL_TYPE_DOUBLE) {
cpl_table_delete(tempx);
cpl_table_delete(tempy);
cpl_mplot_close(plot, post);
for (j=1; j<nlabels; j++) (void) remove(names[j-1]);
for (j=1; j<nlabels; j++) cpl_free(names[j-1]);
cpl_free(names);
return cpl_error_set_(CPL_ERROR_INVALID_TYPE);
}
if (type_y != CPL_TYPE_DOUBLE) {
if (cpl_table_has_column(tempy, "Y"))
cpl_table_erase_column(tempy, "Y");
if (cpl_table_has_column(tempy, "Ydouble"))
cpl_table_erase_column(tempy, "Ydouble");
cpl_table_duplicate_column(tempy, "Y", tab, labels[i]);
cpl_table_cast_column(tempy, "Y", "Ydouble", CPL_TYPE_DOUBLE);
py = cpl_table_get_data_double_const(tempy, "Ydouble");
} else {
py = cpl_table_get_data_double_const(tab, labels[i]);
}
/* Open temporary file for output */
if ((tmpfd=fopen(names[i-1], "w"))==NULL) {
cpl_table_delete(tempx);
cpl_table_delete(tempy);
cpl_mplot_close(plot, post);
for (j=1; j<nlabels; j++) (void) remove(names[j-1]);
for (j=1; j<nlabels; j++) cpl_free(names[j-1]);
cpl_free(names);
return cpl_error_set_(CPL_ERROR_FILE_IO);
}
/* Write data to this file */
for (j=0; j<n; j++) {
char * snumber = cpl_sprintf("%g %g\n",
px == NULL ? (double)(j+1)
: px[j], py[j]);
const int nstat = fputs(snumber, tmpfd);
cpl_free(snumber);
if (nstat < 0) break;
}
if (fclose(tmpfd) != 0) break;
if (j != n) break;
/* Plot the file */
if (i==1) {
/* Plot the first signal */
sval = cpl_sprintf("plot '%s' %s;\n", names[i-1],
options ? options : "");
} else {
sval = cpl_sprintf("replot '%s' t 'Column %" CPL_SIZE_FORMAT
"' w lines;\n", names[i-1], i);
}
cpl_mplot_puts(plot, sval);
cpl_free(sval);
}
cpl_mplot_close(plot, post);
for (i=1; i<nlabels; i++) (void) remove(names[i-1]);
for (i=1; i<nlabels; i++) cpl_free(names[i-1]);
cpl_free(names);
cpl_table_delete(tempx);
cpl_table_delete(tempy);
return cpl_errorstate_is_equal(prestate) ? CPL_ERROR_NONE
: cpl_error_set_where_();
}
/**@}*/
/*----------------------------------------------------------------------------*/
/**
@brief Get the name of the plotting device
@return A string with the name of the plotting device
The plotting device is set to either getenv("CPL_PLOTTER") or
"gnuplot -persist".
*/
/*----------------------------------------------------------------------------*/
static const char * cpl_mplot_plotter(void)
{
return getenv("CPL_PLOTTER") ? getenv("CPL_PLOTTER")
: "gnuplot -persist";
}
/*----------------------------------------------------------------------------*/
/**
@brief Get the name of the imaging device
@return A string with the name of the imaging device
@see cpl_mplot_plotter()
The imaging device is set to either getenv("CPL_IMAGER") or
cpl_mplot_plotter().
Examples of useful settings include
'display - &'
*/
/*----------------------------------------------------------------------------*/
static const char * cpl_mplot_imager(void)
{
return getenv("CPL_IMAGER") ? getenv("CPL_IMAGER")
: cpl_mplot_plotter();
}
/*----------------------------------------------------------------------------*/
/**
@brief Open a plotting device
@param options An optional string to be sent to the plotter
@return A handle to the plotter or NULL on error
@note This function fails if the real User ID unequals the effective UID.
The plot is constructed by generating a file "cpl_plot.txt" which is a
gnuplot script. This script is sent to the specified command using the call
system("exec <cpl_plot.txt [plotter]").
The command to execute
can be controlled with the environment variable CPL_PLOTTER.
If this is not set, 'gnuplot -persist' is used. In this case gnuplot
must be in the path of the process.
The plotting command must be able to parse gnuplot syntax on its stdin.
Valid examples of such a command may include 'cat > myplot$$.gp' and
'/usr/bin/gnuplot -persist 2> /dev/null'
Consult your local documentation for the security caveats regarding
the above usage of system().
gnuplot is supported as plotting device. This means that if CPL_PLOTTER
contains the string gnuplot it is assumed to correctly parse gnuplot syntax
from stdin. Examples:
perl ./my_gnuplot.pl
/usr/bin/gnuplot -persist
exec /usr/bin/gnuplot -persist > /dev/null 2>&1
With a properly set CPL_PLOTTER, such a process is created and the
options if any are sent to the plotter.
When this function returns non-NULL cpl_mplot_close() must be called.
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
- CPL_ERROR_UNSUPPORTED_MODE
*/
/*----------------------------------------------------------------------------*/
static cpl_plot * cpl_mplot_open(const char * options)
{
cpl_plot * plot;
const char * exe = cpl_mplot_plotter();
const char * tmp = CPL_PLOT_TMPFILE;
FILE * data;
cpl_ensure(exe != NULL, CPL_ERROR_NULL_INPUT, NULL);
cpl_error_ensure(strstr(exe, "gnuplot"), CPL_ERROR_UNSUPPORTED_MODE,
return NULL, "%s", exe);
data = fopen(tmp, "w");
cpl_error_ensure(data != NULL, CPL_ERROR_FILE_IO, return NULL,
"%s", tmp);
plot = cpl_malloc(sizeof(cpl_plot));
plot->exe = exe;
plot->tmp = tmp;
plot->data = data;
if (cpl_mplot_puts(plot, options)) {
(void)cpl_mplot_close(plot, "");
plot = NULL;
(void)cpl_error_set_where_();
}
return plot;
}
/*----------------------------------------------------------------------------*/
/**
@brief Open an imaging device
@param options An optional string to be sent to the imager
@return A handle to the imager or NULL on error
gnuplot is supported as imaging device. This means that if CPL_IMAGER
contains the string gnuplot it is assumed to correctly parse gnuplot syntax
from stdin. Examples:
perl ./my_gnuplot.pl
/usr/bin/gnuplot -persist
exec /usr/bin/gnuplot -persist > /dev/null 2>&1
imagers that can parse a pgm (P5) image, f.ex. display are also supported.
The plot is constructed by generating a file "cpl_plot.txt" which is a
gnuplot script or a pgm image. This script is sent to the specified command
using the call system("exec <cpl_plot.txt [imager]").
With a properly set CPL_IMAGER, such a process is created and the
options if any are sent to the plotter.
When this function returns non-NULL cpl_mplot_close() must be called.
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_FILE_IO
*/
/*----------------------------------------------------------------------------*/
static cpl_plot * cpl_image_open(const char * options)
{
cpl_plot * plot;
const char * exe = cpl_mplot_imager();
const char * tmp = CPL_PLOT_TMPFILE;
FILE * data;
cpl_ensure(exe != NULL, CPL_ERROR_NULL_INPUT, NULL);
data = fopen(tmp, "w");
cpl_error_ensure(data != NULL, CPL_ERROR_FILE_IO, return NULL,
"%s", tmp);
plot = cpl_malloc(sizeof(cpl_plot));
plot->exe = exe;
plot->tmp = tmp;
plot->data = data;
if (cpl_mplot_puts(plot, options)) {
(void)cpl_mplot_close(plot, "");
plot = NULL;
(void)cpl_error_set_where_();
}
return plot;
}
/*----------------------------------------------------------------------------*/
/**
@brief Close the plotting device and deallocate its resources
@param plot Pointer to the plotting device
@param options An optional string to be sent to the plotter
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_FILE_IO
*/
/*----------------------------------------------------------------------------*/
static cpl_error_code cpl_mplot_close(cpl_plot * plot,
const char * options)
{
cpl_error_code error;
cpl_ensure_code(plot != NULL, CPL_ERROR_NULL_INPUT);
error = cpl_mplot_puts(plot, options);
cpl_error_set_where_();
assert(plot->data != NULL);
assert(plot->tmp != NULL);
assert(plot->exe != NULL);
if (fclose(plot->data) != 0) error = cpl_error_set_(CPL_ERROR_FILE_IO);
if (!error) {
/* Note: The portability of this plotting module is limited by the
portability of the following command (which is likely to be valid on
any kind of UNIX platform). We use 'exec' to reduce the number of
child processes created. */
char * command = cpl_sprintf("exec <%s %s", plot->tmp, plot->exe);
const int nstat = system(command);
if (nstat != 0) error =
cpl_error_set_message_(CPL_ERROR_FILE_IO, "system('%s') returned "
"%d", command ? command : "<NULL>", nstat);
cpl_free(command);
}
(void) remove(plot->tmp);
cpl_free(plot);
return error ? error : CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Send a text string to the plotting device
@param plot Pointer to the plotting device
@param cmd A string to be sent to the plotter
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_FILE_IO
*/
/*----------------------------------------------------------------------------*/
static cpl_error_code cpl_mplot_puts(cpl_plot * plot, const char * cmd)
{
if (cmd == NULL || strlen(cmd) == 0) return CPL_ERROR_NONE;
cpl_ensure_code(plot != NULL, CPL_ERROR_NULL_INPUT);
assert(plot->data != NULL);
cpl_ensure_code(fputs(cmd, plot->data) >= 0, CPL_ERROR_FILE_IO);
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Send n octets of data to the plotting device
@param plot Pointer to the plotting device
@param buffer Pointer to the data to be sent to the plotter
@param length Number of octets to send
@return CPL_ERROR_NONE or the relevant CPL_ERROR_# on error
Possible _cpl_error_code_ set in this function:
- CPL_ERROR_NULL_INPUT
- CPL_ERROR_FILE_IO
- CPL_ERROR_ILLEGAL_INPUT
*/
/*----------------------------------------------------------------------------*/
static cpl_error_code cpl_mplot_write(cpl_plot * plot,
const char * buffer,
size_t length)
{
cpl_ensure_code(plot != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(buffer != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(length > 0, CPL_ERROR_ILLEGAL_INPUT);
assert(plot->data != NULL);
cpl_ensure_code(fwrite(buffer, 1, length, plot->data) == length,
CPL_ERROR_FILE_IO);
return CPL_ERROR_NONE;
}
|