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 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680
|
/* $Id: irplib_utils.c,v 1.85 2013-07-04 12:10:55 jtaylor Exp $
*
* This file is part of the irplib package
* Copyright (C) 2002,2003 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 02111-1307 USA
*/
/*
* $Author: jtaylor $
* $Date: 2013-07-04 12:10:55 $
* $Revision: 1.85 $
* $Name: not supported by cvs2svn $
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
/*-----------------------------------------------------------------------------
Includes
-----------------------------------------------------------------------------*/
#include "irplib_utils.h"
#include <cpl.h>
#include <math.h>
#include <string.h>
#include <assert.h>
#include <stdlib.h>
#include <errno.h>
/*-----------------------------------------------------------------------------
Defines
-----------------------------------------------------------------------------*/
/* TEMPORARY SUPPORT OF CPL 5.x */
#ifndef CPL_SIZE_FORMAT
#define CPL_SIZE_FORMAT "d"
#define cpl_size int
#endif
/* END TEMPORARY SUPPORT OF CPL 5.x */
#ifndef inline
#define inline /* inline */
#endif
/*-----------------------------------------------------------------------------
Missing Function Prototypes
-----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------
Private Function Prototypes
-----------------------------------------------------------------------------*/
inline static double irplib_data_get_double(const void *, cpl_type, int)
#ifdef CPL_HAVE_GNUC_NONNULL
__attribute__((nonnull))
#endif
;
inline static void irplib_data_set_double(void *, cpl_type, int, double)
#ifdef CPL_HAVE_GNUC_NONNULL
__attribute__((nonnull))
#endif
;
static
void irplib_errorstate_dump_one_level(void (*)(const char *,
const char *, ...)
#ifdef __GNUC__
__attribute__((format (printf, 2, 3)))
#endif
, unsigned, unsigned, unsigned);
static double frame_get_exptime(const cpl_frame * pframe);
static void quicksort(int* index, double* exptime, int left, int right);
static cpl_error_code irplib_dfs_product_save(cpl_frameset *,
cpl_propertylist *,
const cpl_parameterlist *,
const cpl_frameset *,
const cpl_frame *,
const cpl_imagelist *,
const cpl_image *,
cpl_type,
const cpl_table *,
const cpl_propertylist *,
const char *,
const cpl_propertylist *,
const char *,
const char *,
const char *);
/*----------------------------------------------------------------------------*/
/**
* @defgroup irplib_utils Miscellaneous Utilities
*/
/*----------------------------------------------------------------------------*/
/**@{*/
/*----------------------------------------------------------------------------*/
/**
@brief Dump a single CPL error at the CPL warning level
@param self The number of the current error to be dumped
@param first The number of the first error to be dumped
@param last The number of the last error to be dumped
@return void
@see cpl_errorstate_dump_one
FIXME: Move this function to the CPL errorstate module.
*/
/*----------------------------------------------------------------------------*/
void irplib_errorstate_dump_warning(unsigned self, unsigned first,
unsigned last)
{
irplib_errorstate_dump_one_level(&cpl_msg_warning, self, first, last);
}
static cpl_polynomial * irplib_polynomial_fit_1d_create_common(
const cpl_vector * x_pos,
const cpl_vector * values,
int degree,
double * mse,
double * rechisq
);
/*----------------------------------------------------------------------------*/
/**
@brief Dump a single CPL error at the CPL info level
@param self The number of the current error to be dumped
@param first The number of the first error to be dumped
@param last The number of the last error to be dumped
@return void
@see cpl_errorstate_dump_one
*/
/*----------------------------------------------------------------------------*/
void irplib_errorstate_dump_info(unsigned self, unsigned first,
unsigned last)
{
irplib_errorstate_dump_one_level(&cpl_msg_info, self, first, last);
}
/*----------------------------------------------------------------------------*/
/**
@brief Dump a single CPL error at the CPL debug level
@param self The number of the current error to be dumped
@param first The number of the first error to be dumped
@param last The number of the last error to be dumped
@return void
@see cpl_errorstate_dump_one
*/
/*----------------------------------------------------------------------------*/
void irplib_errorstate_dump_debug(unsigned self, unsigned first,
unsigned last)
{
irplib_errorstate_dump_one_level(&cpl_msg_debug, self, first, last);
}
/*----------------------------------------------------------------------------*/
/**
@brief Save an image as a DFS-compliant pipeline product
@param allframes The list of input frames for the recipe
@param parlist The list of input parameters
@param usedframes The list of raw/calibration frames used for this product
@param image The image to be saved
@param bpp Bits per pixel
@param recipe The recipe name
@param procat The product category tag
@param applist Optional propertylist to append to primary header or NULL
@param remregexp Optional regexp of properties not to put in main header
@param pipe_id PACKAGE "/" PACKAGE_VERSION
@param filename Filename of created product
@note The image may be NULL in which case only the header information is saved
but passing a NULL image is deprecated, use cpl_dfs_save_propertylist().
@note remregexp may be NULL
@return CPL_ERROR_NONE or the relevant CPL error code on error
@see cpl_dfs_save_image().
*/
/*----------------------------------------------------------------------------*/
cpl_error_code irplib_dfs_save_image(cpl_frameset * allframes,
const cpl_parameterlist * parlist,
const cpl_frameset * usedframes,
const cpl_image * image,
cpl_type_bpp bpp,
const char * recipe,
const char * procat,
const cpl_propertylist * applist,
const char * remregexp,
const char * pipe_id,
const char * filename)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_propertylist * prolist = applist ? cpl_propertylist_duplicate(applist)
: cpl_propertylist_new();
cpl_propertylist_update_string(prolist, CPL_DFS_PRO_CATG, procat);
irplib_dfs_save_image_(allframes, NULL, parlist, usedframes, NULL, image,
bpp, recipe, prolist, remregexp, pipe_id, filename);
cpl_propertylist_delete(prolist);
cpl_ensure_code(cpl_errorstate_is_equal(prestate), cpl_error_get_code());
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Save a propertylist as a DFS-compliant pipeline product
@param allframes The list of input frames for the recipe
@param parlist The list of input parameters
@param usedframes The list of raw/calibration frames used for this product
@param recipe The recipe name
@param procat The product category tag
@param applist Optional propertylist to append to primary header or NULL
@param remregexp Optional regexp of properties not to put in main header
@param pipe_id PACKAGE "/" PACKAGE_VERSION
@param filename Filename of created product
@note remregexp may be NULL
@return CPL_ERROR_NONE or the relevant CPL error code on error
@see cpl_dfs_save_propertylist().
*/
/*----------------------------------------------------------------------------*/
cpl_error_code
irplib_dfs_save_propertylist(cpl_frameset * allframes,
const cpl_parameterlist * parlist,
const cpl_frameset * usedframes,
const char * recipe,
const char * procat,
const cpl_propertylist * applist,
const char * remregexp,
const char * pipe_id,
const char * filename)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_propertylist * prolist = applist ? cpl_propertylist_duplicate(applist)
: cpl_propertylist_new();
cpl_propertylist_update_string(prolist, CPL_DFS_PRO_CATG, procat);
cpl_dfs_save_propertylist(allframes, NULL, parlist, usedframes, NULL,
recipe, prolist, remregexp, pipe_id, filename);
cpl_propertylist_delete(prolist);
cpl_ensure_code(cpl_errorstate_is_equal(prestate), cpl_error_get_code());
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Save an imagelist as a DFS-compliant pipeline product
@param allframes The list of input frames for the recipe
@param parlist The list of input parameters
@param usedframes The list of raw/calibration frames used for this product
@param imagelist The imagelist to be saved
@param bpp Bits per pixel
@param recipe The recipe name
@param procat The product category tag
@param applist Optional propertylist to append to primary header or NULL
@param remregexp Optional regexp of properties not to put in main header
@param pipe_id PACKAGE "/" PACKAGE_VERSION
@param filename Filename of created product
@note remregexp may be NULL
@return CPL_ERROR_NONE or the relevant CPL error code on error
@see cpl_dfs_save_imagelist().
*/
/*----------------------------------------------------------------------------*/
cpl_error_code irplib_dfs_save_imagelist(cpl_frameset * allframes,
const cpl_parameterlist * parlist,
const cpl_frameset * usedframes,
const cpl_imagelist * imagelist,
cpl_type_bpp bpp,
const char * recipe,
const char * procat,
const cpl_propertylist * applist,
const char * remregexp,
const char * pipe_id,
const char * filename)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_propertylist * prolist = applist ? cpl_propertylist_duplicate(applist)
: cpl_propertylist_new();
cpl_propertylist_update_string(prolist, CPL_DFS_PRO_CATG, procat);
cpl_dfs_save_imagelist(allframes, NULL, parlist, usedframes, NULL,
imagelist, bpp, recipe, prolist, remregexp, pipe_id,
filename);
cpl_propertylist_delete(prolist);
cpl_ensure_code(cpl_errorstate_is_equal(prestate), cpl_error_get_code());
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Save a table as a DFS-compliant pipeline product
@param allframes The list of input frames for the recipe
@param parlist The list of input parameters
@param usedframes The list of raw/calibration frames used for this product
@param table The table to be saved
@param tablelist Optional propertylist to use in table extension or NULL
@param recipe The recipe name
@param procat The product category tag
@param applist Optional propertylist to append to primary header or NULL
@param remregexp Optional regexp of properties not to put in main header
@param pipe_id PACKAGE "/" PACKAGE_VERSION
@param filename Filename of created product
@return CPL_ERROR_NONE or the relevant CPL error code on error
@see cpl_dfs_save_table().
*/
/*----------------------------------------------------------------------------*/
cpl_error_code irplib_dfs_save_table(cpl_frameset * allframes,
const cpl_parameterlist * parlist,
const cpl_frameset * usedframes,
const cpl_table * table,
const cpl_propertylist * tablelist,
const char * recipe,
const char * procat,
const cpl_propertylist * applist,
const char * remregexp,
const char * pipe_id,
const char * filename)
{
cpl_errorstate prestate = cpl_errorstate_get();
cpl_propertylist * prolist = applist ? cpl_propertylist_duplicate(applist)
: cpl_propertylist_new();
cpl_propertylist_update_string(prolist, CPL_DFS_PRO_CATG, procat);
cpl_dfs_save_table(allframes, NULL, parlist, usedframes, NULL,
table, tablelist, recipe, prolist, remregexp,
pipe_id, filename);
cpl_propertylist_delete(prolist);
cpl_ensure_code(cpl_errorstate_is_equal(prestate), cpl_error_get_code());
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Save an image as a DFS-compliant pipeline product
@param allframes The list of input frames for the recipe
@param header NULL, or filled with properties written to product header
@param parlist The list of input parameters
@param usedframes The list of raw/calibration frames used for this product
@param inherit NULL or product frames inherit their header from this frame
@param image The image to be saved
@param type The type used to represent the data in the file
@param recipe The recipe name
@param applist Propertylist to append to primary header, w. PRO.CATG
@param remregexp Optional regexp of properties not to put in main header
@param pipe_id PACKAGE "/" PACKAGE_VERSION
@param filename Filename of created product
@note The image may be NULL in which case only the header information is saved
but passing a NULL image is deprecated, use cpl_dfs_save_propertylist().
@note remregexp may be NULL
@note applist must contain a string-property with key CPL_DFS_PRO_CATG
@note On success and iff header is non-NULL, it will be emptied and then
filled with the properties written to the primary header of the product
@return CPL_ERROR_NONE or the relevant CPL error code on error
@see cpl_dfs_save_image()
@note applist is copied with cpl_propertylist_copy_property_regexp() instead
pf cpl_propertylist_append()
*/
/*----------------------------------------------------------------------------*/
cpl_error_code irplib_dfs_save_image_(cpl_frameset * allframes,
cpl_propertylist * header,
const cpl_parameterlist * parlist,
const cpl_frameset * usedframes,
const cpl_frame * inherit,
const cpl_image * image,
cpl_type type,
const char * recipe,
const cpl_propertylist * applist,
const char * remregexp,
const char * pipe_id,
const char * filename)
{
return
irplib_dfs_product_save(allframes, header, parlist, usedframes, inherit,
NULL, image, type, NULL, NULL, recipe,
applist, remregexp, pipe_id, filename)
? cpl_error_set_where(cpl_func) : CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Save either an image or table as a pipeline product
@param allframes The list of input frames for the recipe
@param header NULL, or filled with properties written to product header
@param parlist The list of input parameters
@param usedframes The list of raw/calibration frames used for this product
@param inherit NULL, or frame from which header information is inherited
@param imagelist The imagelist to be saved or NULL
@param image The image to be saved or NULL
@param type The type used to represent the data in the file
@param table The table to be saved or NULL
@param tablelist Optional propertylist to use in table extension or NULL
@param recipe The recipe name
@param applist Optional propertylist to append to main header or NULL
@param remregexp Optional regexp of properties not to put in main header
@param pipe_id PACKAGE "/" PACKAGE_VERSION
@param filename Filename of created product
@return CPL_ERROR_NONE or the relevant CPL error code on error
@see cpl_dfs_product_save()
@note applist is copied with cpl_propertylist_copy_property_regexp() instead
pf cpl_propertylist_append()
*/
/*----------------------------------------------------------------------------*/
static
cpl_error_code irplib_dfs_product_save(cpl_frameset * allframes,
cpl_propertylist * header,
const cpl_parameterlist * parlist,
const cpl_frameset * usedframes,
const cpl_frame * inherit,
const cpl_imagelist * imagelist,
const cpl_image * image,
cpl_type type,
const cpl_table * table,
const cpl_propertylist * tablelist,
const char * recipe,
const cpl_propertylist * applist,
const char * remregexp,
const char * pipe_id,
const char * filename) {
const char * procat;
cpl_propertylist * plist;
cpl_frame * product_frame;
/* Inside this function the product-types are numbered:
0: imagelist
1: table
2: image
3: propertylist only
*/
const unsigned pronum
= imagelist != NULL ? 0 : table != NULL ? 1 : (image != NULL ? 2 : 3);
const char * proname[] = {"imagelist", "table", "image",
"propertylist"};
/* FIXME: Define a frame type for an imagelist and when data-less */
const int protype[] = {CPL_FRAME_TYPE_ANY, CPL_FRAME_TYPE_TABLE,
CPL_FRAME_TYPE_IMAGE, CPL_FRAME_TYPE_ANY};
cpl_error_code error = CPL_ERROR_NONE;
/* No more than one of imagelist, table and image may be non-NULL */
/* tablelist may only be non-NULL when table is non-NULL */
if (imagelist != NULL) {
assert(pronum == 0);
assert(image == NULL);
assert(table == NULL);
assert(tablelist == NULL);
} else if (table != NULL) {
assert(pronum == 1);
assert(imagelist == NULL);
assert(image == NULL);
} else if (image != NULL) {
assert(pronum == 2);
assert(imagelist == NULL);
assert(table == NULL);
assert(tablelist == NULL);
} else {
assert(pronum == 3);
assert(imagelist == NULL);
assert(table == NULL);
assert(tablelist == NULL);
assert(image == NULL);
}
cpl_ensure_code(allframes != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(parlist != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(usedframes != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(recipe != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(applist != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(pipe_id != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(filename != NULL, CPL_ERROR_NULL_INPUT);
procat = cpl_propertylist_get_string(applist, CPL_DFS_PRO_CATG);
cpl_ensure_code(procat != NULL, cpl_error_get_code());
cpl_msg_info(cpl_func, "Writing FITS %s product(%s): %s", proname[pronum],
procat, filename);
product_frame = cpl_frame_new();
/* Create product frame */
error |= cpl_frame_set_filename(product_frame, filename);
error |= cpl_frame_set_tag(product_frame, procat);
error |= cpl_frame_set_type(product_frame, protype[pronum]);
error |= cpl_frame_set_group(product_frame, CPL_FRAME_GROUP_PRODUCT);
error |= cpl_frame_set_level(product_frame, CPL_FRAME_LEVEL_FINAL);
if (error) {
cpl_frame_delete(product_frame);
return cpl_error_set_where(cpl_func);
}
if (header != NULL) {
cpl_propertylist_empty(header);
plist = header;
} else {
plist = cpl_propertylist_new();
}
/* Add any QC parameters here */
if (applist != NULL) error = cpl_propertylist_copy_property_regexp(plist,
applist,
".", 0);
/* Add DataFlow keywords */
if (!error)
error = cpl_dfs_setup_product_header(plist, product_frame, usedframes,
parlist, recipe, pipe_id,
"PRO-1.15", inherit);
if (remregexp != NULL && !error) {
cpl_errorstate prestate = cpl_errorstate_get();
(void)cpl_propertylist_erase_regexp(plist, remregexp, 0);
if (!cpl_errorstate_is_equal(prestate)) error = cpl_error_get_code();
}
if (!error) {
switch (pronum) {
case 0:
error = cpl_imagelist_save(imagelist, filename, type, plist,
CPL_IO_CREATE);
break;
case 1:
error = cpl_table_save(table, plist, tablelist, filename,
CPL_IO_CREATE);
break;
case 2:
error = cpl_image_save(image, filename, type, plist,
CPL_IO_CREATE);
break;
default:
/* case 3: */
error = cpl_propertylist_save(plist, filename, CPL_IO_CREATE);
}
}
if (!error) {
/* Insert the frame of the saved file in the input frameset */
error = cpl_frameset_insert(allframes, product_frame);
} else {
cpl_frame_delete(product_frame);
}
if (plist != header) cpl_propertylist_delete(plist);
cpl_ensure_code(!error, error);
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Split the values in an image in three according to two thresholds
@param self The image to split
@param im_low If non-NULL low-valued pixels are assigned to this image
@param im_mid If non-NULL middle-valued pixels are assigned to this image
@param im_high If non-NULL high-valued pixels are assigned to this image
@param th_low The lower threshold
@param isleq_low Ift true use less than or equal
@param th_high The upper threshold, must be at least th_low
@param isgeq_high Iff true use greater than or equal
@param alt_low Assign this value when the pixel value is not low
@param alt_high Assign this value, when the pixel value is not high
@param isbad_low Flag non-low pixels as bad
@param isbad_mid Flag non-mid pixels as bad
@param isbad_high Flag non-high pixels as bad
@return CPL_ERROR_NONE or the relevant CPL error code on error
@note At least one output image must be non-NULL; all non-NULL images must
be of identical size, but may be of any pixel-type.
self may be passed as one of the output images for an in-place split.
FIXME: This function is way too slow and perhaps over-engineered...
A split in two is achieved with th_low equal th_high (in this case there
is little reason for im_mid to be non-NULL).
All pixel values in the output images are reset,
as well as their bad pixels maps.
If an input pixel-value is flagged as bad, then the receiving pixel in the
output image is flagged as well.
@par The same image may be passed more than once which allows a split
into one image with the mid-valued pixels and another with both the
low and high-valued pixels, i.e.
@code
irplib_image_split(source, dest, im_mid, dest,
th_low, isleq_low, th_high, isgeq_high,
alt_low, alt_high,
isbad_low, isbad_mid, isbad_high);
@endcode
@par These two calls are equivalent:
@code
cpl_image_threshold(img, th_low, th_high, alt_low, alt_high);
@endcode
@code
irplib_image_split(img, NULL, img, NULL,
th_low, CPL_TRUE, th_high, CPL_TRUE,
alt_low, alt_high, dontcare, CPL_FALSE, dontcare);
@endcode
*/
/*----------------------------------------------------------------------------*/
cpl_error_code irplib_image_split(const cpl_image * self,
cpl_image * im_low,
cpl_image * im_mid,
cpl_image * im_high,
double th_low,
cpl_boolean isleq_low,
double th_high,
cpl_boolean isgeq_high,
double alt_low,
double alt_high,
cpl_boolean isbad_low,
cpl_boolean isbad_mid,
cpl_boolean isbad_high)
{
const void * selfdata = cpl_image_get_data_const(self);
/* hasbpm reduces check-overhead if self does not have a bpm, and if
self is also passed as an output image, that ends up with bad pixels */
/* FIXME: Need a proper way to know if a bpm has been allocated :-((((((( */
const cpl_boolean hasbpm
= cpl_image_count_rejected(self) ? CPL_TRUE : CPL_FALSE;
const cpl_binary * selfbpm = hasbpm
? cpl_mask_get_data_const(cpl_image_get_bpm_const(self)) : NULL;
const cpl_type selftype = cpl_image_get_type(self);
const int nx = cpl_image_get_size_x(self);
const int ny = cpl_image_get_size_y(self);
const int npix = nx * ny;
const cpl_boolean do_low = im_low != NULL;
const cpl_boolean do_mid = im_mid != NULL;
const cpl_boolean do_high = im_high != NULL;
void * lowdata = NULL;
void * middata = NULL;
void * highdata = NULL;
cpl_binary * lowbpm = NULL;
cpl_binary * midbpm = NULL;
cpl_binary * highbpm = NULL;
const cpl_type lowtype
= do_low ? cpl_image_get_type(im_low) : CPL_TYPE_INVALID;
const cpl_type midtype
= do_mid ? cpl_image_get_type(im_mid) : CPL_TYPE_INVALID;
const cpl_type hightype
= do_high ? cpl_image_get_type(im_high) : CPL_TYPE_INVALID;
int i;
cpl_ensure_code(self != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(do_low || do_mid || do_high, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(th_low <= th_high, CPL_ERROR_ILLEGAL_INPUT);
if (do_low) {
cpl_ensure_code(cpl_image_get_size_x(im_low) == nx,
CPL_ERROR_INCOMPATIBLE_INPUT);
cpl_ensure_code(cpl_image_get_size_y(im_low) == ny,
CPL_ERROR_INCOMPATIBLE_INPUT);
lowdata = cpl_image_get_data(im_low);
}
if (do_mid) {
cpl_ensure_code(cpl_image_get_size_x(im_mid) == nx,
CPL_ERROR_INCOMPATIBLE_INPUT);
cpl_ensure_code(cpl_image_get_size_y(im_mid) == ny,
CPL_ERROR_INCOMPATIBLE_INPUT);
middata = cpl_image_get_data(im_mid);
}
if (do_high) {
cpl_ensure_code(cpl_image_get_size_x(im_high) == nx,
CPL_ERROR_INCOMPATIBLE_INPUT);
cpl_ensure_code(cpl_image_get_size_y(im_high) == ny,
CPL_ERROR_INCOMPATIBLE_INPUT);
highdata = cpl_image_get_data(im_high);
}
/* From this point a failure would indicate a serious bug in CPL */
for (i = 0; i < npix; i++) {
const double value = irplib_data_get_double(selfdata, selftype, i);
cpl_boolean isalt_low = do_low;
cpl_boolean isalt_mid = do_mid;
cpl_boolean isalt_high = do_high;
cpl_boolean setbad_low = do_low;
cpl_boolean setbad_mid = do_mid;
cpl_boolean setbad_high = do_high;
const void * setdata = NULL;
double alt_mid = 0.0; /* Avoid (false) uninit warning */
if (isleq_low ? value <= th_low : value < th_low) {
if (do_low) {
isalt_low = CPL_FALSE;
irplib_data_set_double(lowdata, lowtype, i, value);
setbad_low = hasbpm && selfbpm[i];
setdata = lowdata;
}
alt_mid = alt_low;
} else if (isgeq_high ? value >= th_high : value > th_high) {
if (do_high) {
isalt_high = CPL_FALSE;
irplib_data_set_double(highdata, hightype, i, value);
setbad_high = hasbpm && selfbpm[i];
setdata = highdata;
}
alt_mid = alt_high;
} else if (do_mid) {
isalt_mid = CPL_FALSE;
irplib_data_set_double(middata, midtype, i, value);
setbad_mid = hasbpm && selfbpm[i];
setdata = middata;
}
if (isalt_low && lowdata != setdata) {
irplib_data_set_double(lowdata, lowtype, i, alt_low);
setbad_low = isbad_low;
}
if (isalt_mid && middata != setdata) {
irplib_data_set_double(middata, midtype, i, alt_mid);
setbad_mid = isbad_mid;
}
if (isalt_high && highdata != setdata) {
irplib_data_set_double(highdata, hightype, i, alt_high);
setbad_high = isbad_high;
}
if (setbad_low) {
if (lowbpm == NULL) lowbpm
= cpl_mask_get_data(cpl_image_get_bpm(im_low));
lowbpm[i] = CPL_BINARY_1;
}
if (setbad_mid) {
if (midbpm == NULL) midbpm
= cpl_mask_get_data(cpl_image_get_bpm(im_mid));
midbpm[i] = CPL_BINARY_1;
}
if (setbad_high) {
if (highbpm == NULL) highbpm
= cpl_mask_get_data(cpl_image_get_bpm(im_high));
highbpm[i] = CPL_BINARY_1;
}
}
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Create a DFS product with one table from one or more (ASCII) file(s)
@param self Table with labels (and units) but no row data
@param allframes The list of input frames for the recipe
@param useframes The frames to process for the product
@param maxlinelen The maximum line length in the input file(s)
@param commentchar Skip lines that start with this character, e.g. '#'
@param product_name The name of the created FITS table product or NULL
@param procatg The PROCATG of the created FITS table product
@param parlist The list of input parameters
@param recipe_name The name of the calling recipe
@param mainlist Optional propertylist to append to main header or NULL
@param extlist Optional propertylist to append to ext. header or NULL
@param remregexp Optional regexp of properties not to put in main header
@param instrume The value to use for the INSTRUME key, uppercase PACKAGE
@param pipe_id PACKAGE "/" PACKAGE_VERSION
@param table_set_row Caller-defined function to insert one row in the table
@param table_check Optional caller-defined function to check table or NULL
@return CPL_ERROR_NONE or the relevant CPL error code on error
@see irplib_table_read_from_frameset(), cpl_dfs_save_table()
@note If product_name is NULL, the product will be named <recipe_name>.fits.
@par Example (error handling omitted for brevity):
@code
extern cpl_boolean my_table_set_row(cpl_table *, const char *, int,
const cpl_frame *,
const cpl_parameterlist *);
extern cpl_error_code my_table_check(cpl_table *,
const cpl_frameset *,
const cpl_parameterlist *);
const int expected_rows = 42;
cpl_table * self = cpl_table_new(expected_rows);
cpl_table_new_column(self, "MYLABEL1", CPL_TYPE_STRING);
cpl_table_new_column(self, "MYLABEL2", CPL_TYPE_DOUBLE);
cpl_table_set_column_unit(self, "MYLABEL2", "Some_SI_Unit");
irplib_dfs_table_convert(self, allframes, useframes, 1024, '#', NULL,
"MYPROCATG", parlist, "myrecipe", NULL, NULL,
NULL, "MYINSTRUME", PACKAGE "/" PACKAGE_VERSION,
my_table_set_row, my_table_check);
cpl_table_delete(self);
@endcode
*/
/*----------------------------------------------------------------------------*/
cpl_error_code
irplib_dfs_table_convert(cpl_table * self,
cpl_frameset * allframes,
const cpl_frameset * useframes,
int maxlinelen,
char commentchar,
const char * product_name,
const char * procatg,
const cpl_parameterlist * parlist,
const char * recipe_name,
const cpl_propertylist * mainlist,
const cpl_propertylist * extlist,
const char * remregexp,
const char * instrume,
const char * pipe_id,
cpl_boolean (*table_set_row)
(cpl_table *, const char *, int,
const cpl_frame *,
const cpl_parameterlist *),
cpl_error_code (*table_check)
(cpl_table *,
const cpl_frameset *,
const cpl_parameterlist *))
{
const char * filename;
cpl_propertylist * applist = NULL;
cpl_errorstate prestate = cpl_errorstate_get();
cpl_error_code error;
char * fallback_filename = NULL;
cpl_ensure_code(self != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(allframes != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(useframes != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(procatg != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(parlist != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(recipe_name != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(instrume != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(pipe_id != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(!irplib_table_read_from_frameset(self, useframes,
maxlinelen,
commentchar,
parlist,
table_set_row),
cpl_error_get_code());
if (table_check != NULL && (table_check(self, useframes, parlist) ||
!cpl_errorstate_is_equal(prestate))) {
return cpl_error_set_message(cpl_func, cpl_error_get_code(),
"Consistency check of table failed");
}
fallback_filename = cpl_sprintf("%s" CPL_DFS_FITS, recipe_name);
filename = product_name != NULL ? product_name : fallback_filename;
applist = mainlist == NULL
? cpl_propertylist_new() : cpl_propertylist_duplicate(mainlist);
error = cpl_propertylist_update_string(applist, "INSTRUME", instrume);
if (!error)
error = irplib_dfs_save_table(allframes, parlist, useframes, self,
extlist, recipe_name, procatg, applist,
remregexp, pipe_id, filename);
cpl_propertylist_delete(applist);
cpl_free(fallback_filename);
/* Propagate the error, if any */
cpl_ensure_code(!error, error);
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Set the rows of a table with data from one or more (ASCII) files
@param self Table with labels (and units) but no row data
@param useframes The frames to process for the table
@param maxlinelen The maximum line length in the input file(s)
@param commentchar Skip lines that start with this character, e.g. '#'
@param parlist The list of input parameters
@param table_set_row Caller-defined function to insert one row in the table
@return CPL_ERROR_NONE or the relevant CPL error code on error
table_set_row() is a function that sets the specified row in a table
- it may optionally include a check of the line for consistency.
An integer is passed to table_set_row() to indicate which row
to set. Instead of setting the row table_set_row() may decide to discard
the data. Iff the row was set, table_set_row() should return CPL_TRUE.
It needs to know:
1) How to parse the lines - each line is read with fgets().
2) For each column: type/format (%lg/%s/%d) + label
During a succesful call self will have rows added or removed to exactly
match the number of lines converted. Any a priori knowledge about the
expected number of converted rows can be used in the creation of the
table (to reduce memory reallocation overhead).
On error the number of rows in self is undefined.
@par Example (error handling omitted for brevity):
@code
extern cpl_boolean my_table_set_row(cpl_table *, const char *, int,
const cpl_frame *,
const cpl_parameterlist *);
const int expected_rows = 42;
cpl_table * self = cpl_table_new(expected_rows);
cpl_table_new_column(self, "MYLABEL1", CPL_TYPE_STRING);
cpl_table_new_column(self, "MYLABEL2", CPL_TYPE_DOUBLE);
cpl_table_set_column_unit(self, "MYLABEL2", "Some_SI_Unit");
irplib_table_read_from_frameset(self, useframes, 1024, '#', parlist,
my_table_set_row);
// Use self...
cpl_table_delete(self);
@endcode
*/
/*----------------------------------------------------------------------------*/
cpl_error_code
irplib_table_read_from_frameset(cpl_table * self,
const cpl_frameset * useframes,
int maxlinelen,
char commentchar,
const cpl_parameterlist * parlist,
cpl_boolean (*table_set_row)
(cpl_table *, const char *, int,
const cpl_frame *,
const cpl_parameterlist *))
{
const cpl_frame * rawframe;
char * linebuffer = NULL;
FILE * stream = NULL;
int nfiles = 0;
int nrow = cpl_table_get_nrow(self);
int irow = 0;
cpl_errorstate prestate = cpl_errorstate_get();
cpl_ensure_code(self != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(useframes != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(maxlinelen > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code(parlist != NULL, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(table_set_row != NULL, CPL_ERROR_NULL_INPUT);
linebuffer = cpl_malloc(maxlinelen);
for (rawframe = cpl_frameset_get_first_const(useframes);
rawframe != NULL;
rawframe = cpl_frameset_get_next_const(useframes), nfiles++) {
const char * rawfile = cpl_frame_get_filename(rawframe);
const char * done; /* Indicate when the reading is done */
const int irowpre = irow;
int iirow = 0;
int ierror;
if (rawfile == NULL) break; /* Should not happen... */
stream = fopen(rawfile, "r");
if (stream == NULL) {
#if defined CPL_HAVE_VA_ARGS && CPL_HAVE_VA_ARGS != 0
cpl_error_set_message(cpl_func, CPL_ERROR_FILE_IO, "Could not "
"open %s for reading", rawfile);
#else
cpl_error_set_message(cpl_func, CPL_ERROR_FILE_IO, "Could not "
"open file for reading");
#endif
break;
}
for (;(done = fgets(linebuffer, maxlinelen, stream)) != NULL; iirow++) {
if (linebuffer[0] != commentchar) {
cpl_boolean didset;
#if defined CPL_HAVE_VA_ARGS && CPL_HAVE_VA_ARGS != 0
const int prerow = irow;
#endif
if (irow == nrow) {
nrow += nrow ? nrow : 1;
if (cpl_table_set_size(self, nrow)) break;
}
didset = table_set_row(self, linebuffer, irow, rawframe,
parlist);
if (didset) irow++;
if (!cpl_errorstate_is_equal(prestate)) {
if (didset)
#if defined CPL_HAVE_VA_ARGS && CPL_HAVE_VA_ARGS != 0
cpl_error_set_message(cpl_func, cpl_error_get_code(),
"Failed to set table row %d "
"using line %d from %d. file %s",
1+prerow, iirow+1,
nfiles+1, rawfile);
else
cpl_error_set_message(cpl_func, cpl_error_get_code(),
"Failure with line %d from %d. "
"file %s", iirow+1,
nfiles+1, rawfile);
#else
cpl_error_set_message(cpl_func, cpl_error_get_code(),
"Failed to set table row"
"using catalogue line");
else
cpl_error_set_message(cpl_func, cpl_error_get_code(),
"Failure with catalogue line");
#endif
break;
}
}
}
if (done != NULL) break;
ierror = fclose(stream);
stream = NULL;
if (ierror) break;
if (irow == irowpre)
cpl_msg_warning(cpl_func, "No usable lines in the %d. file: %s",
1+nfiles, rawfile);
}
cpl_free(linebuffer);
if (stream != NULL) fclose(stream);
/* Check for premature end */
cpl_ensure_code(rawframe == NULL, cpl_error_get_code());
if (irow == 0) {
#if defined CPL_HAVE_VA_ARGS && CPL_HAVE_VA_ARGS != 0
return cpl_error_set_message(cpl_func, CPL_ERROR_DATA_NOT_FOUND,
"No usable lines in the %d input "
"frame(s)", nfiles);
#else
return cpl_error_set_message(cpl_func, CPL_ERROR_DATA_NOT_FOUND,
"No usable lines in the input frame(s)");
#endif
}
/* Resize the table to the actual number of rows set */
cpl_ensure_code(!cpl_table_set_size(self, irow), cpl_error_get_code());
return CPL_ERROR_NONE;
}
/*----------------------------------------------------------------------------*/
/**
@brief Reset IRPLIB state
This function resets all static memory used by IRPLIB to a well-defined,
initial state.
The function should be called (during initialization) by any application
using static memory facilities in IRPLIB.
Currently, this function does nothing.
*/
/*----------------------------------------------------------------------------*/
void irplib_reset(void)
{
return;
}
/*----------------------------------------------------------------------------*/
/**
@brief Comparison function to identify different input frames
@param frame1 first frame
@param frame2 second frame
@return 0 if frame1!=frame2, 1 if frame1==frame2, -1 in error case
*/
/*----------------------------------------------------------------------------*/
int irplib_compare_tags(
cpl_frame * frame1,
cpl_frame * frame2)
{
const char * v1 ;
const char * v2 ;
/* Test entries */
if (frame1==NULL || frame2==NULL) return -1 ;
/* Get the tags */
if ((v1 = cpl_frame_get_tag(frame1)) == NULL) return -1 ;
if ((v2 = cpl_frame_get_tag(frame2)) == NULL) return -1 ;
/* Compare the tags */
if (strcmp(v1, v2)) return 0 ;
else return 1 ;
}
/*----------------------------------------------------------------------------*/
/**
@brief Find the filename with the given tag in a frame set.
@param self A frame set.
@param tag The frame tag to search for.
@return The filename or NULL if none found and on error.
@see cpl_frameset_find
@note If called with a CPL error code, the location will be updated and NULL
returned.
NULL is returned and no error code set if the tag is not found.
If the file is not unique, the name of the first one is returned and with
a warning.
*/
/*----------------------------------------------------------------------------*/
const char * irplib_frameset_find_file(const cpl_frameset * self,
const char * tag)
{
const cpl_frame * frame = cpl_frameset_find_const(self, tag);
cpl_ensure(!cpl_error_get_code(), cpl_error_get_code(), NULL);
if (frame == NULL) return NULL;
if (cpl_frameset_find_const(self, NULL))
cpl_msg_warning(cpl_func,
"Frameset has more than one file with tag: %s",
tag);
return cpl_frame_get_filename(frame);
}
/*----------------------------------------------------------------------------*/
/**
@brief Find the first frame belonging to the given group
@param self The frameset
@param group The group attribute
@return The first frame belonging to the given group, or @c NULL if no
such frame was found. The function returns @c NULL if an error
occurs and sets the appropriate error code.
*/
/*----------------------------------------------------------------------------*/
const
cpl_frame * irplib_frameset_get_first_from_group(const cpl_frameset * self,
cpl_frame_group group)
{
const cpl_frame * frame;
cpl_ensure(self != NULL, CPL_ERROR_NULL_INPUT, NULL);
for (frame = cpl_frameset_get_first_const(self); frame != NULL ;
frame = cpl_frameset_get_next_const(self)) {
if (cpl_frame_get_group(frame) == group) break;
}
return frame;
}
/*----------------------------------------------------------------------------*/
/**
@brief Find the aperture(s) with the greatest flux
@param self The aperture object
@param ind The aperture-indices in order of decreasing flux
@param nfind Number of indices to find
@return CPL_ERROR_NONE or the relevant _cpl_error_code_ on error
nfind must be at least 1 and at most the size of the aperture object.
The ind array must be able to hold (at least) nfind integers.
On success the first nfind elements of ind point to indices of the
aperture object.
To find the single ind of the aperture with the maximum flux use simply:
int ind;
irplib_apertures_find_max_flux(self, &ind, 1);
*/
/*----------------------------------------------------------------------------*/
cpl_error_code irplib_apertures_find_max_flux(const cpl_apertures * self,
int * ind, int nfind)
{
const int nsize = cpl_apertures_get_size(self);
int ifind;
cpl_ensure_code(nsize > 0, cpl_error_get_code());
cpl_ensure_code(ind, CPL_ERROR_NULL_INPUT);
cpl_ensure_code(nfind > 0, CPL_ERROR_ILLEGAL_INPUT);
cpl_ensure_code(nfind <= nsize, CPL_ERROR_ILLEGAL_INPUT);
for (ifind=0; ifind < nfind; ifind++) {
double maxflux = -1;
int maxind = -1;
int i;
for (i=1; i <= nsize; i++) {
int k;
/* The flux has to be the highest among those not already found */
for (k=0; k < ifind; k++) if (ind[k] == i) break;
if (k == ifind) {
/* i has not been inserted into ind */
const double flux = cpl_apertures_get_flux(self, i);
if (maxind < 0 || flux > maxflux) {
maxind = i;
maxflux = flux;
}
}
}
ind[ifind] = maxind;
}
return CPL_ERROR_NONE;
}
/**@}*/
/*----------------------------------------------------------------------------*/
/**
@brief Optimized version of cpl_image_get()
@param self A void pointer, e.g. from cpl_image_get_data_const()
@param type The data type, e.g. from cpl_image_get_type()
@param i The index into the buffer after it has been cast to type
@return The value cast to double
@note This function has no error checking for speed
@see cpl_image_get()
*/
/*----------------------------------------------------------------------------*/
inline static
double irplib_data_get_double(const void * self, cpl_type type, int i)
{
double value;
switch (type) {
case CPL_TYPE_FLOAT:
{
const float * pself = (const float*)self;
value = (double)pself[i];
break;
}
case CPL_TYPE_INT:
{
const int * pself = (const int*)self;
value = (double)pself[i];
break;
}
default: /* case CPL_TYPE_DOUBLE */
{
const double * pself = (const double*)self;
value = pself[i];
break;
}
}
return value;
}
/*----------------------------------------------------------------------------*/
/**
@brief Optimized version of cpl_image_set()
@param self A void pointer, e.g. from cpl_image_get_data_const()
@param type The data type, e.g. from cpl_image_get_type()
@param i The index into the buffer after it has been cast to type
@param value The value to write
@note This function has no error checking for speed
@see cpl_image_set()
*/
/*----------------------------------------------------------------------------*/
inline static
void irplib_data_set_double(void * self, cpl_type type, int i, double value)
{
switch (type) {
case CPL_TYPE_FLOAT:
{
float * pself = (float*)self;
pself[i] = (float)value;
break;
}
case CPL_TYPE_INT:
{
int * pself = (int*)self;
pself[i] = (int)value;
break;
}
default: /* case CPL_TYPE_DOUBLE */
{
double * pself = (double*)self;
pself[i] = value;
break;
}
}
}
/*----------------------------------------------------------------------------*/
/**
@brief Dump a single CPL error
@param Pointer to one of cpl_msg_info(), cpl_msg_warning(), ...
@param self The number of the current error to be dumped
@param first The number of the first error to be dumped
@param last The number of the last error to be dumped
@return void
@see irplib_errorstate_dump_one
*/
/*----------------------------------------------------------------------------*/
static
void irplib_errorstate_dump_one_level(void (*messenger)(const char *,
const char *, ...),
unsigned self, unsigned first,
unsigned last)
{
const cpl_boolean is_reverse = first > last ? CPL_TRUE : CPL_FALSE;
const unsigned newest = is_reverse ? first : last;
const unsigned oldest = is_reverse ? last : first;
const char * revmsg = is_reverse ? " in reverse order" : "";
/*
cx_assert( messenger != NULL );
cx_assert( oldest <= self );
cx_assert( newest >= self );
*/
if (newest == 0) {
messenger(cpl_func, "No error(s) to dump");
/* cx_assert( oldest == 0); */
} else {
/*
cx_assert( oldest > 0);
cx_assert( newest >= oldest);
*/
if (self == first) {
if (oldest == 1) {
messenger(cpl_func, "Dumping all %u error(s)%s:", newest,
revmsg);
} else {
messenger(cpl_func, "Dumping the %u most recent error(s) "
"out of a total of %u errors%s:",
newest - oldest + 1, newest, revmsg);
}
cpl_msg_indent_more();
}
messenger(cpl_func, "[%u/%u] '%s' (%u) at %s", self, newest,
cpl_error_get_message(), cpl_error_get_code(),
cpl_error_get_where());
if (self == last) cpl_msg_indent_less();
}
}
cpl_polynomial * irplib_polynomial_fit_1d_create_chiq(
const cpl_vector * x_pos,
const cpl_vector * values,
int degree,
double * rechisq
)
{
return irplib_polynomial_fit_1d_create_common(x_pos, values, degree, NULL, rechisq);
}
cpl_polynomial * irplib_polynomial_fit_1d_create(
const cpl_vector * x_pos,
const cpl_vector * values,
int degree,
double * mse
)
{
return irplib_polynomial_fit_1d_create_common(x_pos, values, degree, mse, NULL);
}
static cpl_polynomial * irplib_polynomial_fit_1d_create_common(
const cpl_vector * x_pos,
const cpl_vector * values,
int degree,
double * mse,
double * rechisq
)
{
cpl_polynomial * fit1d = NULL;
cpl_size loc_degree = (cpl_size)degree ;
int x_size = 0;
fit1d = cpl_polynomial_new(1);
x_size = cpl_vector_get_size(x_pos);
if(fit1d != NULL && x_size > 1)
{
cpl_matrix * samppos = NULL;
cpl_vector * fitresidual = NULL;
cpl_ensure(!cpl_error_get_code(), cpl_error_get_code(), NULL);
samppos = cpl_matrix_wrap(1, x_size,
(double*)cpl_vector_get_data_const(x_pos));
cpl_ensure(!cpl_error_get_code(), cpl_error_get_code(), NULL);
fitresidual = cpl_vector_new(x_size);
cpl_ensure(!cpl_error_get_code(), cpl_error_get_code(), NULL);
cpl_polynomial_fit(fit1d, samppos, NULL, values, NULL,
CPL_FALSE, NULL, &loc_degree);
cpl_ensure(!cpl_error_get_code(), cpl_error_get_code(), NULL);
cpl_vector_fill_polynomial_fit_residual(fitresidual, values, NULL,
fit1d, samppos, rechisq);
cpl_ensure(!cpl_error_get_code(), cpl_error_get_code(), NULL);
if (mse)
{
*mse = cpl_vector_product(fitresidual, fitresidual)
/ cpl_vector_get_size(fitresidual);
}
cpl_matrix_unwrap(samppos);
cpl_vector_delete(fitresidual);
}
return fit1d;
}
static void quicksort(int* iindex, double* exptime, int left, int right)
{
int i = left;
int j = right;
int pivot = (i + j) / 2;
double index_value = exptime[pivot];
do
{
while(exptime[i] < index_value) i++;
while(exptime[j] > index_value) j--;
if (i <= j)
{
if(i < j)
{
int tmp = iindex[i];
double dtmp = exptime[i];
iindex[i]=iindex[j];
iindex[j]=tmp;
exptime[i] = exptime[j];
exptime[j] = dtmp;
}
i++;
j--;
}
} while (i <= j);
if (i < right)
{
quicksort(iindex, exptime, i, right);
}
if (left < j)
{
quicksort(iindex, exptime,left, j);
}
}
cpl_error_code irplib_frameset_sort(const cpl_frameset * self, int* iindex, double* exptime)
{
int sz = 0;
int i = 0;
const cpl_frame* tmp_frame = 0;
cpl_error_code error = CPL_ERROR_NONE;
sz = cpl_frameset_get_size(self);
/* 1. get an array of frames */
tmp_frame = cpl_frameset_get_first_const(self);
while(tmp_frame)
{
exptime[i] = frame_get_exptime(tmp_frame);
iindex[i] = i;
tmp_frame = cpl_frameset_get_next_const(self);
i++;
}
/* 2.sort */
quicksort(iindex, exptime, 0, sz - 1);
return error;
}
static double frame_get_exptime(const cpl_frame * pframe)
{
double dval = 0;
cpl_propertylist * plist =
cpl_propertylist_load_regexp(cpl_frame_get_filename(pframe), 0,
"EXPTIME", CPL_FALSE);
if(plist) {
dval = cpl_propertylist_get_double(plist, "EXPTIME");
if (cpl_error_get_code() != CPL_ERROR_NONE) {
cpl_msg_error(cpl_func, "error during reading EXPTIME key from "
"the frame [%s]", cpl_frame_get_filename(pframe));
}
}
/* Free and return */
cpl_propertylist_delete(plist);
return dval;
}
/*----------------------------------------------------------------------------*/
/**
@brief allocate uninitialized aligned memory
@param alignment alignment of the data, must be a power of two
@param size size of the memory block to be allocated in bytes
@return pointer to aligned memory or on failure returns NULL and sets errno
@see irplib_aligned_free
@note memory MUST be free'd with irplib_aligned_free and cannot be realloc'd
memory leaks will not be detected by cpl
It is recommended to build with posix 2001 to get posix_memalign and add
AC_CHECK_FUNCS([posix_memalign]) and AC_CHECK_DECLS([posix_memalign]) to
configure.ac
*/
/*----------------------------------------------------------------------------*/
void * irplib_aligned_malloc(size_t alignment, size_t size)
{
#if defined __STDC_VERSION__ && __STDC_VERSION__ >= 201112L
return aligned_alloc(alignment, size);
#elif defined HAVE_POSIX_MEMALIGN && defined HAVE_DECL_POSIX_MEMALIGN
void *ptr;
if (alignment == 1)
return malloc (size);
if (alignment == 2 || (sizeof (void *) == 8 && alignment == 4))
alignment = sizeof (void *);
if (posix_memalign (&ptr, alignment, size) == 0)
return ptr;
else
return NULL;
#else
/* copied from gmm_malloc.h in gcc-4.8 */
void * malloc_ptr;
void * aligned_ptr;
/* Error if align is not a power of two. */
if (alignment & (alignment - 1)) {
errno = EINVAL;
return NULL;
}
if (size == 0)
return NULL;
/* Assume malloc'd pointer is aligned at least to sizeof (void*).
If necessary, add another sizeof (void*) to store the value
returned by malloc. Effectively this enforces a minimum alignment
of sizeof double. */
if (alignment < 2 * sizeof (void *))
alignment = 2 * sizeof (void *);
malloc_ptr = malloc (size + alignment);
if (!malloc_ptr)
return NULL;
/* Align We have at least sizeof (void *) space below malloc'd ptr. */
aligned_ptr = (void *) (((size_t) malloc_ptr + alignment)
& ~((size_t) (alignment) - 1));
/* Store the original pointer just before p. */
*(((void **) aligned_ptr) - 1) = malloc_ptr;
return aligned_ptr;
#endif
}
/*----------------------------------------------------------------------------*/
/**
@brief allocate aligned memory initialized to zero
@param alignment alignment of the data, must be a power of two
@param nelem number of elements in buffer
@param nbytes size of single element in bytes
@return pointer to aligned memory or on failure returns NULL and sets errno
@see irplib_aligned_malloc
*/
/*----------------------------------------------------------------------------*/
void * irplib_aligned_calloc(size_t alignment, size_t nelem, size_t nbytes)
{
void * buffer = irplib_aligned_malloc(alignment, nelem * nbytes);
if (buffer == NULL)
return NULL;
/* cast to aligned pointer helps compilers to emit better (builtin) code */
memset((size_t *)buffer, 0, nelem * nbytes);
return buffer;
}
/*----------------------------------------------------------------------------*/
/**
@brief free aligned memory
@param aligned_ptr pointer to memory to be free'd
@see irplib_aligned_malloc
@note memory MUST be allocated with irplib_aligned_[cm]alloc
*/
/*----------------------------------------------------------------------------*/
void irplib_aligned_free (void * aligned_ptr)
{
#if defined __STDC_VERSION__ && __STDC_VERSION__ >= 201112L
free(aligned_ptr);
#elif defined HAVE_POSIX_MEMALIGN && defined HAVE_DECL_POSIX_MEMALIGN
free(aligned_ptr);
#else
if (aligned_ptr)
free (*(((void **) aligned_ptr) - 1));
#endif
}
|