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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>WCSLIB 4.8.2: wcs.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>wcs.h</h1><a href="wcs_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*============================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> WCSLIB 4.8 - an implementation of the FITS WCS standard.</span>
<a name="l00004"></a>00004 <span class="comment"> Copyright (C) 1995-2011, Mark Calabretta</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment"> This file is part of WCSLIB.</span>
<a name="l00007"></a>00007 <span class="comment"></span>
<a name="l00008"></a>00008 <span class="comment"> WCSLIB is free software: you can redistribute it and/or modify it under the</span>
<a name="l00009"></a>00009 <span class="comment"> terms of the GNU Lesser General Public License as published by the Free</span>
<a name="l00010"></a>00010 <span class="comment"> Software Foundation, either version 3 of the License, or (at your option)</span>
<a name="l00011"></a>00011 <span class="comment"> any later version.</span>
<a name="l00012"></a>00012 <span class="comment"></span>
<a name="l00013"></a>00013 <span class="comment"> WCSLIB is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00014"></a>00014 <span class="comment"> WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00015"></a>00015 <span class="comment"> FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for</span>
<a name="l00016"></a>00016 <span class="comment"> more details.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> You should have received a copy of the GNU Lesser General Public License</span>
<a name="l00019"></a>00019 <span class="comment"> along with WCSLIB. If not, see <http://www.gnu.org/licenses/>.</span>
<a name="l00020"></a>00020 <span class="comment"></span>
<a name="l00021"></a>00021 <span class="comment"> Correspondence concerning WCSLIB may be directed to:</span>
<a name="l00022"></a>00022 <span class="comment"> Internet email: mcalabre@atnf.csiro.au</span>
<a name="l00023"></a>00023 <span class="comment"> Postal address: Dr. Mark Calabretta</span>
<a name="l00024"></a>00024 <span class="comment"> Australia Telescope National Facility, CSIRO</span>
<a name="l00025"></a>00025 <span class="comment"> PO Box 76</span>
<a name="l00026"></a>00026 <span class="comment"> Epping NSW 1710</span>
<a name="l00027"></a>00027 <span class="comment"> AUSTRALIA</span>
<a name="l00028"></a>00028 <span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment"> Author: Mark Calabretta, Australia Telescope National Facility</span>
<a name="l00030"></a>00030 <span class="comment"> http://www.atnf.csiro.au/~mcalabre/index.html</span>
<a name="l00031"></a>00031 <span class="comment"> $Id: wcs.h,v 4.8.1.1 2011/08/15 08:07:06 cal103 Exp cal103 $</span>
<a name="l00032"></a>00032 <span class="comment">*=============================================================================</span>
<a name="l00033"></a>00033 <span class="comment">*</span>
<a name="l00034"></a>00034 <span class="comment">* WCSLIB 4.8 - C routines that implement the FITS World Coordinate System</span>
<a name="l00035"></a>00035 <span class="comment">* (WCS) standard. Refer to</span>
<a name="l00036"></a>00036 <span class="comment">*</span>
<a name="l00037"></a>00037 <span class="comment">* "Representations of world coordinates in FITS",</span>
<a name="l00038"></a>00038 <span class="comment">* Greisen, E.W., & Calabretta, M.R. 2002, A&A, 395, 1061 (Paper I)</span>
<a name="l00039"></a>00039 <span class="comment">*</span>
<a name="l00040"></a>00040 <span class="comment">* "Representations of celestial coordinates in FITS",</span>
<a name="l00041"></a>00041 <span class="comment">* Calabretta, M.R., & Greisen, E.W. 2002, A&A, 395, 1077 (Paper II)</span>
<a name="l00042"></a>00042 <span class="comment">*</span>
<a name="l00043"></a>00043 <span class="comment">* "Representations of spectral coordinates in FITS",</span>
<a name="l00044"></a>00044 <span class="comment">* Greisen, E.W., Calabretta, M.R., Valdes, F.G., & Allen, S.L.</span>
<a name="l00045"></a>00045 <span class="comment">* 2006, A&A, 446, 747 (Paper III)</span>
<a name="l00046"></a>00046 <span class="comment">*</span>
<a name="l00047"></a>00047 <span class="comment">* Refer to the README file provided with WCSLIB for an overview of the</span>
<a name="l00048"></a>00048 <span class="comment">* library.</span>
<a name="l00049"></a>00049 <span class="comment">*</span>
<a name="l00050"></a>00050 <span class="comment">*</span>
<a name="l00051"></a>00051 <span class="comment">* Summary of the wcs routines</span>
<a name="l00052"></a>00052 <span class="comment">* ---------------------------</span>
<a name="l00053"></a>00053 <span class="comment">* These routines implement the FITS World Coordinate System (WCS) standard</span>
<a name="l00054"></a>00054 <span class="comment">* which defines methods to be used for computing world coordinates from image</span>
<a name="l00055"></a>00055 <span class="comment">* pixel coordinates, and vice versa. They are based on the wcsprm struct</span>
<a name="l00056"></a>00056 <span class="comment">* which contains all information needed for the computations. The struct</span>
<a name="l00057"></a>00057 <span class="comment">* contains some members that must be set by the user, and others that are</span>
<a name="l00058"></a>00058 <span class="comment">* maintained by these routines, somewhat like a C++ class but with no</span>
<a name="l00059"></a>00059 <span class="comment">* encapsulation.</span>
<a name="l00060"></a>00060 <span class="comment">*</span>
<a name="l00061"></a>00061 <span class="comment">* Three routines, wcsini(), wcssub(), and wcsfree() are provided to manage the</span>
<a name="l00062"></a>00062 <span class="comment">* wcsprm struct and another, wcsprt(), to prints its contents. Refer to the</span>
<a name="l00063"></a>00063 <span class="comment">* description of the wcsprm struct for an explanation of the anticipated usage</span>
<a name="l00064"></a>00064 <span class="comment">* of these routines. wcscopy(), which does a deep copy of one wcsprm struct</span>
<a name="l00065"></a>00065 <span class="comment">* to another, is defined as a preprocessor macro function that invokes</span>
<a name="l00066"></a>00066 <span class="comment">* wcssub().</span>
<a name="l00067"></a>00067 <span class="comment">*</span>
<a name="l00068"></a>00068 <span class="comment">* wcsperr() prints the error message(s) (if any) stored in a wcsprm struct,</span>
<a name="l00069"></a>00069 <span class="comment">* and the linprm, celprm, prjprm, spcprm, and tabprm structs that it contains.</span>
<a name="l00070"></a>00070 <span class="comment">*</span>
<a name="l00071"></a>00071 <span class="comment">* A setup routine, wcsset(), computes intermediate values in the wcsprm struct</span>
<a name="l00072"></a>00072 <span class="comment">* from parameters in it that were supplied by the user. The struct always</span>
<a name="l00073"></a>00073 <span class="comment">* needs to be set up by wcsset() but this need not be called explicitly -</span>
<a name="l00074"></a>00074 <span class="comment">* refer to the explanation of wcsprm::flag.</span>
<a name="l00075"></a>00075 <span class="comment">*</span>
<a name="l00076"></a>00076 <span class="comment">* wcsp2s() and wcss2p() implement the WCS world coordinate transformations.</span>
<a name="l00077"></a>00077 <span class="comment">* In fact, they are high level driver routines for the WCS linear,</span>
<a name="l00078"></a>00078 <span class="comment">* logarithmic, celestial, spectral and tabular transformation routines</span>
<a name="l00079"></a>00079 <span class="comment">* described in lin.h, log.h, cel.h, spc.h and tab.h.</span>
<a name="l00080"></a>00080 <span class="comment">*</span>
<a name="l00081"></a>00081 <span class="comment">* Given either the celestial longitude or latitude plus an element of the</span>
<a name="l00082"></a>00082 <span class="comment">* pixel coordinate a hybrid routine, wcsmix(), iteratively solves for the</span>
<a name="l00083"></a>00083 <span class="comment">* unknown elements.</span>
<a name="l00084"></a>00084 <span class="comment">*</span>
<a name="l00085"></a>00085 <span class="comment">* wcssptr() translates the spectral axis in a wcsprm struct. For example, a</span>
<a name="l00086"></a>00086 <span class="comment">* 'FREQ' axis may be translated into 'ZOPT-F2W' and vice versa.</span>
<a name="l00087"></a>00087 <span class="comment">*</span>
<a name="l00088"></a>00088 <span class="comment">* Quadcube projections:</span>
<a name="l00089"></a>00089 <span class="comment">* ---------------------</span>
<a name="l00090"></a>00090 <span class="comment">* The quadcube projections (TSC, CSC, QSC) may be represented in FITS in</span>
<a name="l00091"></a>00091 <span class="comment">* either of two ways:</span>
<a name="l00092"></a>00092 <span class="comment">*</span>
<a name="l00093"></a>00093 <span class="comment">* a: The six faces may be laid out in one plane and numbered as follows:</span>
<a name="l00094"></a>00094 <span class="comment">*</span>
<a name="l00095"></a>00095 <span class="comment">= 0</span>
<a name="l00096"></a>00096 <span class="comment">=</span>
<a name="l00097"></a>00097 <span class="comment">= 4 3 2 1 4 3 2</span>
<a name="l00098"></a>00098 <span class="comment">=</span>
<a name="l00099"></a>00099 <span class="comment">= 5</span>
<a name="l00100"></a>00100 <span class="comment">*</span>
<a name="l00101"></a>00101 <span class="comment">* Faces 2, 3 and 4 may appear on one side or the other (or both). The</span>
<a name="l00102"></a>00102 <span class="comment">* world-to-pixel routines map faces 2, 3 and 4 to the left but the</span>
<a name="l00103"></a>00103 <span class="comment">* pixel-to-world routines accept them on either side.</span>
<a name="l00104"></a>00104 <span class="comment">*</span>
<a name="l00105"></a>00105 <span class="comment">* b: The "COBE" convention in which the six faces are stored in a</span>
<a name="l00106"></a>00106 <span class="comment">* three-dimensional structure using a CUBEFACE axis indexed from</span>
<a name="l00107"></a>00107 <span class="comment">* 0 to 5 as above.</span>
<a name="l00108"></a>00108 <span class="comment">*</span>
<a name="l00109"></a>00109 <span class="comment">* These routines support both methods; wcsset() determines which is being</span>
<a name="l00110"></a>00110 <span class="comment">* used by the presence or absence of a CUBEFACE axis in ctype[]. wcsp2s()</span>
<a name="l00111"></a>00111 <span class="comment">* and wcss2p() translate the CUBEFACE axis representation to the single</span>
<a name="l00112"></a>00112 <span class="comment">* plane representation understood by the lower-level WCSLIB projection</span>
<a name="l00113"></a>00113 <span class="comment">* routines.</span>
<a name="l00114"></a>00114 <span class="comment">*</span>
<a name="l00115"></a>00115 <span class="comment">*</span>
<a name="l00116"></a>00116 <span class="comment">* wcsini() - Default constructor for the wcsprm struct</span>
<a name="l00117"></a>00117 <span class="comment">* ----------------------------------------------------</span>
<a name="l00118"></a>00118 <span class="comment">* wcsini() optionally allocates memory for arrays in a wcsprm struct and sets</span>
<a name="l00119"></a>00119 <span class="comment">* all members of the struct to default values. Memory is allocated for up to</span>
<a name="l00120"></a>00120 <span class="comment">* NPVMAX PVi_ma keywords or NPSMAX PSi_ma keywords per WCS representation.</span>
<a name="l00121"></a>00121 <span class="comment">* These may be changed via wcsnpv() and wcsnps() before wcsini() is called.</span>
<a name="l00122"></a>00122 <span class="comment">*</span>
<a name="l00123"></a>00123 <span class="comment">* PLEASE NOTE: every wcsprm struct should be initialized by wcsini(), possibly</span>
<a name="l00124"></a>00124 <span class="comment">* repeatedly. On the first invokation, and only the first invokation,</span>
<a name="l00125"></a>00125 <span class="comment">* wcsprm::flag must be set to -1 to initialize memory management, regardless</span>
<a name="l00126"></a>00126 <span class="comment">* of whether wcsini() will actually be used to allocate memory.</span>
<a name="l00127"></a>00127 <span class="comment">*</span>
<a name="l00128"></a>00128 <span class="comment">* Given:</span>
<a name="l00129"></a>00129 <span class="comment">* alloc int If true, allocate memory unconditionally for the</span>
<a name="l00130"></a>00130 <span class="comment">* crpix, etc. arrays.</span>
<a name="l00131"></a>00131 <span class="comment">*</span>
<a name="l00132"></a>00132 <span class="comment">* If false, it is assumed that pointers to these arrays</span>
<a name="l00133"></a>00133 <span class="comment">* have been set by the user except if they are null</span>
<a name="l00134"></a>00134 <span class="comment">* pointers in which case memory will be allocated for</span>
<a name="l00135"></a>00135 <span class="comment">* them regardless. (In other words, setting alloc true</span>
<a name="l00136"></a>00136 <span class="comment">* saves having to initalize these pointers to zero.)</span>
<a name="l00137"></a>00137 <span class="comment">*</span>
<a name="l00138"></a>00138 <span class="comment">* naxis int The number of world coordinate axes. This is used to</span>
<a name="l00139"></a>00139 <span class="comment">* determine the length of the various wcsprm vectors and</span>
<a name="l00140"></a>00140 <span class="comment">* matrices and therefore the amount of memory to</span>
<a name="l00141"></a>00141 <span class="comment">* allocate for them.</span>
<a name="l00142"></a>00142 <span class="comment">*</span>
<a name="l00143"></a>00143 <span class="comment">* Given and returned:</span>
<a name="l00144"></a>00144 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00145"></a>00145 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00146"></a>00146 <span class="comment">*</span>
<a name="l00147"></a>00147 <span class="comment">* Note that, in order to initialize memory management,</span>
<a name="l00148"></a>00148 <span class="comment">* wcsprm::flag should be set to -1 when wcs is</span>
<a name="l00149"></a>00149 <span class="comment">* initialized for the first time (memory leaks may</span>
<a name="l00150"></a>00150 <span class="comment">* result if it had already been initialized).</span>
<a name="l00151"></a>00151 <span class="comment">*</span>
<a name="l00152"></a>00152 <span class="comment">* Function return value:</span>
<a name="l00153"></a>00153 <span class="comment">* int Status return value:</span>
<a name="l00154"></a>00154 <span class="comment">* 0: Success.</span>
<a name="l00155"></a>00155 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00156"></a>00156 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00157"></a>00157 <span class="comment">*</span>
<a name="l00158"></a>00158 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00159"></a>00159 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00160"></a>00160 <span class="comment">*</span>
<a name="l00161"></a>00161 <span class="comment">*</span>
<a name="l00162"></a>00162 <span class="comment">* wcsnpv() - Memory allocation for PVi_ma</span>
<a name="l00163"></a>00163 <span class="comment">* ---------------------------------------</span>
<a name="l00164"></a>00164 <span class="comment">* wcsnpv() changes the value of NPVMAX (default 64). This global variable</span>
<a name="l00165"></a>00165 <span class="comment">* controls the number of PVi_ma keywords that wcsini() should allocate space</span>
<a name="l00166"></a>00166 <span class="comment">* for.</span>
<a name="l00167"></a>00167 <span class="comment">*</span>
<a name="l00168"></a>00168 <span class="comment">* PLEASE NOTE: This function is not thread-safe.</span>
<a name="l00169"></a>00169 <span class="comment">*</span>
<a name="l00170"></a>00170 <span class="comment">* Given:</span>
<a name="l00171"></a>00171 <span class="comment">* n int Value of NPVMAX; ignored if < 0.</span>
<a name="l00172"></a>00172 <span class="comment">*</span>
<a name="l00173"></a>00173 <span class="comment">* Function return value:</span>
<a name="l00174"></a>00174 <span class="comment">* int Current value of NPVMAX.</span>
<a name="l00175"></a>00175 <span class="comment">*</span>
<a name="l00176"></a>00176 <span class="comment">*</span>
<a name="l00177"></a>00177 <span class="comment">* wcsnps() - Memory allocation for PSi_ma</span>
<a name="l00178"></a>00178 <span class="comment">* ---------------------------------------</span>
<a name="l00179"></a>00179 <span class="comment">* wcsnps() changes the values of NPSMAX (default 8). This global variable</span>
<a name="l00180"></a>00180 <span class="comment">* controls the number of PSi_ma keywords that wcsini() should allocate space</span>
<a name="l00181"></a>00181 <span class="comment">* for.</span>
<a name="l00182"></a>00182 <span class="comment">*</span>
<a name="l00183"></a>00183 <span class="comment">* PLEASE NOTE: This function is not thread-safe.</span>
<a name="l00184"></a>00184 <span class="comment">*</span>
<a name="l00185"></a>00185 <span class="comment">* Given:</span>
<a name="l00186"></a>00186 <span class="comment">* n int Value of NPSMAX; ignored if < 0.</span>
<a name="l00187"></a>00187 <span class="comment">*</span>
<a name="l00188"></a>00188 <span class="comment">* Function return value:</span>
<a name="l00189"></a>00189 <span class="comment">* int Current value of NPSMAX.</span>
<a name="l00190"></a>00190 <span class="comment">*</span>
<a name="l00191"></a>00191 <span class="comment">*</span>
<a name="l00192"></a>00192 <span class="comment">* wcssub() - Subimage extraction routine for the wcsprm struct</span>
<a name="l00193"></a>00193 <span class="comment">* ------------------------------------------------------------</span>
<a name="l00194"></a>00194 <span class="comment">* wcssub() extracts the coordinate description for a subimage from a wcsprm</span>
<a name="l00195"></a>00195 <span class="comment">* struct. It does a deep copy, using wcsini() to allocate memory for its</span>
<a name="l00196"></a>00196 <span class="comment">* arrays if required. Only the "information to be provided" part of the</span>
<a name="l00197"></a>00197 <span class="comment">* struct is extracted; a call to wcsset() is required to set up the remainder.</span>
<a name="l00198"></a>00198 <span class="comment">*</span>
<a name="l00199"></a>00199 <span class="comment">* The world coordinate system of the subimage must be separable in the sense</span>
<a name="l00200"></a>00200 <span class="comment">* that the world coordinates at any point in the subimage must depend only on</span>
<a name="l00201"></a>00201 <span class="comment">* the pixel coordinates of the axes extracted. In practice, this means that</span>
<a name="l00202"></a>00202 <span class="comment">* the PCi_ja matrix of the original image must not contain non-zero</span>
<a name="l00203"></a>00203 <span class="comment">* off-diagonal terms that associate any of the subimage axes with any of the</span>
<a name="l00204"></a>00204 <span class="comment">* non-subimage axes.</span>
<a name="l00205"></a>00205 <span class="comment">*</span>
<a name="l00206"></a>00206 <span class="comment">* Note that while the required elements of the tabprm array are extracted, the</span>
<a name="l00207"></a>00207 <span class="comment">* wtbarr array is not. (Thus it is not appropriate to call wcssub() after</span>
<a name="l00208"></a>00208 <span class="comment">* wcstab() but before filling the tabprm structs - refer to wcshdr.h.)</span>
<a name="l00209"></a>00209 <span class="comment">*</span>
<a name="l00210"></a>00210 <span class="comment">* Given:</span>
<a name="l00211"></a>00211 <span class="comment">* alloc int If true, allocate memory for the crpix, etc. arrays in</span>
<a name="l00212"></a>00212 <span class="comment">* the destination. Otherwise, it is assumed that</span>
<a name="l00213"></a>00213 <span class="comment">* pointers to these arrays have been set by the user</span>
<a name="l00214"></a>00214 <span class="comment">* except if they are null pointers in which case memory</span>
<a name="l00215"></a>00215 <span class="comment">* will be allocated for them regardless.</span>
<a name="l00216"></a>00216 <span class="comment">*</span>
<a name="l00217"></a>00217 <span class="comment">* wcssrc const struct wcsprm*</span>
<a name="l00218"></a>00218 <span class="comment">* Struct to extract from.</span>
<a name="l00219"></a>00219 <span class="comment">*</span>
<a name="l00220"></a>00220 <span class="comment">* Given and returned:</span>
<a name="l00221"></a>00221 <span class="comment">* nsub int*</span>
<a name="l00222"></a>00222 <span class="comment">* axes int[] Vector of length *nsub containing the image axis</span>
<a name="l00223"></a>00223 <span class="comment">* numbers (1-relative) to extract. Order is</span>
<a name="l00224"></a>00224 <span class="comment">* significant; axes[0] is the axis number of the input</span>
<a name="l00225"></a>00225 <span class="comment">* image that corresponds to the first axis in the</span>
<a name="l00226"></a>00226 <span class="comment">* subimage, etc.</span>
<a name="l00227"></a>00227 <span class="comment">*</span>
<a name="l00228"></a>00228 <span class="comment">* nsub (the pointer) may be set to zero, and so also may</span>
<a name="l00229"></a>00229 <span class="comment">* nsub, to indicate the number of axes in the input</span>
<a name="l00230"></a>00230 <span class="comment">* image; the number of axes will be returned if</span>
<a name="l00231"></a>00231 <span class="comment">* nsub != 0. axes itself (the pointer) may be set to</span>
<a name="l00232"></a>00232 <span class="comment">* zero to indicate the first *nsub axes in their</span>
<a name="l00233"></a>00233 <span class="comment">* original order.</span>
<a name="l00234"></a>00234 <span class="comment">*</span>
<a name="l00235"></a>00235 <span class="comment">* Set both nsub and axes to zero to do a deep copy of</span>
<a name="l00236"></a>00236 <span class="comment">* one wcsprm struct to another.</span>
<a name="l00237"></a>00237 <span class="comment">*</span>
<a name="l00238"></a>00238 <span class="comment">* Subimage extraction by coordinate axis type may be</span>
<a name="l00239"></a>00239 <span class="comment">* done by setting the elements of axes[] to the</span>
<a name="l00240"></a>00240 <span class="comment">* following special preprocessor macro values:</span>
<a name="l00241"></a>00241 <span class="comment">*</span>
<a name="l00242"></a>00242 <span class="comment">* WCSSUB_LONGITUDE: Celestial longitude.</span>
<a name="l00243"></a>00243 <span class="comment">* WCSSUB_LATITUDE: Celestial latitude.</span>
<a name="l00244"></a>00244 <span class="comment">* WCSSUB_CUBEFACE: Quadcube CUBEFACE axis.</span>
<a name="l00245"></a>00245 <span class="comment">* WCSSUB_SPECTRAL: Spectral axis.</span>
<a name="l00246"></a>00246 <span class="comment">* WCSSUB_STOKES: Stokes axis.</span>
<a name="l00247"></a>00247 <span class="comment">*</span>
<a name="l00248"></a>00248 <span class="comment">* Refer to the notes (below) for further usage examples.</span>
<a name="l00249"></a>00249 <span class="comment">*</span>
<a name="l00250"></a>00250 <span class="comment">* On return, *nsub will contain the number of axes in</span>
<a name="l00251"></a>00251 <span class="comment">* the subimage; this may be zero if there were no axes</span>
<a name="l00252"></a>00252 <span class="comment">* of the required type(s) (in which case no memory will</span>
<a name="l00253"></a>00253 <span class="comment">* be allocated). axes[] will contain the axis numbers</span>
<a name="l00254"></a>00254 <span class="comment">* that were extracted. The vector length must be</span>
<a name="l00255"></a>00255 <span class="comment">* sufficient to contain all axis numbers. No checks are</span>
<a name="l00256"></a>00256 <span class="comment">* performed to verify that the coordinate axes are</span>
<a name="l00257"></a>00257 <span class="comment">* consistent, this is done by wcsset().</span>
<a name="l00258"></a>00258 <span class="comment">*</span>
<a name="l00259"></a>00259 <span class="comment">* wcsdst struct wcsprm*</span>
<a name="l00260"></a>00260 <span class="comment">* Struct describing the subimage. wcsprm::flag should</span>
<a name="l00261"></a>00261 <span class="comment">* be set to -1 if wcsdst was not previously initialized</span>
<a name="l00262"></a>00262 <span class="comment">* (memory leaks may result if it was previously</span>
<a name="l00263"></a>00263 <span class="comment">* initialized).</span>
<a name="l00264"></a>00264 <span class="comment">*</span>
<a name="l00265"></a>00265 <span class="comment">* Function return value:</span>
<a name="l00266"></a>00266 <span class="comment">* int Status return value:</span>
<a name="l00267"></a>00267 <span class="comment">* 0: Success.</span>
<a name="l00268"></a>00268 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00269"></a>00269 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00270"></a>00270 <span class="comment">* 12: Invalid subimage specification.</span>
<a name="l00271"></a>00271 <span class="comment">* 13: Non-separable subimage coordinate system.</span>
<a name="l00272"></a>00272 <span class="comment">*</span>
<a name="l00273"></a>00273 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00274"></a>00274 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00275"></a>00275 <span class="comment">*</span>
<a name="l00276"></a>00276 <span class="comment">* Notes:</span>
<a name="l00277"></a>00277 <span class="comment">* Combinations of subimage axes of particular types may be extracted in the</span>
<a name="l00278"></a>00278 <span class="comment">* same order as they occur in the input image by combining preprocessor</span>
<a name="l00279"></a>00279 <span class="comment">* codes, for example</span>
<a name="l00280"></a>00280 <span class="comment">*</span>
<a name="l00281"></a>00281 <span class="comment">= *nsub = 1;</span>
<a name="l00282"></a>00282 <span class="comment">= axes[0] = WCSSUB_LONGITUDE | WCSSUB_LATITUDE | WCSSUB_SPECTRAL;</span>
<a name="l00283"></a>00283 <span class="comment">*</span>
<a name="l00284"></a>00284 <span class="comment">* would extract the longitude, latitude, and spectral axes in the same order</span>
<a name="l00285"></a>00285 <span class="comment">* as the input image. If one of each were present, *nsub = 3 would be</span>
<a name="l00286"></a>00286 <span class="comment">* returned.</span>
<a name="l00287"></a>00287 <span class="comment">*</span>
<a name="l00288"></a>00288 <span class="comment">* For convenience, WCSSUB_CELESTIAL is defined as the combination</span>
<a name="l00289"></a>00289 <span class="comment">* WCSSUB_LONGITUDE | WCSSUB_LATITUDE | WCSSUB_CUBEFACE.</span>
<a name="l00290"></a>00290 <span class="comment">*</span>
<a name="l00291"></a>00291 <span class="comment">* The codes may also be negated to extract all but the types specified, for</span>
<a name="l00292"></a>00292 <span class="comment">* example</span>
<a name="l00293"></a>00293 <span class="comment">*</span>
<a name="l00294"></a>00294 <span class="comment">= *nsub = 4;</span>
<a name="l00295"></a>00295 <span class="comment">= axes[0] = WCSSUB_LONGITUDE;</span>
<a name="l00296"></a>00296 <span class="comment">= axes[1] = WCSSUB_LATITUDE;</span>
<a name="l00297"></a>00297 <span class="comment">= axes[2] = WCSSUB_CUBEFACE;</span>
<a name="l00298"></a>00298 <span class="comment">= axes[3] = -(WCSSUB_SPECTRAL | WCSSUB_STOKES);</span>
<a name="l00299"></a>00299 <span class="comment">*</span>
<a name="l00300"></a>00300 <span class="comment">* The last of these specifies all axis types other than spectral or Stokes.</span>
<a name="l00301"></a>00301 <span class="comment">* Extraction is done in the order specified by axes[] a longitude axis (if</span>
<a name="l00302"></a>00302 <span class="comment">* present) would be extracted first (via axes[0]) and not subsequently (via</span>
<a name="l00303"></a>00303 <span class="comment">* axes[3]). Likewise for the latitude and cubeface axes in this example.</span>
<a name="l00304"></a>00304 <span class="comment">*</span>
<a name="l00305"></a>00305 <span class="comment">* From the foregoing, it is apparent that the value of *nsub returned may be</span>
<a name="l00306"></a>00306 <span class="comment">* less than or greater than that given. However, it will never exceed the</span>
<a name="l00307"></a>00307 <span class="comment">* number of axes in the input image.</span>
<a name="l00308"></a>00308 <span class="comment">*</span>
<a name="l00309"></a>00309 <span class="comment">*</span>
<a name="l00310"></a>00310 <span class="comment">* wcscopy() macro - Copy routine for the wcsprm struct</span>
<a name="l00311"></a>00311 <span class="comment">* ----------------------------------------------------</span>
<a name="l00312"></a>00312 <span class="comment">* wcscopy() does a deep copy of one wcsprm struct to another. As of</span>
<a name="l00313"></a>00313 <span class="comment">* WCSLIB 3.6, it is implemented as a preprocessor macro that invokes</span>
<a name="l00314"></a>00314 <span class="comment">* wcssub() with the nsub and axes pointers both set to zero.</span>
<a name="l00315"></a>00315 <span class="comment">*</span>
<a name="l00316"></a>00316 <span class="comment">*</span>
<a name="l00317"></a>00317 <span class="comment">* wcsfree() - Destructor for the wcsprm struct</span>
<a name="l00318"></a>00318 <span class="comment">* --------------------------------------------</span>
<a name="l00319"></a>00319 <span class="comment">* wcsfree() frees memory allocated for the wcsprm arrays by wcsini() and/or</span>
<a name="l00320"></a>00320 <span class="comment">* wcsset(). wcsini() records the memory it allocates and wcsfree() will only</span>
<a name="l00321"></a>00321 <span class="comment">* attempt to free this.</span>
<a name="l00322"></a>00322 <span class="comment">*</span>
<a name="l00323"></a>00323 <span class="comment">* PLEASE NOTE: wcsfree() must not be invoked on a wcsprm struct that was not</span>
<a name="l00324"></a>00324 <span class="comment">* initialized by wcsini().</span>
<a name="l00325"></a>00325 <span class="comment">*</span>
<a name="l00326"></a>00326 <span class="comment">* Returned:</span>
<a name="l00327"></a>00327 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00328"></a>00328 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00329"></a>00329 <span class="comment">*</span>
<a name="l00330"></a>00330 <span class="comment">* Function return value:</span>
<a name="l00331"></a>00331 <span class="comment">* int Status return value:</span>
<a name="l00332"></a>00332 <span class="comment">* 0: Success.</span>
<a name="l00333"></a>00333 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00334"></a>00334 <span class="comment">*</span>
<a name="l00335"></a>00335 <span class="comment">*</span>
<a name="l00336"></a>00336 <span class="comment">* wcsprt() - Print routine for the wcsprm struct</span>
<a name="l00337"></a>00337 <span class="comment">* ----------------------------------------------</span>
<a name="l00338"></a>00338 <span class="comment">* wcsprt() prints the contents of a wcsprm struct using wcsprintf(). Mainly</span>
<a name="l00339"></a>00339 <span class="comment">* intended for diagnostic purposes.</span>
<a name="l00340"></a>00340 <span class="comment">*</span>
<a name="l00341"></a>00341 <span class="comment">* Given:</span>
<a name="l00342"></a>00342 <span class="comment">* wcs const struct wcsprm*</span>
<a name="l00343"></a>00343 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00344"></a>00344 <span class="comment">*</span>
<a name="l00345"></a>00345 <span class="comment">* Function return value:</span>
<a name="l00346"></a>00346 <span class="comment">* int Status return value:</span>
<a name="l00347"></a>00347 <span class="comment">* 0: Success.</span>
<a name="l00348"></a>00348 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00349"></a>00349 <span class="comment">*</span>
<a name="l00350"></a>00350 <span class="comment">*</span>
<a name="l00351"></a>00351 <span class="comment">* wcsperr() - Print error messages from a wcsprm struct</span>
<a name="l00352"></a>00352 <span class="comment">* -----------------------------------------------------</span>
<a name="l00353"></a>00353 <span class="comment">* wcsperr() prints the error message(s), if any, stored in a wcsprm struct,</span>
<a name="l00354"></a>00354 <span class="comment">* and the linprm, celprm, prjprm, spcprm, and tabprm structs that it contains.</span>
<a name="l00355"></a>00355 <span class="comment">* If there are no errors then nothing is printed. It uses wcserr_prt(), q.v.</span>
<a name="l00356"></a>00356 <span class="comment">*</span>
<a name="l00357"></a>00357 <span class="comment">* Given:</span>
<a name="l00358"></a>00358 <span class="comment">* wcs const struct wcsprm*</span>
<a name="l00359"></a>00359 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00360"></a>00360 <span class="comment">*</span>
<a name="l00361"></a>00361 <span class="comment">* prefix const char *</span>
<a name="l00362"></a>00362 <span class="comment">* If non-NULL, each output line will be prefixed with</span>
<a name="l00363"></a>00363 <span class="comment">* this string.</span>
<a name="l00364"></a>00364 <span class="comment">*</span>
<a name="l00365"></a>00365 <span class="comment">* Function return value:</span>
<a name="l00366"></a>00366 <span class="comment">* int Status return value:</span>
<a name="l00367"></a>00367 <span class="comment">* 0: Success.</span>
<a name="l00368"></a>00368 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00369"></a>00369 <span class="comment">*</span>
<a name="l00370"></a>00370 <span class="comment">*</span>
<a name="l00371"></a>00371 <span class="comment">* wcsset() - Setup routine for the wcsprm struct</span>
<a name="l00372"></a>00372 <span class="comment">* ----------------------------------------------</span>
<a name="l00373"></a>00373 <span class="comment">* wcsset() sets up a wcsprm struct according to information supplied within</span>
<a name="l00374"></a>00374 <span class="comment">* it (refer to the description of the wcsprm struct).</span>
<a name="l00375"></a>00375 <span class="comment">*</span>
<a name="l00376"></a>00376 <span class="comment">* wcsset() recognizes the NCP projection and converts it to the equivalent SIN</span>
<a name="l00377"></a>00377 <span class="comment">* projection and likewise translates GLS into SFL. It also translates the</span>
<a name="l00378"></a>00378 <span class="comment">* AIPS spectral types ('FREQ-LSR', 'FELO-HEL', etc.), possibly changing the</span>
<a name="l00379"></a>00379 <span class="comment">* input header keywords wcsprm::ctype and/or wcsprm::specsys if necessary.</span>
<a name="l00380"></a>00380 <span class="comment">*</span>
<a name="l00381"></a>00381 <span class="comment">* Note that this routine need not be called directly; it will be invoked by</span>
<a name="l00382"></a>00382 <span class="comment">* wcsp2s() and wcss2p() if the wcsprm::flag is anything other than a</span>
<a name="l00383"></a>00383 <span class="comment">* predefined magic value.</span>
<a name="l00384"></a>00384 <span class="comment">*</span>
<a name="l00385"></a>00385 <span class="comment">* Given and returned:</span>
<a name="l00386"></a>00386 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00387"></a>00387 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00388"></a>00388 <span class="comment">*</span>
<a name="l00389"></a>00389 <span class="comment">* Function return value:</span>
<a name="l00390"></a>00390 <span class="comment">* int Status return value:</span>
<a name="l00391"></a>00391 <span class="comment">* 0: Success.</span>
<a name="l00392"></a>00392 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00393"></a>00393 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00394"></a>00394 <span class="comment">* 3: Linear transformation matrix is singular.</span>
<a name="l00395"></a>00395 <span class="comment">* 4: Inconsistent or unrecognized coordinate axis</span>
<a name="l00396"></a>00396 <span class="comment">* types.</span>
<a name="l00397"></a>00397 <span class="comment">* 5: Invalid parameter value.</span>
<a name="l00398"></a>00398 <span class="comment">* 6: Invalid coordinate transformation parameters.</span>
<a name="l00399"></a>00399 <span class="comment">* 7: Ill-conditioned coordinate transformation</span>
<a name="l00400"></a>00400 <span class="comment">* parameters.</span>
<a name="l00401"></a>00401 <span class="comment">*</span>
<a name="l00402"></a>00402 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00403"></a>00403 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00404"></a>00404 <span class="comment">*</span>
<a name="l00405"></a>00405 <span class="comment">*</span>
<a name="l00406"></a>00406 <span class="comment">* wcsp2s() - Pixel-to-world transformation</span>
<a name="l00407"></a>00407 <span class="comment">* ----------------------------------------</span>
<a name="l00408"></a>00408 <span class="comment">* wcsp2s() transforms pixel coordinates to world coordinates.</span>
<a name="l00409"></a>00409 <span class="comment">*</span>
<a name="l00410"></a>00410 <span class="comment">* Given and returned:</span>
<a name="l00411"></a>00411 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00412"></a>00412 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00413"></a>00413 <span class="comment">*</span>
<a name="l00414"></a>00414 <span class="comment">* Given:</span>
<a name="l00415"></a>00415 <span class="comment">* ncoord,</span>
<a name="l00416"></a>00416 <span class="comment">* nelem int The number of coordinates, each of vector length</span>
<a name="l00417"></a>00417 <span class="comment">* nelem but containing wcs.naxis coordinate elements.</span>
<a name="l00418"></a>00418 <span class="comment">* Thus nelem must equal or exceed the value of the</span>
<a name="l00419"></a>00419 <span class="comment">* NAXIS keyword unless ncoord == 1, in which case nelem</span>
<a name="l00420"></a>00420 <span class="comment">* is not used.</span>
<a name="l00421"></a>00421 <span class="comment">*</span>
<a name="l00422"></a>00422 <span class="comment">* pixcrd const double[ncoord][nelem]</span>
<a name="l00423"></a>00423 <span class="comment">* Array of pixel coordinates.</span>
<a name="l00424"></a>00424 <span class="comment">*</span>
<a name="l00425"></a>00425 <span class="comment">* Returned:</span>
<a name="l00426"></a>00426 <span class="comment">* imgcrd double[ncoord][nelem]</span>
<a name="l00427"></a>00427 <span class="comment">* Array of intermediate world coordinates. For</span>
<a name="l00428"></a>00428 <span class="comment">* celestial axes, imgcrd[][wcs.lng] and</span>
<a name="l00429"></a>00429 <span class="comment">* imgcrd[][wcs.lat] are the projected x-, and</span>
<a name="l00430"></a>00430 <span class="comment">* y-coordinates in pseudo "degrees". For spectral</span>
<a name="l00431"></a>00431 <span class="comment">* axes, imgcrd[][wcs.spec] is the intermediate spectral</span>
<a name="l00432"></a>00432 <span class="comment">* coordinate, in SI units.</span>
<a name="l00433"></a>00433 <span class="comment">*</span>
<a name="l00434"></a>00434 <span class="comment">* phi,theta double[ncoord]</span>
<a name="l00435"></a>00435 <span class="comment">* Longitude and latitude in the native coordinate system</span>
<a name="l00436"></a>00436 <span class="comment">* of the projection [deg].</span>
<a name="l00437"></a>00437 <span class="comment">*</span>
<a name="l00438"></a>00438 <span class="comment">* world double[ncoord][nelem]</span>
<a name="l00439"></a>00439 <span class="comment">* Array of world coordinates. For celestial axes,</span>
<a name="l00440"></a>00440 <span class="comment">* world[][wcs.lng] and world[][wcs.lat] are the</span>
<a name="l00441"></a>00441 <span class="comment">* celestial longitude and latitude [deg]. For</span>
<a name="l00442"></a>00442 <span class="comment">* spectral axes, imgcrd[][wcs.spec] is the intermediate</span>
<a name="l00443"></a>00443 <span class="comment">* spectral coordinate, in SI units.</span>
<a name="l00444"></a>00444 <span class="comment">*</span>
<a name="l00445"></a>00445 <span class="comment">* stat int[ncoord]</span>
<a name="l00446"></a>00446 <span class="comment">* Status return value for each coordinate:</span>
<a name="l00447"></a>00447 <span class="comment">* 0: Success.</span>
<a name="l00448"></a>00448 <span class="comment">* 1+: A bit mask indicating invalid pixel coordinate</span>
<a name="l00449"></a>00449 <span class="comment">* element(s).</span>
<a name="l00450"></a>00450 <span class="comment">*</span>
<a name="l00451"></a>00451 <span class="comment">* Function return value:</span>
<a name="l00452"></a>00452 <span class="comment">* int Status return value:</span>
<a name="l00453"></a>00453 <span class="comment">* 0: Success.</span>
<a name="l00454"></a>00454 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00455"></a>00455 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00456"></a>00456 <span class="comment">* 3: Linear transformation matrix is singular.</span>
<a name="l00457"></a>00457 <span class="comment">* 4: Inconsistent or unrecognized coordinate axis</span>
<a name="l00458"></a>00458 <span class="comment">* types.</span>
<a name="l00459"></a>00459 <span class="comment">* 5: Invalid parameter value.</span>
<a name="l00460"></a>00460 <span class="comment">* 6: Invalid coordinate transformation parameters.</span>
<a name="l00461"></a>00461 <span class="comment">* 7: Ill-conditioned coordinate transformation</span>
<a name="l00462"></a>00462 <span class="comment">* parameters.</span>
<a name="l00463"></a>00463 <span class="comment">* 8: One or more of the pixel coordinates were</span>
<a name="l00464"></a>00464 <span class="comment">* invalid, as indicated by the stat vector.</span>
<a name="l00465"></a>00465 <span class="comment">*</span>
<a name="l00466"></a>00466 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00467"></a>00467 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00468"></a>00468 <span class="comment">*</span>
<a name="l00469"></a>00469 <span class="comment">*</span>
<a name="l00470"></a>00470 <span class="comment">* wcss2p() - World-to-pixel transformation</span>
<a name="l00471"></a>00471 <span class="comment">* ----------------------------------------</span>
<a name="l00472"></a>00472 <span class="comment">* wcss2p() transforms world coordinates to pixel coordinates.</span>
<a name="l00473"></a>00473 <span class="comment">*</span>
<a name="l00474"></a>00474 <span class="comment">* Given and returned:</span>
<a name="l00475"></a>00475 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00476"></a>00476 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00477"></a>00477 <span class="comment">*</span>
<a name="l00478"></a>00478 <span class="comment">* Given:</span>
<a name="l00479"></a>00479 <span class="comment">* ncoord,</span>
<a name="l00480"></a>00480 <span class="comment">* nelem int The number of coordinates, each of vector length nelem</span>
<a name="l00481"></a>00481 <span class="comment">* but containing wcs.naxis coordinate elements. Thus</span>
<a name="l00482"></a>00482 <span class="comment">* nelem must equal or exceed the value of the NAXIS</span>
<a name="l00483"></a>00483 <span class="comment">* keyword unless ncoord == 1, in which case nelem is not</span>
<a name="l00484"></a>00484 <span class="comment">* used.</span>
<a name="l00485"></a>00485 <span class="comment">*</span>
<a name="l00486"></a>00486 <span class="comment">* world const double[ncoord][nelem]</span>
<a name="l00487"></a>00487 <span class="comment">* Array of world coordinates. For celestial axes,</span>
<a name="l00488"></a>00488 <span class="comment">* world[][wcs.lng] and world[][wcs.lat] are the</span>
<a name="l00489"></a>00489 <span class="comment">* celestial longitude and latitude [deg]. For spectral</span>
<a name="l00490"></a>00490 <span class="comment">* axes, world[][wcs.spec] is the spectral coordinate, in</span>
<a name="l00491"></a>00491 <span class="comment">* SI units.</span>
<a name="l00492"></a>00492 <span class="comment">*</span>
<a name="l00493"></a>00493 <span class="comment">* Returned:</span>
<a name="l00494"></a>00494 <span class="comment">* phi,theta double[ncoord]</span>
<a name="l00495"></a>00495 <span class="comment">* Longitude and latitude in the native coordinate</span>
<a name="l00496"></a>00496 <span class="comment">* system of the projection [deg].</span>
<a name="l00497"></a>00497 <span class="comment">*</span>
<a name="l00498"></a>00498 <span class="comment">* imgcrd double[ncoord][nelem]</span>
<a name="l00499"></a>00499 <span class="comment">* Array of intermediate world coordinates. For</span>
<a name="l00500"></a>00500 <span class="comment">* celestial axes, imgcrd[][wcs.lng] and</span>
<a name="l00501"></a>00501 <span class="comment">* imgcrd[][wcs.lat] are the projected x-, and</span>
<a name="l00502"></a>00502 <span class="comment">* y-coordinates in pseudo "degrees". For quadcube</span>
<a name="l00503"></a>00503 <span class="comment">* projections with a CUBEFACE axis the face number is</span>
<a name="l00504"></a>00504 <span class="comment">* also returned in imgcrd[][wcs.cubeface]. For</span>
<a name="l00505"></a>00505 <span class="comment">* spectral axes, imgcrd[][wcs.spec] is the intermediate</span>
<a name="l00506"></a>00506 <span class="comment">* spectral coordinate, in SI units.</span>
<a name="l00507"></a>00507 <span class="comment">*</span>
<a name="l00508"></a>00508 <span class="comment">* pixcrd double[ncoord][nelem]</span>
<a name="l00509"></a>00509 <span class="comment">* Array of pixel coordinates.</span>
<a name="l00510"></a>00510 <span class="comment">*</span>
<a name="l00511"></a>00511 <span class="comment">* stat int[ncoord]</span>
<a name="l00512"></a>00512 <span class="comment">* Status return value for each coordinate:</span>
<a name="l00513"></a>00513 <span class="comment">* 0: Success.</span>
<a name="l00514"></a>00514 <span class="comment">* 1+: A bit mask indicating invalid world coordinate</span>
<a name="l00515"></a>00515 <span class="comment">* element(s).</span>
<a name="l00516"></a>00516 <span class="comment">*</span>
<a name="l00517"></a>00517 <span class="comment">* Function return value:</span>
<a name="l00518"></a>00518 <span class="comment">* int Status return value:</span>
<a name="l00519"></a>00519 <span class="comment">* 0: Success.</span>
<a name="l00520"></a>00520 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00521"></a>00521 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00522"></a>00522 <span class="comment">* 3: Linear transformation matrix is singular.</span>
<a name="l00523"></a>00523 <span class="comment">* 4: Inconsistent or unrecognized coordinate axis</span>
<a name="l00524"></a>00524 <span class="comment">* types.</span>
<a name="l00525"></a>00525 <span class="comment">* 5: Invalid parameter value.</span>
<a name="l00526"></a>00526 <span class="comment">* 6: Invalid coordinate transformation parameters.</span>
<a name="l00527"></a>00527 <span class="comment">* 7: Ill-conditioned coordinate transformation</span>
<a name="l00528"></a>00528 <span class="comment">* parameters.</span>
<a name="l00529"></a>00529 <span class="comment">* 9: One or more of the world coordinates were</span>
<a name="l00530"></a>00530 <span class="comment">* invalid, as indicated by the stat vector.</span>
<a name="l00531"></a>00531 <span class="comment">*</span>
<a name="l00532"></a>00532 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00533"></a>00533 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00534"></a>00534 <span class="comment">*</span>
<a name="l00535"></a>00535 <span class="comment">*</span>
<a name="l00536"></a>00536 <span class="comment">* wcsmix() - Hybrid coordinate transformation</span>
<a name="l00537"></a>00537 <span class="comment">* -------------------------------------------</span>
<a name="l00538"></a>00538 <span class="comment">* wcsmix(), given either the celestial longitude or latitude plus an element</span>
<a name="l00539"></a>00539 <span class="comment">* of the pixel coordinate, solves for the remaining elements by iterating on</span>
<a name="l00540"></a>00540 <span class="comment">* the unknown celestial coordinate element using wcss2p(). Refer also to the</span>
<a name="l00541"></a>00541 <span class="comment">* notes below.</span>
<a name="l00542"></a>00542 <span class="comment">*</span>
<a name="l00543"></a>00543 <span class="comment">* Given and returned:</span>
<a name="l00544"></a>00544 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00545"></a>00545 <span class="comment">* Indices for the celestial coordinates obtained</span>
<a name="l00546"></a>00546 <span class="comment">* by parsing the wcsprm::ctype[].</span>
<a name="l00547"></a>00547 <span class="comment">*</span>
<a name="l00548"></a>00548 <span class="comment">* Given:</span>
<a name="l00549"></a>00549 <span class="comment">* mixpix int Which element of the pixel coordinate is given.</span>
<a name="l00550"></a>00550 <span class="comment">*</span>
<a name="l00551"></a>00551 <span class="comment">* mixcel int Which element of the celestial coordinate is given:</span>
<a name="l00552"></a>00552 <span class="comment">* 1: Celestial longitude is given in</span>
<a name="l00553"></a>00553 <span class="comment">* world[wcs.lng], latitude returned in</span>
<a name="l00554"></a>00554 <span class="comment">* world[wcs.lat].</span>
<a name="l00555"></a>00555 <span class="comment">* 2: Celestial latitude is given in</span>
<a name="l00556"></a>00556 <span class="comment">* world[wcs.lat], longitude returned in</span>
<a name="l00557"></a>00557 <span class="comment">* world[wcs.lng].</span>
<a name="l00558"></a>00558 <span class="comment">*</span>
<a name="l00559"></a>00559 <span class="comment">* vspan const double[2]</span>
<a name="l00560"></a>00560 <span class="comment">* Solution interval for the celestial coordinate [deg].</span>
<a name="l00561"></a>00561 <span class="comment">* The ordering of the two limits is irrelevant.</span>
<a name="l00562"></a>00562 <span class="comment">* Longitude ranges may be specified with any convenient</span>
<a name="l00563"></a>00563 <span class="comment">* normalization, for example [-120,+120] is the same as</span>
<a name="l00564"></a>00564 <span class="comment">* [240,480], except that the solution will be returned</span>
<a name="l00565"></a>00565 <span class="comment">* with the same normalization, i.e. lie within the</span>
<a name="l00566"></a>00566 <span class="comment">* interval specified.</span>
<a name="l00567"></a>00567 <span class="comment">*</span>
<a name="l00568"></a>00568 <span class="comment">* vstep const double</span>
<a name="l00569"></a>00569 <span class="comment">* Step size for solution search [deg]. If zero, a</span>
<a name="l00570"></a>00570 <span class="comment">* sensible, although perhaps non-optimal default will be</span>
<a name="l00571"></a>00571 <span class="comment">* used.</span>
<a name="l00572"></a>00572 <span class="comment">*</span>
<a name="l00573"></a>00573 <span class="comment">* viter int If a solution is not found then the step size will be</span>
<a name="l00574"></a>00574 <span class="comment">* halved and the search recommenced. viter controls how</span>
<a name="l00575"></a>00575 <span class="comment">* many times the step size is halved. The allowed range</span>
<a name="l00576"></a>00576 <span class="comment">* is 5 - 10.</span>
<a name="l00577"></a>00577 <span class="comment">*</span>
<a name="l00578"></a>00578 <span class="comment">* Given and returned:</span>
<a name="l00579"></a>00579 <span class="comment">* world double[naxis]</span>
<a name="l00580"></a>00580 <span class="comment">* World coordinate elements. world[wcs.lng] and</span>
<a name="l00581"></a>00581 <span class="comment">* world[wcs.lat] are the celestial longitude and</span>
<a name="l00582"></a>00582 <span class="comment">* latitude [deg]. Which is given and which returned</span>
<a name="l00583"></a>00583 <span class="comment">* depends on the value of mixcel. All other elements</span>
<a name="l00584"></a>00584 <span class="comment">* are given.</span>
<a name="l00585"></a>00585 <span class="comment">*</span>
<a name="l00586"></a>00586 <span class="comment">* Returned:</span>
<a name="l00587"></a>00587 <span class="comment">* phi,theta double[naxis]</span>
<a name="l00588"></a>00588 <span class="comment">* Longitude and latitude in the native coordinate</span>
<a name="l00589"></a>00589 <span class="comment">* system of the projection [deg].</span>
<a name="l00590"></a>00590 <span class="comment">*</span>
<a name="l00591"></a>00591 <span class="comment">* imgcrd double[naxis]</span>
<a name="l00592"></a>00592 <span class="comment">* Image coordinate elements. imgcrd[wcs.lng] and</span>
<a name="l00593"></a>00593 <span class="comment">* imgcrd[wcs.lat] are the projected x-, and</span>
<a name="l00594"></a>00594 <span class="comment">* y-coordinates in pseudo "degrees".</span>
<a name="l00595"></a>00595 <span class="comment">*</span>
<a name="l00596"></a>00596 <span class="comment">* Given and returned:</span>
<a name="l00597"></a>00597 <span class="comment">* pixcrd double[naxis]</span>
<a name="l00598"></a>00598 <span class="comment">* Pixel coordinate. The element indicated by mixpix is</span>
<a name="l00599"></a>00599 <span class="comment">* given and the remaining elements are returned.</span>
<a name="l00600"></a>00600 <span class="comment">*</span>
<a name="l00601"></a>00601 <span class="comment">* Function return value:</span>
<a name="l00602"></a>00602 <span class="comment">* int Status return value:</span>
<a name="l00603"></a>00603 <span class="comment">* 0: Success.</span>
<a name="l00604"></a>00604 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00605"></a>00605 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00606"></a>00606 <span class="comment">* 3: Linear transformation matrix is singular.</span>
<a name="l00607"></a>00607 <span class="comment">* 4: Inconsistent or unrecognized coordinate axis</span>
<a name="l00608"></a>00608 <span class="comment">* types.</span>
<a name="l00609"></a>00609 <span class="comment">* 5: Invalid parameter value.</span>
<a name="l00610"></a>00610 <span class="comment">* 6: Invalid coordinate transformation parameters.</span>
<a name="l00611"></a>00611 <span class="comment">* 7: Ill-conditioned coordinate transformation</span>
<a name="l00612"></a>00612 <span class="comment">* parameters.</span>
<a name="l00613"></a>00613 <span class="comment">* 10: Invalid world coordinate.</span>
<a name="l00614"></a>00614 <span class="comment">* 11: No solution found in the specified interval.</span>
<a name="l00615"></a>00615 <span class="comment">*</span>
<a name="l00616"></a>00616 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00617"></a>00617 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00618"></a>00618 <span class="comment">*</span>
<a name="l00619"></a>00619 <span class="comment">* Notes:</span>
<a name="l00620"></a>00620 <span class="comment">* Initially the specified solution interval is checked to see if it's a</span>
<a name="l00621"></a>00621 <span class="comment">* "crossing" interval. If it isn't, a search is made for a crossing</span>
<a name="l00622"></a>00622 <span class="comment">* solution by iterating on the unknown celestial coordinate starting at the</span>
<a name="l00623"></a>00623 <span class="comment">* upper limit of the solution interval and decrementing by the specified</span>
<a name="l00624"></a>00624 <span class="comment">* step size. A crossing is indicated if the trial value of the pixel</span>
<a name="l00625"></a>00625 <span class="comment">* coordinate steps through the value specified. If a crossing interval is</span>
<a name="l00626"></a>00626 <span class="comment">* found then the solution is determined by a modified form of "regula falsi"</span>
<a name="l00627"></a>00627 <span class="comment">* division of the crossing interval. If no crossing interval was found</span>
<a name="l00628"></a>00628 <span class="comment">* within the specified solution interval then a search is made for a</span>
<a name="l00629"></a>00629 <span class="comment">* "non-crossing" solution as may arise from a point of tangency. The</span>
<a name="l00630"></a>00630 <span class="comment">* process is complicated by having to make allowance for the discontinuities</span>
<a name="l00631"></a>00631 <span class="comment">* that occur in all map projections.</span>
<a name="l00632"></a>00632 <span class="comment">*</span>
<a name="l00633"></a>00633 <span class="comment">* Once one solution has been determined others may be found by subsequent</span>
<a name="l00634"></a>00634 <span class="comment">* invokations of wcsmix() with suitably restricted solution intervals.</span>
<a name="l00635"></a>00635 <span class="comment">*</span>
<a name="l00636"></a>00636 <span class="comment">* Note the circumstance that arises when the solution point lies at a native</span>
<a name="l00637"></a>00637 <span class="comment">* pole of a projection in which the pole is represented as a finite curve,</span>
<a name="l00638"></a>00638 <span class="comment">* for example the zenithals and conics. In such cases two or more valid</span>
<a name="l00639"></a>00639 <span class="comment">* solutions may exist but wcsmix() only ever returns one.</span>
<a name="l00640"></a>00640 <span class="comment">*</span>
<a name="l00641"></a>00641 <span class="comment">* Because of its generality wcsmix() is very compute-intensive. For</span>
<a name="l00642"></a>00642 <span class="comment">* compute-limited applications more efficient special-case solvers could be</span>
<a name="l00643"></a>00643 <span class="comment">* written for simple projections, for example non-oblique cylindrical</span>
<a name="l00644"></a>00644 <span class="comment">* projections.</span>
<a name="l00645"></a>00645 <span class="comment">*</span>
<a name="l00646"></a>00646 <span class="comment">*</span>
<a name="l00647"></a>00647 <span class="comment">* wcssptr() - Spectral axis translation</span>
<a name="l00648"></a>00648 <span class="comment">* -------------------------------------</span>
<a name="l00649"></a>00649 <span class="comment">* wcssptr() translates the spectral axis in a wcsprm struct. For example, a</span>
<a name="l00650"></a>00650 <span class="comment">* 'FREQ' axis may be translated into 'ZOPT-F2W' and vice versa.</span>
<a name="l00651"></a>00651 <span class="comment">*</span>
<a name="l00652"></a>00652 <span class="comment">* Given and returned:</span>
<a name="l00653"></a>00653 <span class="comment">* wcs struct wcsprm*</span>
<a name="l00654"></a>00654 <span class="comment">* Coordinate transformation parameters.</span>
<a name="l00655"></a>00655 <span class="comment">*</span>
<a name="l00656"></a>00656 <span class="comment">* i int* Index of the spectral axis (0-relative). If given < 0</span>
<a name="l00657"></a>00657 <span class="comment">* it will be set to the first spectral axis identified</span>
<a name="l00658"></a>00658 <span class="comment">* from the ctype[] keyvalues in the wcsprm struct.</span>
<a name="l00659"></a>00659 <span class="comment">*</span>
<a name="l00660"></a>00660 <span class="comment">* ctype char[9] Desired spectral CTYPEia. Wildcarding may be used as</span>
<a name="l00661"></a>00661 <span class="comment">* for the ctypeS2 argument to spctrn() as described in</span>
<a name="l00662"></a>00662 <span class="comment">* the prologue of spc.h, i.e. if the final three</span>
<a name="l00663"></a>00663 <span class="comment">* characters are specified as "???", or if just the</span>
<a name="l00664"></a>00664 <span class="comment">* eighth character is specified as '?', the correct</span>
<a name="l00665"></a>00665 <span class="comment">* algorithm code will be substituted and returned.</span>
<a name="l00666"></a>00666 <span class="comment">*</span>
<a name="l00667"></a>00667 <span class="comment">* Function return value:</span>
<a name="l00668"></a>00668 <span class="comment">* int Status return value:</span>
<a name="l00669"></a>00669 <span class="comment">* 0: Success.</span>
<a name="l00670"></a>00670 <span class="comment">* 1: Null wcsprm pointer passed.</span>
<a name="l00671"></a>00671 <span class="comment">* 2: Memory allocation failed.</span>
<a name="l00672"></a>00672 <span class="comment">* 3: Linear transformation matrix is singular.</span>
<a name="l00673"></a>00673 <span class="comment">* 4: Inconsistent or unrecognized coordinate axis</span>
<a name="l00674"></a>00674 <span class="comment">* types.</span>
<a name="l00675"></a>00675 <span class="comment">* 5: Invalid parameter value.</span>
<a name="l00676"></a>00676 <span class="comment">* 6: Invalid coordinate transformation parameters.</span>
<a name="l00677"></a>00677 <span class="comment">* 7: Ill-conditioned coordinate transformation</span>
<a name="l00678"></a>00678 <span class="comment">* parameters.</span>
<a name="l00679"></a>00679 <span class="comment">* 12: Invalid subimage specification (no spectral</span>
<a name="l00680"></a>00680 <span class="comment">* axis).</span>
<a name="l00681"></a>00681 <span class="comment">*</span>
<a name="l00682"></a>00682 <span class="comment">* For returns > 1, a detailed error message is set in</span>
<a name="l00683"></a>00683 <span class="comment">* wcsprm::err if enabled, see wcserr_enable().</span>
<a name="l00684"></a>00684 <span class="comment">*</span>
<a name="l00685"></a>00685 <span class="comment">*</span>
<a name="l00686"></a>00686 <span class="comment">* wcsprm struct - Coordinate transformation parameters</span>
<a name="l00687"></a>00687 <span class="comment">* ----------------------------------------------------</span>
<a name="l00688"></a>00688 <span class="comment">* The wcsprm struct contains information required to transform world</span>
<a name="l00689"></a>00689 <span class="comment">* coordinates. It consists of certain members that must be set by the user</span>
<a name="l00690"></a>00690 <span class="comment">* ("given") and others that are set by the WCSLIB routines ("returned").</span>
<a name="l00691"></a>00691 <span class="comment">* Some of the former are not actually required for transforming coordinates.</span>
<a name="l00692"></a>00692 <span class="comment">* These are described as "auxiliary"; the struct simply provides a place to</span>
<a name="l00693"></a>00693 <span class="comment">* store them, though they may be used by wcshdo() in constructing a FITS</span>
<a name="l00694"></a>00694 <span class="comment">* header from a wcsprm struct. Some of the returned values are supplied for</span>
<a name="l00695"></a>00695 <span class="comment">* informational purposes and others are for internal use only as indicated.</span>
<a name="l00696"></a>00696 <span class="comment">*</span>
<a name="l00697"></a>00697 <span class="comment">* In practice, it is expected that a WCS parser would scan the FITS header to</span>
<a name="l00698"></a>00698 <span class="comment">* determine the number of coordinate axes. It would then use wcsini() to</span>
<a name="l00699"></a>00699 <span class="comment">* allocate memory for arrays in the wcsprm struct and set default values.</span>
<a name="l00700"></a>00700 <span class="comment">* Then as it reread the header and identified each WCS keyrecord it would load</span>
<a name="l00701"></a>00701 <span class="comment">* the value into the relevant wcsprm array element. This is essentially what</span>
<a name="l00702"></a>00702 <span class="comment">* wcspih() does - refer to the prologue of wcshdr.h. As the final step,</span>
<a name="l00703"></a>00703 <span class="comment">* wcsset() is invoked, either directly or indirectly, to set the derived</span>
<a name="l00704"></a>00704 <span class="comment">* members of the wcsprm struct. wcsset() strips off trailing blanks in all</span>
<a name="l00705"></a>00705 <span class="comment">* string members and null-fills the character array.</span>
<a name="l00706"></a>00706 <span class="comment">*</span>
<a name="l00707"></a>00707 <span class="comment">* int flag</span>
<a name="l00708"></a>00708 <span class="comment">* (Given and returned) This flag must be set to zero whenever any of the</span>
<a name="l00709"></a>00709 <span class="comment">* following wcsprm struct members are set or changed:</span>
<a name="l00710"></a>00710 <span class="comment">*</span>
<a name="l00711"></a>00711 <span class="comment">* - wcsprm::naxis (q.v., not normally set by the user),</span>
<a name="l00712"></a>00712 <span class="comment">* - wcsprm::crpix,</span>
<a name="l00713"></a>00713 <span class="comment">* - wcsprm::pc,</span>
<a name="l00714"></a>00714 <span class="comment">* - wcsprm::cdelt,</span>
<a name="l00715"></a>00715 <span class="comment">* - wcsprm::crval,</span>
<a name="l00716"></a>00716 <span class="comment">* - wcsprm::cunit,</span>
<a name="l00717"></a>00717 <span class="comment">* - wcsprm::ctype,</span>
<a name="l00718"></a>00718 <span class="comment">* - wcsprm::lonpole,</span>
<a name="l00719"></a>00719 <span class="comment">* - wcsprm::latpole,</span>
<a name="l00720"></a>00720 <span class="comment">* - wcsprm::restfrq,</span>
<a name="l00721"></a>00721 <span class="comment">* - wcsprm::restwav,</span>
<a name="l00722"></a>00722 <span class="comment">* - wcsprm::npv,</span>
<a name="l00723"></a>00723 <span class="comment">* - wcsprm::pv,</span>
<a name="l00724"></a>00724 <span class="comment">* - wcsprm::nps,</span>
<a name="l00725"></a>00725 <span class="comment">* - wcsprm::ps,</span>
<a name="l00726"></a>00726 <span class="comment">* - wcsprm::cd,</span>
<a name="l00727"></a>00727 <span class="comment">* - wcsprm::crota,</span>
<a name="l00728"></a>00728 <span class="comment">* - wcsprm::altlin.</span>
<a name="l00729"></a>00729 <span class="comment">*</span>
<a name="l00730"></a>00730 <span class="comment">* This signals the initialization routine, wcsset(), to recompute the</span>
<a name="l00731"></a>00731 <span class="comment">* returned members of the celprm struct. celset() will reset flag to</span>
<a name="l00732"></a>00732 <span class="comment">* indicate that this has been done.</span>
<a name="l00733"></a>00733 <span class="comment">*</span>
<a name="l00734"></a>00734 <span class="comment">* PLEASE NOTE: flag should be set to -1 when wcsini() is called for the</span>
<a name="l00735"></a>00735 <span class="comment">* first time for a particular wcsprm struct in order to initialize memory</span>
<a name="l00736"></a>00736 <span class="comment">* management. It must ONLY be used on the first initialization otherwise</span>
<a name="l00737"></a>00737 <span class="comment">* memory leaks may result.</span>
<a name="l00738"></a>00738 <span class="comment">*</span>
<a name="l00739"></a>00739 <span class="comment">* int naxis</span>
<a name="l00740"></a>00740 <span class="comment">* (Given or returned) Number of pixel and world coordinate elements.</span>
<a name="l00741"></a>00741 <span class="comment">*</span>
<a name="l00742"></a>00742 <span class="comment">* If wcsini() is used to initialize the linprm struct (as would normally</span>
<a name="l00743"></a>00743 <span class="comment">* be the case) then it will set naxis from the value passed to it as a</span>
<a name="l00744"></a>00744 <span class="comment">* function argument. The user should not subsequently modify it.</span>
<a name="l00745"></a>00745 <span class="comment">*</span>
<a name="l00746"></a>00746 <span class="comment">* double *crpix</span>
<a name="l00747"></a>00747 <span class="comment">* (Given) Address of the first element of an array of double containing</span>
<a name="l00748"></a>00748 <span class="comment">* the coordinate reference pixel, CRPIXja.</span>
<a name="l00749"></a>00749 <span class="comment">*</span>
<a name="l00750"></a>00750 <span class="comment">* double *pc</span>
<a name="l00751"></a>00751 <span class="comment">* (Given) Address of the first element of the PCi_ja (pixel coordinate)</span>
<a name="l00752"></a>00752 <span class="comment">* transformation matrix. The expected order is</span>
<a name="l00753"></a>00753 <span class="comment">*</span>
<a name="l00754"></a>00754 <span class="comment">= struct wcsprm wcs;</span>
<a name="l00755"></a>00755 <span class="comment">= wcs.pc = {PC1_1, PC1_2, PC2_1, PC2_2};</span>
<a name="l00756"></a>00756 <span class="comment">*</span>
<a name="l00757"></a>00757 <span class="comment">* This may be constructed conveniently from a 2-D array via</span>
<a name="l00758"></a>00758 <span class="comment">*</span>
<a name="l00759"></a>00759 <span class="comment">= double m[2][2] = {{PC1_1, PC1_2},</span>
<a name="l00760"></a>00760 <span class="comment">= {PC2_1, PC2_2}};</span>
<a name="l00761"></a>00761 <span class="comment">*</span>
<a name="l00762"></a>00762 <span class="comment">* which is equivalent to</span>
<a name="l00763"></a>00763 <span class="comment">*</span>
<a name="l00764"></a>00764 <span class="comment">= double m[2][2];</span>
<a name="l00765"></a>00765 <span class="comment">= m[0][0] = PC1_1;</span>
<a name="l00766"></a>00766 <span class="comment">= m[0][1] = PC1_2;</span>
<a name="l00767"></a>00767 <span class="comment">= m[1][0] = PC2_1;</span>
<a name="l00768"></a>00768 <span class="comment">= m[1][1] = PC2_2;</span>
<a name="l00769"></a>00769 <span class="comment">*</span>
<a name="l00770"></a>00770 <span class="comment">* The storage order for this 2-D array is the same as for the 1-D array,</span>
<a name="l00771"></a>00771 <span class="comment">* whence</span>
<a name="l00772"></a>00772 <span class="comment">*</span>
<a name="l00773"></a>00773 <span class="comment">= wcs.pc = *m;</span>
<a name="l00774"></a>00774 <span class="comment">*</span>
<a name="l00775"></a>00775 <span class="comment">* would be legitimate.</span>
<a name="l00776"></a>00776 <span class="comment">*</span>
<a name="l00777"></a>00777 <span class="comment">* double *cdelt</span>
<a name="l00778"></a>00778 <span class="comment">* (Given) Address of the first element of an array of double containing</span>
<a name="l00779"></a>00779 <span class="comment">* the coordinate increments, CDELTia.</span>
<a name="l00780"></a>00780 <span class="comment">*</span>
<a name="l00781"></a>00781 <span class="comment">* double *crval</span>
<a name="l00782"></a>00782 <span class="comment">* (Given) Address of the first element of an array of double containing</span>
<a name="l00783"></a>00783 <span class="comment">* the coordinate reference values, CRVALia.</span>
<a name="l00784"></a>00784 <span class="comment">*</span>
<a name="l00785"></a>00785 <span class="comment">* char (*cunit)[72]</span>
<a name="l00786"></a>00786 <span class="comment">* (Given) Address of the first element of an array of char[72] containing</span>
<a name="l00787"></a>00787 <span class="comment">* the CUNITia keyvalues which define the units of measurement of the</span>
<a name="l00788"></a>00788 <span class="comment">* CRVALia, CDELTia, and CDi_ja keywords.</span>
<a name="l00789"></a>00789 <span class="comment">*</span>
<a name="l00790"></a>00790 <span class="comment">* As CUNITia is an optional header keyword, cunit[][72] may be left blank</span>
<a name="l00791"></a>00791 <span class="comment">* but otherwise is expected to contain a standard units specification as</span>
<a name="l00792"></a>00792 <span class="comment">* defined by WCS Paper I. Utility function wcsutrn(), described in</span>
<a name="l00793"></a>00793 <span class="comment">* wcsunits.h, is available to translate commonly used non-standard units</span>
<a name="l00794"></a>00794 <span class="comment">* specifications but this must be done as a separate step before invoking</span>
<a name="l00795"></a>00795 <span class="comment">* wcsset().</span>
<a name="l00796"></a>00796 <span class="comment">*</span>
<a name="l00797"></a>00797 <span class="comment">* For celestial axes, if cunit[][72] is not blank, wcsset() uses</span>
<a name="l00798"></a>00798 <span class="comment">* wcsunits() to parse it and scale cdelt[], crval[], and cd[][*] to</span>
<a name="l00799"></a>00799 <span class="comment">* degrees. It then resets cunit[][72] to "deg".</span>
<a name="l00800"></a>00800 <span class="comment">*</span>
<a name="l00801"></a>00801 <span class="comment">* For spectral axes, if cunit[][72] is not blank, wcsset() uses wcsunits()</span>
<a name="l00802"></a>00802 <span class="comment">* to parse it and scale cdelt[], crval[], and cd[][*] to SI units. It</span>
<a name="l00803"></a>00803 <span class="comment">* then resets cunit[][72] accordingly.</span>
<a name="l00804"></a>00804 <span class="comment">*</span>
<a name="l00805"></a>00805 <span class="comment">* wcsset() ignores cunit[][72] for other coordinate types; cunit[][72] may</span>
<a name="l00806"></a>00806 <span class="comment">* be used to label coordinate values.</span>
<a name="l00807"></a>00807 <span class="comment">*</span>
<a name="l00808"></a>00808 <span class="comment">* These variables accomodate the longest allowed string-valued FITS</span>
<a name="l00809"></a>00809 <span class="comment">* keyword, being limited to 68 characters, plus the null-terminating</span>
<a name="l00810"></a>00810 <span class="comment">* character.</span>
<a name="l00811"></a>00811 <span class="comment">*</span>
<a name="l00812"></a>00812 <span class="comment">* char (*ctype)[72]</span>
<a name="l00813"></a>00813 <span class="comment">* (Given) Address of the first element of an array of char[72] containing</span>
<a name="l00814"></a>00814 <span class="comment">* the coordinate axis types, CTYPEia.</span>
<a name="l00815"></a>00815 <span class="comment">*</span>
<a name="l00816"></a>00816 <span class="comment">* The ctype[][72] keyword values must be in upper case and there must be</span>
<a name="l00817"></a>00817 <span class="comment">* zero or one pair of matched celestial axis types, and zero or one</span>
<a name="l00818"></a>00818 <span class="comment">* spectral axis. The ctype[][72] strings should be padded with blanks on</span>
<a name="l00819"></a>00819 <span class="comment">* the right and null-terminated so that they are at least eight characters</span>
<a name="l00820"></a>00820 <span class="comment">* in length.</span>
<a name="l00821"></a>00821 <span class="comment">*</span>
<a name="l00822"></a>00822 <span class="comment">* These variables accomodate the longest allowed string-valued FITS</span>
<a name="l00823"></a>00823 <span class="comment">* keyword, being limited to 68 characters, plus the null-terminating</span>
<a name="l00824"></a>00824 <span class="comment">* character.</span>
<a name="l00825"></a>00825 <span class="comment">*</span>
<a name="l00826"></a>00826 <span class="comment">* double lonpole</span>
<a name="l00827"></a>00827 <span class="comment">* (Given and returned) The native longitude of the celestial pole, phi_p,</span>
<a name="l00828"></a>00828 <span class="comment">* given by LONPOLEa [deg] or by PVi_2a [deg] attached to the longitude</span>
<a name="l00829"></a>00829 <span class="comment">* axis which takes precedence if defined, and ...</span>
<a name="l00830"></a>00830 <span class="comment">* double latpole</span>
<a name="l00831"></a>00831 <span class="comment">* (Given and returned) ... the native latitude of the celestial pole,</span>
<a name="l00832"></a>00832 <span class="comment">* theta_p, given by LATPOLEa [deg] or by PVi_3a [deg] attached to the</span>
<a name="l00833"></a>00833 <span class="comment">* longitude axis which takes precedence if defined.</span>
<a name="l00834"></a>00834 <span class="comment">*</span>
<a name="l00835"></a>00835 <span class="comment">* lonpole and latpole may be left to default to values set by wcsini()</span>
<a name="l00836"></a>00836 <span class="comment">* (see celprm::ref), but in any case they will be reset by wcsset() to</span>
<a name="l00837"></a>00837 <span class="comment">* the values actually used. Note therefore that if the wcsprm struct is</span>
<a name="l00838"></a>00838 <span class="comment">* reused without resetting them, whether directly or via wcsini(), they</span>
<a name="l00839"></a>00839 <span class="comment">* will no longer have their default values.</span>
<a name="l00840"></a>00840 <span class="comment">*</span>
<a name="l00841"></a>00841 <span class="comment">* double restfrq</span>
<a name="l00842"></a>00842 <span class="comment">* (Given) The rest frequency [Hz], and/or ...</span>
<a name="l00843"></a>00843 <span class="comment">* double restwav</span>
<a name="l00844"></a>00844 <span class="comment">* (Given) ... the rest wavelength in vacuuo [m], only one of which need be</span>
<a name="l00845"></a>00845 <span class="comment">* given, the other should be set to zero.</span>
<a name="l00846"></a>00846 <span class="comment">*</span>
<a name="l00847"></a>00847 <span class="comment">* int npv</span>
<a name="l00848"></a>00848 <span class="comment">* (Given) The number of entries in the wcsprm::pv[] array.</span>
<a name="l00849"></a>00849 <span class="comment">*</span>
<a name="l00850"></a>00850 <span class="comment">* int npvmax</span>
<a name="l00851"></a>00851 <span class="comment">* (Given or returned) The length of the wcsprm::pv[] array.</span>
<a name="l00852"></a>00852 <span class="comment">*</span>
<a name="l00853"></a>00853 <span class="comment">* npvmax will be set by wcsini() if it allocates memory for wcsprm::pv[],</span>
<a name="l00854"></a>00854 <span class="comment">* otherwise it must be set by the user. See also wcsnpv().</span>
<a name="l00855"></a>00855 <span class="comment">*</span>
<a name="l00856"></a>00856 <span class="comment">* struct pvcard *pv</span>
<a name="l00857"></a>00857 <span class="comment">* (Given or returned) Address of the first element of an array of length</span>
<a name="l00858"></a>00858 <span class="comment">* npvmax of pvcard structs. Set by wcsini() if it allocates memory for</span>
<a name="l00859"></a>00859 <span class="comment">* pv[], otherwise it must be set by the user. See also wcsnpv().</span>
<a name="l00860"></a>00860 <span class="comment">*</span>
<a name="l00861"></a>00861 <span class="comment">* As a FITS header parser encounters each PVi_ma keyword it should load it</span>
<a name="l00862"></a>00862 <span class="comment">* into a pvcard struct in the array and increment npv. wcsset()</span>
<a name="l00863"></a>00863 <span class="comment">* interprets these as required.</span>
<a name="l00864"></a>00864 <span class="comment">*</span>
<a name="l00865"></a>00865 <span class="comment">* Note that, if they were not given, wcsset() resets the entries for</span>
<a name="l00866"></a>00866 <span class="comment">* PVi_1a, PVi_2a, PVi_3a, and PVi_4a for longitude axis i to match</span>
<a name="l00867"></a>00867 <span class="comment">* phi_0 and theta_0 (the native longitude and latitude of the reference</span>
<a name="l00868"></a>00868 <span class="comment">* point), LONPOLEa and LATPOLEa respectively.</span>
<a name="l00869"></a>00869 <span class="comment">*</span>
<a name="l00870"></a>00870 <span class="comment">* int nps</span>
<a name="l00871"></a>00871 <span class="comment">* (Given) The number of entries in the wcsprm::ps[] array.</span>
<a name="l00872"></a>00872 <span class="comment">*</span>
<a name="l00873"></a>00873 <span class="comment">* int npsmax</span>
<a name="l00874"></a>00874 <span class="comment">* (Given or returned) The length of the wcsprm::ps[] array.</span>
<a name="l00875"></a>00875 <span class="comment">*</span>
<a name="l00876"></a>00876 <span class="comment">* npsmax will be set by wcsini() if it allocates memory for wcsprm::ps[],</span>
<a name="l00877"></a>00877 <span class="comment">* otherwise it must be set by the user. See also wcsnps().</span>
<a name="l00878"></a>00878 <span class="comment">*</span>
<a name="l00879"></a>00879 <span class="comment">* struct pscard *ps</span>
<a name="l00880"></a>00880 <span class="comment">* (Given or returned) Address of the first element of an array of length</span>
<a name="l00881"></a>00881 <span class="comment">* npsmax of pscard structs. Set by wcsini() if it allocates memory for</span>
<a name="l00882"></a>00882 <span class="comment">* ps[], otherwise it must be set by the user. See also wcsnps().</span>
<a name="l00883"></a>00883 <span class="comment">*</span>
<a name="l00884"></a>00884 <span class="comment">* As a FITS header parser encounters each PSi_ma keyword it should load it</span>
<a name="l00885"></a>00885 <span class="comment">* into a pscard struct in the array and increment nps. wcsset()</span>
<a name="l00886"></a>00886 <span class="comment">* interprets these as required (currently no PSi_ma keyvalues are</span>
<a name="l00887"></a>00887 <span class="comment">* recognized).</span>
<a name="l00888"></a>00888 <span class="comment">*</span>
<a name="l00889"></a>00889 <span class="comment">* double *cd</span>
<a name="l00890"></a>00890 <span class="comment">* (Given) For historical compatibility, the wcsprm struct supports two</span>
<a name="l00891"></a>00891 <span class="comment">* alternate specifications of the linear transformation matrix, those</span>
<a name="l00892"></a>00892 <span class="comment">* associated with the CDi_ja keywords, and ...</span>
<a name="l00893"></a>00893 <span class="comment">* double *crota</span>
<a name="l00894"></a>00894 <span class="comment">* (Given) ... those associated with the CROTAia keywords. Although these</span>
<a name="l00895"></a>00895 <span class="comment">* may not formally co-exist with PCi_ja, the approach taken here is simply</span>
<a name="l00896"></a>00896 <span class="comment">* to ignore them if given in conjunction with PCi_ja.</span>
<a name="l00897"></a>00897 <span class="comment">*</span>
<a name="l00898"></a>00898 <span class="comment">* int altlin</span>
<a name="l00899"></a>00899 <span class="comment">* (Given) altlin is a bit flag that denotes which of the PCi_ja, CDi_ja</span>
<a name="l00900"></a>00900 <span class="comment">* and CROTAia keywords are present in the header:</span>
<a name="l00901"></a>00901 <span class="comment">*</span>
<a name="l00902"></a>00902 <span class="comment">* - Bit 0: PCi_ja is present.</span>
<a name="l00903"></a>00903 <span class="comment">*</span>
<a name="l00904"></a>00904 <span class="comment">* - Bit 1: CDi_ja is present.</span>
<a name="l00905"></a>00905 <span class="comment">*</span>
<a name="l00906"></a>00906 <span class="comment">* Matrix elements in the IRAF convention are</span>
<a name="l00907"></a>00907 <span class="comment">* equivalent to the product CDi_ja = CDELTia * PCi_ja, but the</span>
<a name="l00908"></a>00908 <span class="comment">* defaults differ from that of the PCi_ja matrix. If one or more</span>
<a name="l00909"></a>00909 <span class="comment">* CDi_ja keywords are present then all unspecified CDi_ja default to</span>
<a name="l00910"></a>00910 <span class="comment">* zero. If no CDi_ja (or CROTAia) keywords are present, then the</span>
<a name="l00911"></a>00911 <span class="comment">* header is assumed to be in PCi_ja form whether or not any PCi_ja</span>
<a name="l00912"></a>00912 <span class="comment">* keywords are present since this results in an interpretation of</span>
<a name="l00913"></a>00913 <span class="comment">* CDELTia consistent with the original FITS specification.</span>
<a name="l00914"></a>00914 <span class="comment">*</span>
<a name="l00915"></a>00915 <span class="comment">* While CDi_ja may not formally co-exist with PCi_ja, it may co-exist</span>
<a name="l00916"></a>00916 <span class="comment">* with CDELTia and CROTAia which are to be ignored.</span>
<a name="l00917"></a>00917 <span class="comment">*</span>
<a name="l00918"></a>00918 <span class="comment">* - Bit 2: CROTAia is present.</span>
<a name="l00919"></a>00919 <span class="comment">*</span>
<a name="l00920"></a>00920 <span class="comment">* In the AIPS convention, CROTAia may only be</span>
<a name="l00921"></a>00921 <span class="comment">* associated with the latitude axis of a celestial axis pair. It</span>
<a name="l00922"></a>00922 <span class="comment">* specifies a rotation in the image plane that is applied AFTER the</span>
<a name="l00923"></a>00923 <span class="comment">* CDELTia; any other CROTAia keywords are ignored.</span>
<a name="l00924"></a>00924 <span class="comment">*</span>
<a name="l00925"></a>00925 <span class="comment">* CROTAia may not formally co-exist with PCi_ja.</span>
<a name="l00926"></a>00926 <span class="comment">*</span>
<a name="l00927"></a>00927 <span class="comment">* CROTAia and CDELTia may formally co-exist with CDi_ja but if so are to</span>
<a name="l00928"></a>00928 <span class="comment">* be ignored.</span>
<a name="l00929"></a>00929 <span class="comment">*</span>
<a name="l00930"></a>00930 <span class="comment">* CDi_ja and CROTAia keywords, if found, are to be stored in the</span>
<a name="l00931"></a>00931 <span class="comment">* wcsprm::cd and wcsprm::crota arrays which are dimensioned similarly to</span>
<a name="l00932"></a>00932 <span class="comment">* wcsprm::pc and wcsprm::cdelt. FITS</span>
<a name="l00933"></a>00933 <span class="comment">* header parsers should use the following procedure:</span>
<a name="l00934"></a>00934 <span class="comment">*</span>
<a name="l00935"></a>00935 <span class="comment">* - Whenever a PCi_ja keyword is encountered: altlin |= 1;</span>
<a name="l00936"></a>00936 <span class="comment">*</span>
<a name="l00937"></a>00937 <span class="comment">* - Whenever a CDi_ja keyword is encountered: altlin |= 2;</span>
<a name="l00938"></a>00938 <span class="comment">*</span>
<a name="l00939"></a>00939 <span class="comment">* - Whenever a CROTAia keyword is encountered: altlin |= 4;</span>
<a name="l00940"></a>00940 <span class="comment">*</span>
<a name="l00941"></a>00941 <span class="comment">* If none of these bits are set the PCi_ja representation results, i.e.</span>
<a name="l00942"></a>00942 <span class="comment">* wcsprm::pc and wcsprm::cdelt will be used as given.</span>
<a name="l00943"></a>00943 <span class="comment">*</span>
<a name="l00944"></a>00944 <span class="comment">* These alternate specifications of the linear transformation matrix are</span>
<a name="l00945"></a>00945 <span class="comment">* translated immediately to PCi_ja by wcsset() and are invisible to the</span>
<a name="l00946"></a>00946 <span class="comment">* lower-level WCSLIB routines. In particular, wcsset() resets</span>
<a name="l00947"></a>00947 <span class="comment">* wcsprm::cdelt to unity if CDi_ja is present (and no PCi_ja).</span>
<a name="l00948"></a>00948 <span class="comment">*</span>
<a name="l00949"></a>00949 <span class="comment">* If CROTAia are present but none is associated with the latitude axis</span>
<a name="l00950"></a>00950 <span class="comment">* (and no PCi_ja or CDi_ja), then wcsset() reverts to a unity PCi_ja</span>
<a name="l00951"></a>00951 <span class="comment">* matrix.</span>
<a name="l00952"></a>00952 <span class="comment">*</span>
<a name="l00953"></a>00953 <span class="comment">* int velref</span>
<a name="l00954"></a>00954 <span class="comment">* (Given) AIPS velocity code VELREF, refer to spcaips().</span>
<a name="l00955"></a>00955 <span class="comment">*</span>
<a name="l00956"></a>00956 <span class="comment">* char alt[4]</span>
<a name="l00957"></a>00957 <span class="comment">* (Given, auxiliary) Character code for alternate coordinate descriptions</span>
<a name="l00958"></a>00958 <span class="comment">* (i.e. the 'a' in keyword names such as CTYPEia). This is blank for the</span>
<a name="l00959"></a>00959 <span class="comment">* primary coordinate description, or one of the 26 upper-case letters,</span>
<a name="l00960"></a>00960 <span class="comment">* A-Z.</span>
<a name="l00961"></a>00961 <span class="comment">*</span>
<a name="l00962"></a>00962 <span class="comment">* An array of four characters is provided for alignment purposes, only the</span>
<a name="l00963"></a>00963 <span class="comment">* first is used.</span>
<a name="l00964"></a>00964 <span class="comment">*</span>
<a name="l00965"></a>00965 <span class="comment">* int colnum</span>
<a name="l00966"></a>00966 <span class="comment">* (Given, auxiliary) Where the coordinate representation is associated</span>
<a name="l00967"></a>00967 <span class="comment">* with an image-array column in a FITS binary table, this variable may be</span>
<a name="l00968"></a>00968 <span class="comment">* used to record the relevant column number.</span>
<a name="l00969"></a>00969 <span class="comment">*</span>
<a name="l00970"></a>00970 <span class="comment">* It should be set to zero for an image header or pixel list.</span>
<a name="l00971"></a>00971 <span class="comment">*</span>
<a name="l00972"></a>00972 <span class="comment">* int *colax</span>
<a name="l00973"></a>00973 <span class="comment">* (Given, auxiliary) Address of the first element of an array of int</span>
<a name="l00974"></a>00974 <span class="comment">* recording the column numbers for each axis in a pixel list.</span>
<a name="l00975"></a>00975 <span class="comment">*</span>
<a name="l00976"></a>00976 <span class="comment">* The array elements should be set to zero for an image header or image</span>
<a name="l00977"></a>00977 <span class="comment">* array in a binary table.</span>
<a name="l00978"></a>00978 <span class="comment">*</span>
<a name="l00979"></a>00979 <span class="comment">* char (*cname)[72]</span>
<a name="l00980"></a>00980 <span class="comment">* (Given, auxiliary) The address of the first element of an array of</span>
<a name="l00981"></a>00981 <span class="comment">* char[72] containing the coordinate axis names, CNAMEia.</span>
<a name="l00982"></a>00982 <span class="comment">*</span>
<a name="l00983"></a>00983 <span class="comment">* These variables accomodate the longest allowed string-valued FITS</span>
<a name="l00984"></a>00984 <span class="comment">* keyword, being limited to 68 characters, plus the null-terminating</span>
<a name="l00985"></a>00985 <span class="comment">* character.</span>
<a name="l00986"></a>00986 <span class="comment">*</span>
<a name="l00987"></a>00987 <span class="comment">* double *crder</span>
<a name="l00988"></a>00988 <span class="comment">* (Given, auxiliary) Address of the first element of an array of double</span>
<a name="l00989"></a>00989 <span class="comment">* recording the random error in the coordinate value, CRDERia.</span>
<a name="l00990"></a>00990 <span class="comment">* double *csyer</span>
<a name="l00991"></a>00991 <span class="comment">* (Given, auxiliary) Address of the first element of an array of double</span>
<a name="l00992"></a>00992 <span class="comment">* recording the systematic error in the coordinate value, CSYERia.</span>
<a name="l00993"></a>00993 <span class="comment">*</span>
<a name="l00994"></a>00994 <span class="comment">* char dateavg[72]</span>
<a name="l00995"></a>00995 <span class="comment">* (Given, auxiliary) The date of a representative mid-point of the</span>
<a name="l00996"></a>00996 <span class="comment">* observation in ISO format, yyyy-mm-ddThh:mm:ss.</span>
<a name="l00997"></a>00997 <span class="comment">* char dateobs[72]</span>
<a name="l00998"></a>00998 <span class="comment">* (Given, auxiliary) The date of the start of the observation unless</span>
<a name="l00999"></a>00999 <span class="comment">* otherwise explained in the comment field of the DATE-OBS keyword, in</span>
<a name="l01000"></a>01000 <span class="comment">* ISO format, yyyy-mm-ddThh:mm:ss.</span>
<a name="l01001"></a>01001 <span class="comment">*</span>
<a name="l01002"></a>01002 <span class="comment">* double equinox</span>
<a name="l01003"></a>01003 <span class="comment">* (Given, auxiliary) The equinox associated with dynamical equatorial or</span>
<a name="l01004"></a>01004 <span class="comment">* ecliptic coordinate systems, EQUINOXa (or EPOCH in older headers). Not</span>
<a name="l01005"></a>01005 <span class="comment">* applicable to ICRS equatorial or ecliptic coordinates.</span>
<a name="l01006"></a>01006 <span class="comment">*</span>
<a name="l01007"></a>01007 <span class="comment">* double mjdavg</span>
<a name="l01008"></a>01008 <span class="comment">* (Given, auxiliary) Modified Julian Date (MJD = JD - 2400000.5), MJD-AVG,</span>
<a name="l01009"></a>01009 <span class="comment">* corresponding to DATE-AVG.</span>
<a name="l01010"></a>01010 <span class="comment">* double mjdobs</span>
<a name="l01011"></a>01011 <span class="comment">* (Given, auxiliary) Modified Julian Date (MJD = JD - 2400000.5), MJD-OBS,</span>
<a name="l01012"></a>01012 <span class="comment">* corresponding to DATE-OBS.</span>
<a name="l01013"></a>01013 <span class="comment">*</span>
<a name="l01014"></a>01014 <span class="comment">* double obsgeo[3]</span>
<a name="l01015"></a>01015 <span class="comment">* (Given, auxiliary) Location of the observer in a standard terrestrial</span>
<a name="l01016"></a>01016 <span class="comment">* reference frame, OBSGEO-X, OBSGEO-Y, OBSGEO-Z [m].</span>
<a name="l01017"></a>01017 <span class="comment">*</span>
<a name="l01018"></a>01018 <span class="comment">* char radesys[72]</span>
<a name="l01019"></a>01019 <span class="comment">* (Given, auxiliary) The equatorial or ecliptic coordinate system type,</span>
<a name="l01020"></a>01020 <span class="comment">* RADESYSa.</span>
<a name="l01021"></a>01021 <span class="comment">*</span>
<a name="l01022"></a>01022 <span class="comment">* char specsys[72]</span>
<a name="l01023"></a>01023 <span class="comment">* (Given, auxiliary) Spectral reference frame (standard of rest),</span>
<a name="l01024"></a>01024 <span class="comment">* SPECSYSa, and ...</span>
<a name="l01025"></a>01025 <span class="comment">* char ssysobs[72]</span>
<a name="l01026"></a>01026 <span class="comment">* (Given, auxiliary) ... the actual frame in which there is no</span>
<a name="l01027"></a>01027 <span class="comment">* differential variation in the spectral coordinate across the</span>
<a name="l01028"></a>01028 <span class="comment">* field-of-view, SSYSOBSa.</span>
<a name="l01029"></a>01029 <span class="comment">* double velosys</span>
<a name="l01030"></a>01030 <span class="comment">* (Given, auxiliary) The relative radial velocity [m/s] between the</span>
<a name="l01031"></a>01031 <span class="comment">* observer and the selected standard of rest in the direction of the</span>
<a name="l01032"></a>01032 <span class="comment">* celestial reference coordinate, VELOSYSa.</span>
<a name="l01033"></a>01033 <span class="comment">*</span>
<a name="l01034"></a>01034 <span class="comment">* double zsource</span>
<a name="l01035"></a>01035 <span class="comment">* (Given, auxiliary) The redshift, ZSOURCEa, of the source, and ...</span>
<a name="l01036"></a>01036 <span class="comment">* char ssyssrc[72]</span>
<a name="l01037"></a>01037 <span class="comment">* (Given, auxiliary) ... the spectral reference frame (standard of rest)</span>
<a name="l01038"></a>01038 <span class="comment">* in which this was measured, SSYSSRCa.</span>
<a name="l01039"></a>01039 <span class="comment">*</span>
<a name="l01040"></a>01040 <span class="comment">* double velangl</span>
<a name="l01041"></a>01041 <span class="comment">* (Given, auxiliary) The angle [deg] that should be used to decompose an</span>
<a name="l01042"></a>01042 <span class="comment">* observed velocity into radial and transverse components.</span>
<a name="l01043"></a>01043 <span class="comment">*</span>
<a name="l01044"></a>01044 <span class="comment">* char wcsname[72]</span>
<a name="l01045"></a>01045 <span class="comment">* (Given, auxiliary) The name given to the coordinate representation,</span>
<a name="l01046"></a>01046 <span class="comment">* WCSNAMEa. This variable accomodates the longest allowed string-valued</span>
<a name="l01047"></a>01047 <span class="comment">* FITS keyword, being limited to 68 characters, plus the null-terminating</span>
<a name="l01048"></a>01048 <span class="comment">* character.</span>
<a name="l01049"></a>01049 <span class="comment">*</span>
<a name="l01050"></a>01050 <span class="comment">* int ntab</span>
<a name="l01051"></a>01051 <span class="comment">* (Given) See wcsprm::tab.</span>
<a name="l01052"></a>01052 <span class="comment">*</span>
<a name="l01053"></a>01053 <span class="comment">* int nwtb</span>
<a name="l01054"></a>01054 <span class="comment">* (Given) See wcsprm::wtb.</span>
<a name="l01055"></a>01055 <span class="comment">*</span>
<a name="l01056"></a>01056 <span class="comment">* struct tabprm *tab</span>
<a name="l01057"></a>01057 <span class="comment">* (Given) Address of the first element of an array of ntab tabprm structs</span>
<a name="l01058"></a>01058 <span class="comment">* for which memory has been allocated. These are used to store tabular</span>
<a name="l01059"></a>01059 <span class="comment">* transformation parameters.</span>
<a name="l01060"></a>01060 <span class="comment">*</span>
<a name="l01061"></a>01061 <span class="comment">* Although technically wcsprm::ntab and tab are "given", they will</span>
<a name="l01062"></a>01062 <span class="comment">* normally be set by invoking wcstab(), whether directly or indirectly.</span>
<a name="l01063"></a>01063 <span class="comment">*</span>
<a name="l01064"></a>01064 <span class="comment">* The tabprm structs contain some members that must be supplied and others</span>
<a name="l01065"></a>01065 <span class="comment">* that are derived. The information to be supplied comes primarily from</span>
<a name="l01066"></a>01066 <span class="comment">* arrays stored in one or more FITS binary table extensions. These</span>
<a name="l01067"></a>01067 <span class="comment">* arrays, referred to here as "wcstab arrays", are themselves located by</span>
<a name="l01068"></a>01068 <span class="comment">* parameters stored in the FITS image header.</span>
<a name="l01069"></a>01069 <span class="comment">*</span>
<a name="l01070"></a>01070 <span class="comment">* struct wtbarr *wtb</span>
<a name="l01071"></a>01071 <span class="comment">* (Given) Address of the first element of an array of nwtb wtbarr structs</span>
<a name="l01072"></a>01072 <span class="comment">* for which memory has been allocated. These are used in extracting</span>
<a name="l01073"></a>01073 <span class="comment">* wcstab arrays from a FITS binary table.</span>
<a name="l01074"></a>01074 <span class="comment">*</span>
<a name="l01075"></a>01075 <span class="comment">* Although technically wcsprm::nwtb and wtb are "given", they will</span>
<a name="l01076"></a>01076 <span class="comment">* normally be set by invoking wcstab(), whether directly or indirectly.</span>
<a name="l01077"></a>01077 <span class="comment">*</span>
<a name="l01078"></a>01078 <span class="comment">* char lngtyp[8]</span>
<a name="l01079"></a>01079 <span class="comment">* (Returned) Four-character WCS celestial longitude and ...</span>
<a name="l01080"></a>01080 <span class="comment">* char lattyp[8]</span>
<a name="l01081"></a>01081 <span class="comment">* (Returned) ... latitude axis types. e.g. "RA", "DEC", "GLON", "GLAT",</span>
<a name="l01082"></a>01082 <span class="comment">* etc. extracted from 'RA--', 'DEC-', 'GLON', 'GLAT', etc. in the first</span>
<a name="l01083"></a>01083 <span class="comment">* four characters of CTYPEia but with trailing dashes removed. (Declared</span>
<a name="l01084"></a>01084 <span class="comment">* as char[8] for alignment reasons.)</span>
<a name="l01085"></a>01085 <span class="comment">*</span>
<a name="l01086"></a>01086 <span class="comment">* int lng</span>
<a name="l01087"></a>01087 <span class="comment">* (Returned) Index for the longitude coordinate, and ...</span>
<a name="l01088"></a>01088 <span class="comment">* int lat</span>
<a name="l01089"></a>01089 <span class="comment">* (Returned) ... index for the latitude coordinate, and ...</span>
<a name="l01090"></a>01090 <span class="comment">* int spec</span>
<a name="l01091"></a>01091 <span class="comment">* (Returned) ... index for the spectral coordinate in the imgcrd[][] and</span>
<a name="l01092"></a>01092 <span class="comment">* world[][] arrays in the API of wcsp2s(), wcss2p() and wcsmix().</span>
<a name="l01093"></a>01093 <span class="comment">*</span>
<a name="l01094"></a>01094 <span class="comment">* These may also serve as indices into the pixcrd[][] array provided that</span>
<a name="l01095"></a>01095 <span class="comment">* the PCi_ja matrix does not transpose axes.</span>
<a name="l01096"></a>01096 <span class="comment">*</span>
<a name="l01097"></a>01097 <span class="comment">* int cubeface</span>
<a name="l01098"></a>01098 <span class="comment">* (Returned) Index into the pixcrd[][] array for the CUBEFACE axis. This</span>
<a name="l01099"></a>01099 <span class="comment">* is used for quadcube projections where the cube faces are stored on a</span>
<a name="l01100"></a>01100 <span class="comment">* separate axis (see wcs.h).</span>
<a name="l01101"></a>01101 <span class="comment">*</span>
<a name="l01102"></a>01102 <span class="comment">* int *types</span>
<a name="l01103"></a>01103 <span class="comment">* (Returned) Address of the first element of an array of int containing a</span>
<a name="l01104"></a>01104 <span class="comment">* four-digit type code for each axis.</span>
<a name="l01105"></a>01105 <span class="comment">*</span>
<a name="l01106"></a>01106 <span class="comment">* - First digit (i.e. 1000s):</span>
<a name="l01107"></a>01107 <span class="comment">* - 0: Non-specific coordinate type.</span>
<a name="l01108"></a>01108 <span class="comment">* - 1: Stokes coordinate.</span>
<a name="l01109"></a>01109 <span class="comment">* - 2: Celestial coordinate (including CUBEFACE).</span>
<a name="l01110"></a>01110 <span class="comment">* - 3: Spectral coordinate.</span>
<a name="l01111"></a>01111 <span class="comment">*</span>
<a name="l01112"></a>01112 <span class="comment">* - Second digit (i.e. 100s):</span>
<a name="l01113"></a>01113 <span class="comment">* - 0: Linear axis.</span>
<a name="l01114"></a>01114 <span class="comment">* - 1: Quantized axis (STOKES, CUBEFACE).</span>
<a name="l01115"></a>01115 <span class="comment">* - 2: Non-linear celestial axis.</span>
<a name="l01116"></a>01116 <span class="comment">* - 3: Non-linear spectral axis.</span>
<a name="l01117"></a>01117 <span class="comment">* - 4: Logarithmic axis.</span>
<a name="l01118"></a>01118 <span class="comment">* - 5: Tabular axis.</span>
<a name="l01119"></a>01119 <span class="comment">*</span>
<a name="l01120"></a>01120 <span class="comment">* - Third digit (i.e. 10s):</span>
<a name="l01121"></a>01121 <span class="comment">* - 0: Group number, e.g. lookup table number, being an index into the</span>
<a name="l01122"></a>01122 <span class="comment">* tabprm array (see above).</span>
<a name="l01123"></a>01123 <span class="comment">*</span>
<a name="l01124"></a>01124 <span class="comment">* - The fourth digit is used as a qualifier depending on the axis type.</span>
<a name="l01125"></a>01125 <span class="comment">*</span>
<a name="l01126"></a>01126 <span class="comment">* - For celestial axes:</span>
<a name="l01127"></a>01127 <span class="comment">* - 0: Longitude coordinate.</span>
<a name="l01128"></a>01128 <span class="comment">* - 1: Latitude coordinate.</span>
<a name="l01129"></a>01129 <span class="comment">* - 2: CUBEFACE number.</span>
<a name="l01130"></a>01130 <span class="comment">*</span>
<a name="l01131"></a>01131 <span class="comment">* - For lookup tables: the axis number in a multidimensional table.</span>
<a name="l01132"></a>01132 <span class="comment">*</span>
<a name="l01133"></a>01133 <span class="comment">* CTYPEia in "4-3" form with unrecognized algorithm code will have its</span>
<a name="l01134"></a>01134 <span class="comment">* type set to -1 and generate an error.</span>
<a name="l01135"></a>01135 <span class="comment">*</span>
<a name="l01136"></a>01136 <span class="comment">* void *padding</span>
<a name="l01137"></a>01137 <span class="comment">* (An unused variable inserted for alignment purposes only.)</span>
<a name="l01138"></a>01138 <span class="comment">*</span>
<a name="l01139"></a>01139 <span class="comment">* struct linprm lin</span>
<a name="l01140"></a>01140 <span class="comment">* (Returned) Linear transformation parameters (usage is described in the</span>
<a name="l01141"></a>01141 <span class="comment">* prologue to lin.h).</span>
<a name="l01142"></a>01142 <span class="comment">*</span>
<a name="l01143"></a>01143 <span class="comment">* struct celprm cel</span>
<a name="l01144"></a>01144 <span class="comment">* (Returned) Celestial transformation parameters (usage is described in</span>
<a name="l01145"></a>01145 <span class="comment">* the prologue to cel.h).</span>
<a name="l01146"></a>01146 <span class="comment">*</span>
<a name="l01147"></a>01147 <span class="comment">* struct spcprm spc</span>
<a name="l01148"></a>01148 <span class="comment">* (Returned) Spectral transformation parameters (usage is described in the</span>
<a name="l01149"></a>01149 <span class="comment">* prologue to spc.h).</span>
<a name="l01150"></a>01150 <span class="comment">*</span>
<a name="l01151"></a>01151 <span class="comment">* struct wcserr *err</span>
<a name="l01152"></a>01152 <span class="comment">* (Returned) If enabled, when an error status is returned this struct</span>
<a name="l01153"></a>01153 <span class="comment">* contains detailed information about the error, see wcserr_enable().</span>
<a name="l01154"></a>01154 <span class="comment">*</span>
<a name="l01155"></a>01155 <span class="comment">* void *m_padding</span>
<a name="l01156"></a>01156 <span class="comment">* (For internal use only.)</span>
<a name="l01157"></a>01157 <span class="comment">* int m_flag</span>
<a name="l01158"></a>01158 <span class="comment">* (For internal use only.)</span>
<a name="l01159"></a>01159 <span class="comment">* int m_naxis</span>
<a name="l01160"></a>01160 <span class="comment">* (For internal use only.)</span>
<a name="l01161"></a>01161 <span class="comment">* double *m_crpix</span>
<a name="l01162"></a>01162 <span class="comment">* (For internal use only.)</span>
<a name="l01163"></a>01163 <span class="comment">* double *m_pc</span>
<a name="l01164"></a>01164 <span class="comment">* (For internal use only.)</span>
<a name="l01165"></a>01165 <span class="comment">* double *m_cdelt</span>
<a name="l01166"></a>01166 <span class="comment">* (For internal use only.)</span>
<a name="l01167"></a>01167 <span class="comment">* double *m_crval</span>
<a name="l01168"></a>01168 <span class="comment">* (For internal use only.)</span>
<a name="l01169"></a>01169 <span class="comment">* char (*m_cunit)[72]</span>
<a name="l01170"></a>01170 <span class="comment">* (For internal use only.)</span>
<a name="l01171"></a>01171 <span class="comment">* char (*m_ctype)[72]</span>
<a name="l01172"></a>01172 <span class="comment">* (For internal use only.)</span>
<a name="l01173"></a>01173 <span class="comment">* struct pvcard *m_pv</span>
<a name="l01174"></a>01174 <span class="comment">* (For internal use only.)</span>
<a name="l01175"></a>01175 <span class="comment">* struct pscard *m_ps</span>
<a name="l01176"></a>01176 <span class="comment">* (For internal use only.)</span>
<a name="l01177"></a>01177 <span class="comment">* double *m_cd</span>
<a name="l01178"></a>01178 <span class="comment">* (For internal use only.)</span>
<a name="l01179"></a>01179 <span class="comment">* double *m_crota</span>
<a name="l01180"></a>01180 <span class="comment">* (For internal use only.)</span>
<a name="l01181"></a>01181 <span class="comment">* int *m_colax</span>
<a name="l01182"></a>01182 <span class="comment">* (For internal use only.)</span>
<a name="l01183"></a>01183 <span class="comment">* char (*m_cname)[72]</span>
<a name="l01184"></a>01184 <span class="comment">* (For internal use only.)</span>
<a name="l01185"></a>01185 <span class="comment">* double *m_crder</span>
<a name="l01186"></a>01186 <span class="comment">* (For internal use only.)</span>
<a name="l01187"></a>01187 <span class="comment">* double *m_csyer</span>
<a name="l01188"></a>01188 <span class="comment">* (For internal use only.)</span>
<a name="l01189"></a>01189 <span class="comment">* struct tabprm *m_tab</span>
<a name="l01190"></a>01190 <span class="comment">* (For internal use only.)</span>
<a name="l01191"></a>01191 <span class="comment">* struct wtbarr *m_wtb</span>
<a name="l01192"></a>01192 <span class="comment">* (For internal use only.)</span>
<a name="l01193"></a>01193 <span class="comment">*</span>
<a name="l01194"></a>01194 <span class="comment">*</span>
<a name="l01195"></a>01195 <span class="comment">* pscard struct - Store for PSi_ma keyrecords</span>
<a name="l01196"></a>01196 <span class="comment">* -------------------------------------------</span>
<a name="l01197"></a>01197 <span class="comment">* The pscard struct is used to pass the parsed contents of PSi_ma keyrecords</span>
<a name="l01198"></a>01198 <span class="comment">* to wcsset() via the wcsprm struct.</span>
<a name="l01199"></a>01199 <span class="comment">*</span>
<a name="l01200"></a>01200 <span class="comment">* All members of this struct are to be set by the user.</span>
<a name="l01201"></a>01201 <span class="comment">*</span>
<a name="l01202"></a>01202 <span class="comment">* int i</span>
<a name="l01203"></a>01203 <span class="comment">* (Given) Axis number (1-relative), as in the FITS PSi_ma keyword.</span>
<a name="l01204"></a>01204 <span class="comment">*</span>
<a name="l01205"></a>01205 <span class="comment">* int m</span>
<a name="l01206"></a>01206 <span class="comment">* (Given) Parameter number (non-negative), as in the FITS PSi_ma keyword.</span>
<a name="l01207"></a>01207 <span class="comment">*</span>
<a name="l01208"></a>01208 <span class="comment">* char value[72]</span>
<a name="l01209"></a>01209 <span class="comment">* (Given) Parameter value.</span>
<a name="l01210"></a>01210 <span class="comment">*</span>
<a name="l01211"></a>01211 <span class="comment">*</span>
<a name="l01212"></a>01212 <span class="comment">* pvcard struct - Store for PVi_ma keyrecords</span>
<a name="l01213"></a>01213 <span class="comment">* -------------------------------------------</span>
<a name="l01214"></a>01214 <span class="comment">* The pvcard struct is used to pass the parsed contents of PVi_ma keyrecords</span>
<a name="l01215"></a>01215 <span class="comment">* to wcsset() via the wcsprm struct.</span>
<a name="l01216"></a>01216 <span class="comment">*</span>
<a name="l01217"></a>01217 <span class="comment">* All members of this struct are to be set by the user.</span>
<a name="l01218"></a>01218 <span class="comment">*</span>
<a name="l01219"></a>01219 <span class="comment">* int i</span>
<a name="l01220"></a>01220 <span class="comment">* (Given) Axis number (1-relative), as in the FITS PVi_ma keyword.</span>
<a name="l01221"></a>01221 <span class="comment">*</span>
<a name="l01222"></a>01222 <span class="comment">* int m</span>
<a name="l01223"></a>01223 <span class="comment">* (Given) Parameter number (non-negative), as in the FITS PVi_ma keyword.</span>
<a name="l01224"></a>01224 <span class="comment">*</span>
<a name="l01225"></a>01225 <span class="comment">* double value</span>
<a name="l01226"></a>01226 <span class="comment">* (Given) Parameter value.</span>
<a name="l01227"></a>01227 <span class="comment">*</span>
<a name="l01228"></a>01228 <span class="comment">*</span>
<a name="l01229"></a>01229 <span class="comment">* wtbarr struct - Extraction of coordinate lookup tables from BINTABLE</span>
<a name="l01230"></a>01230 <span class="comment">* --------------------------------------------------------------------</span>
<a name="l01231"></a>01231 <span class="comment">* Function wcstab(), which is invoked automatically by wcspih(), sets up an</span>
<a name="l01232"></a>01232 <span class="comment">* array of wtbarr structs to assist in extracting coordinate lookup tables</span>
<a name="l01233"></a>01233 <span class="comment">* from a binary table extension (BINTABLE) and copying them into the tabprm</span>
<a name="l01234"></a>01234 <span class="comment">* structs stored in wcsprm. Refer to the usage notes for wcspih() and</span>
<a name="l01235"></a>01235 <span class="comment">* wcstab() in wcshdr.h, and also the prologue to tab.h.</span>
<a name="l01236"></a>01236 <span class="comment">*</span>
<a name="l01237"></a>01237 <span class="comment">* For C++ usage, because of a name space conflict with the wtbarr typedef</span>
<a name="l01238"></a>01238 <span class="comment">* defined in CFITSIO header fitsio.h, the wtbarr struct is renamed to wtbarr_s</span>
<a name="l01239"></a>01239 <span class="comment">* by preprocessor macro substitution with scope limited to wcs.h itself.</span>
<a name="l01240"></a>01240 <span class="comment">*</span>
<a name="l01241"></a>01241 <span class="comment">* int i</span>
<a name="l01242"></a>01242 <span class="comment">* (Given) Image axis number.</span>
<a name="l01243"></a>01243 <span class="comment">*</span>
<a name="l01244"></a>01244 <span class="comment">* int m</span>
<a name="l01245"></a>01245 <span class="comment">* (Given) wcstab array axis number for index vectors.</span>
<a name="l01246"></a>01246 <span class="comment">*</span>
<a name="l01247"></a>01247 <span class="comment">* int kind</span>
<a name="l01248"></a>01248 <span class="comment">* (Given) Character identifying the wcstab array type:</span>
<a name="l01249"></a>01249 <span class="comment">* - c: coordinate array,</span>
<a name="l01250"></a>01250 <span class="comment">* - i: index vector.</span>
<a name="l01251"></a>01251 <span class="comment">*</span>
<a name="l01252"></a>01252 <span class="comment">* char extnam[72]</span>
<a name="l01253"></a>01253 <span class="comment">* (Given) EXTNAME identifying the binary table extension.</span>
<a name="l01254"></a>01254 <span class="comment">*</span>
<a name="l01255"></a>01255 <span class="comment">* int extver</span>
<a name="l01256"></a>01256 <span class="comment">* (Given) EXTVER identifying the binary table extension.</span>
<a name="l01257"></a>01257 <span class="comment">*</span>
<a name="l01258"></a>01258 <span class="comment">* int extlev</span>
<a name="l01259"></a>01259 <span class="comment">* (Given) EXTLEV identifying the binary table extension.</span>
<a name="l01260"></a>01260 <span class="comment">*</span>
<a name="l01261"></a>01261 <span class="comment">* char ttype[72]</span>
<a name="l01262"></a>01262 <span class="comment">* (Given) TTYPEn identifying the column of the binary table that contains</span>
<a name="l01263"></a>01263 <span class="comment">* the wcstab array.</span>
<a name="l01264"></a>01264 <span class="comment">*</span>
<a name="l01265"></a>01265 <span class="comment">* long row</span>
<a name="l01266"></a>01266 <span class="comment">* (Given) Table row number.</span>
<a name="l01267"></a>01267 <span class="comment">*</span>
<a name="l01268"></a>01268 <span class="comment">* int ndim</span>
<a name="l01269"></a>01269 <span class="comment">* (Given) Expected dimensionality of the wcstab array.</span>
<a name="l01270"></a>01270 <span class="comment">*</span>
<a name="l01271"></a>01271 <span class="comment">* int *dimlen</span>
<a name="l01272"></a>01272 <span class="comment">* (Given) Address of the first element of an array of int of length ndim</span>
<a name="l01273"></a>01273 <span class="comment">* into which the wcstab array axis lengths are to be written.</span>
<a name="l01274"></a>01274 <span class="comment">*</span>
<a name="l01275"></a>01275 <span class="comment">* double **arrayp</span>
<a name="l01276"></a>01276 <span class="comment">* (Given) Pointer to an array of double which is to be allocated by the</span>
<a name="l01277"></a>01277 <span class="comment">* user and into which the wcstab array is to be written.</span>
<a name="l01278"></a>01278 <span class="comment">*</span>
<a name="l01279"></a>01279 <span class="comment">*</span>
<a name="l01280"></a>01280 <span class="comment">* Global variable: const char *wcs_errmsg[] - Status return messages</span>
<a name="l01281"></a>01281 <span class="comment">* ------------------------------------------------------------------</span>
<a name="l01282"></a>01282 <span class="comment">* Error messages to match the status value returned from each function.</span>
<a name="l01283"></a>01283 <span class="comment">*</span>
<a name="l01284"></a>01284 <span class="comment">*===========================================================================*/</span>
<a name="l01285"></a>01285
<a name="l01286"></a>01286 <span class="preprocessor">#ifndef WCSLIB_WCS</span>
<a name="l01287"></a>01287 <span class="preprocessor"></span><span class="preprocessor">#define WCSLIB_WCS</span>
<a name="l01288"></a>01288 <span class="preprocessor"></span>
<a name="l01289"></a>01289 <span class="preprocessor">#include "<a class="code" href="lin_8h.html">lin.h</a>"</span>
<a name="l01290"></a>01290 <span class="preprocessor">#include "<a class="code" href="cel_8h.html">cel.h</a>"</span>
<a name="l01291"></a>01291 <span class="preprocessor">#include "<a class="code" href="spc_8h.html">spc.h</a>"</span>
<a name="l01292"></a>01292 <span class="preprocessor">#include "<a class="code" href="tab_8h.html">tab.h</a>"</span>
<a name="l01293"></a>01293 <span class="preprocessor">#include "<a class="code" href="wcserr_8h.html">wcserr.h</a>"</span>
<a name="l01294"></a>01294
<a name="l01295"></a>01295 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l01296"></a>01296 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l01297"></a>01297 <span class="preprocessor">#endif</span>
<a name="l01298"></a>01298 <span class="preprocessor"></span>
<a name="l01299"></a><a class="code" href="wcs_8h.html#0653c98b8a1bee5755740ae3f4854094">01299</a> <span class="preprocessor">#define WCSSUB_LONGITUDE 0x1001</span>
<a name="l01300"></a><a class="code" href="wcs_8h.html#5d377c202850ee0eaf44b3e989d0736e">01300</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSSUB_LATITUDE 0x1002</span>
<a name="l01301"></a><a class="code" href="wcs_8h.html#22bbac394b025c4cfc7bd73b6d6e3962">01301</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSSUB_CUBEFACE 0x1004</span>
<a name="l01302"></a><a class="code" href="wcs_8h.html#b9885b02031ff7aa7b094f4a1edee2cd">01302</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSSUB_CELESTIAL 0x1007</span>
<a name="l01303"></a><a class="code" href="wcs_8h.html#4b2dfca2e80fe80ba85dc830cd9c377b">01303</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSSUB_SPECTRAL 0x1008</span>
<a name="l01304"></a><a class="code" href="wcs_8h.html#6ba6d2640572b12a11e3558fa75a01ed">01304</a> <span class="preprocessor"></span><span class="preprocessor">#define WCSSUB_STOKES 0x1010</span>
<a name="l01305"></a>01305 <span class="preprocessor"></span>
<a name="l01306"></a>01306
<a name="l01307"></a>01307 <span class="keyword">extern</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="wcs_8h.html#d16bd8db875ee05b014429efdc1f3471" title="Status return messages.">wcs_errmsg</a>[];
<a name="l01308"></a>01308
<a name="l01309"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f">01309</a> <span class="keyword">enum</span> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f">wcs_errmsg_enum</a> {
<a name="l01310"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f8b87c21d4a2cab41d4eea0a95378fca8">01310</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f8b87c21d4a2cab41d4eea0a95378fca8">WCSERR_SUCCESS</a> = 0, <span class="comment">/* Success. */</span>
<a name="l01311"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25fc51c733d8a719dd698f9e96e9a4fa83f">01311</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25fc51c733d8a719dd698f9e96e9a4fa83f">WCSERR_NULL_POINTER</a> = 1, <span class="comment">/* Null wcsprm pointer passed. */</span>
<a name="l01312"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f5c58d5530bc7577a70185376c15180af">01312</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f5c58d5530bc7577a70185376c15180af">WCSERR_MEMORY</a> = 2, <span class="comment">/* Memory allocation failed. */</span>
<a name="l01313"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f2904278d916c820236347783312a7ce0">01313</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f2904278d916c820236347783312a7ce0">WCSERR_SINGULAR_MTX</a> = 3, <span class="comment">/* Linear transformation matrix is</span>
<a name="l01314"></a>01314 <span class="comment"> singular. */</span>
<a name="l01315"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f598db0fcc4961aa3c5e0a296bec2b313">01315</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f598db0fcc4961aa3c5e0a296bec2b313">WCSERR_BAD_CTYPE</a> = 4, <span class="comment">/* Inconsistent or unrecognized coordinate</span>
<a name="l01316"></a>01316 <span class="comment"> axis types. */</span>
<a name="l01317"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25ffe9ed842ea8f525c7b8fed2f60015dd9">01317</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25ffe9ed842ea8f525c7b8fed2f60015dd9">WCSERR_BAD_PARAM</a> = 5, <span class="comment">/* Invalid parameter value. */</span>
<a name="l01318"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f71cb7eaa633d9e0f560555a016f1f007">01318</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f71cb7eaa633d9e0f560555a016f1f007">WCSERR_BAD_COORD_TRANS</a> = 6, <span class="comment">/* Invalid coordinate transformation</span>
<a name="l01319"></a>01319 <span class="comment"> parameters. */</span>
<a name="l01320"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25fdfa2a8cf8021827378091315b8e0a020">01320</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25fdfa2a8cf8021827378091315b8e0a020">WCSERR_ILL_COORD_TRANS</a> = 7, <span class="comment">/* Ill-conditioned coordinate transformation</span>
<a name="l01321"></a>01321 <span class="comment"> parameters. */</span>
<a name="l01322"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f08306533cf0c7555dad662e82e8a4a69">01322</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f08306533cf0c7555dad662e82e8a4a69">WCSERR_BAD_PIX</a> = 8, <span class="comment">/* One or more of the pixel coordinates were</span>
<a name="l01323"></a>01323 <span class="comment"> invalid. */</span>
<a name="l01324"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f03824b7b5c22e5f0cc91363eb695a804">01324</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f03824b7b5c22e5f0cc91363eb695a804">WCSERR_BAD_WORLD</a> = 9, <span class="comment">/* One or more of the world coordinates were</span>
<a name="l01325"></a>01325 <span class="comment"> invalid. */</span>
<a name="l01326"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f5d662102c172495df1f9bb03cedd701d">01326</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f5d662102c172495df1f9bb03cedd701d">WCSERR_BAD_WORLD_COORD</a> = 10, <span class="comment">/* Invalid world coordinate. */</span>
<a name="l01327"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f832122bb304560f92df91e391d55948a">01327</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f832122bb304560f92df91e391d55948a">WCSERR_NO_SOLUTION</a> = 11, <span class="comment">/* No solution found in the specified</span>
<a name="l01328"></a>01328 <span class="comment"> interval. */</span>
<a name="l01329"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f88e600163f719a759d3569bf1548109e">01329</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f88e600163f719a759d3569bf1548109e">WCSERR_BAD_SUBIMAGE</a> = 12, <span class="comment">/* Invalid subimage specification. */</span>
<a name="l01330"></a><a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f37c8aa0aedc12c63df08f39cb7177ff7">01330</a> <a class="code" href="wcs_8h.html#158615aa1622d8feedd228795ff9a25f37c8aa0aedc12c63df08f39cb7177ff7">WCSERR_NON_SEPARABLE</a> = 13 <span class="comment">/* Non-separable subimage coordinate</span>
<a name="l01331"></a>01331 <span class="comment"> system. */</span>
<a name="l01332"></a>01332 };
<a name="l01333"></a>01333
<a name="l01334"></a>01334
<a name="l01335"></a>01335 <span class="comment">/* Struct used for storing PVi_ma keywords. */</span>
<a name="l01336"></a><a class="code" href="structpvcard.html">01336</a> <span class="keyword">struct </span><a class="code" href="structpvcard.html" title="Store for PVi_ma keyrecords.">pvcard</a> {
<a name="l01337"></a><a class="code" href="structpvcard.html#88fa516543184eaffe6bd2c57946d9a7">01337</a> <span class="keywordtype">int</span> <a class="code" href="structpvcard.html#88fa516543184eaffe6bd2c57946d9a7">i</a>; <span class="comment">/* Axis number, as in PVi_ma (1-relative). */</span>
<a name="l01338"></a><a class="code" href="structpvcard.html#f011f1972d6d345540f36a5c08a30d1f">01338</a> <span class="keywordtype">int</span> <a class="code" href="structpvcard.html#f011f1972d6d345540f36a5c08a30d1f">m</a>; <span class="comment">/* Parameter number, ditto (0-relative). */</span>
<a name="l01339"></a><a class="code" href="structpvcard.html#5c97562bbadb55b8a2db59d9c7878059">01339</a> <span class="keywordtype">double</span> <a class="code" href="structpvcard.html#5c97562bbadb55b8a2db59d9c7878059">value</a>; <span class="comment">/* Parameter value. */</span>
<a name="l01340"></a>01340 };
<a name="l01341"></a>01341
<a name="l01342"></a>01342 <span class="comment">/* Struct used for storing PSi_ma keywords. */</span>
<a name="l01343"></a><a class="code" href="structpscard.html">01343</a> <span class="keyword">struct </span><a class="code" href="structpscard.html" title="Store for PSi_ma keyrecords.">pscard</a> {
<a name="l01344"></a><a class="code" href="structpscard.html#37a06c885cf73736f2eb5e78bd1034a1">01344</a> <span class="keywordtype">int</span> <a class="code" href="structpscard.html#37a06c885cf73736f2eb5e78bd1034a1">i</a>; <span class="comment">/* Axis number, as in PSi_ma (1-relative). */</span>
<a name="l01345"></a><a class="code" href="structpscard.html#71912f084bc3cadeb0758756a723071a">01345</a> <span class="keywordtype">int</span> <a class="code" href="structpscard.html#71912f084bc3cadeb0758756a723071a">m</a>; <span class="comment">/* Parameter number, ditto (0-relative). */</span>
<a name="l01346"></a><a class="code" href="structpscard.html#9986f2ace84978f6cc543224b57592c9">01346</a> <span class="keywordtype">char</span> <a class="code" href="structpscard.html#9986f2ace84978f6cc543224b57592c9">value</a>[72]; <span class="comment">/* Parameter value. */</span>
<a name="l01347"></a>01347 };
<a name="l01348"></a>01348
<a name="l01349"></a>01349 <span class="comment">/* For extracting wcstab arrays. Matches */</span>
<a name="l01350"></a>01350 <span class="comment">/* the wtbarr typedef defined in CFITSIO */</span>
<a name="l01351"></a>01351 <span class="comment">/* header fitsio.h. */</span>
<a name="l01352"></a>01352 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l01353"></a>01353 <span class="preprocessor"></span><span class="preprocessor">#define wtbarr wtbarr_s </span><span class="comment">/* See prologue above. */</span>
<a name="l01354"></a>01354 <span class="preprocessor">#endif</span>
<a name="l01355"></a>01355 <span class="preprocessor"></span><span class="keyword">struct </span><a class="code" href="structwtbarr.html" title="Extraction of coordinate lookup tables from BINTABLE.">wtbarr</a> {
<a name="l01356"></a>01356 <span class="keywordtype">int</span> <a class="code" href="structwtbarr.html#8743b84c99b4b5e7ab7bf0653507a180">i</a>; <span class="comment">/* Image axis number. */</span>
<a name="l01357"></a>01357 <span class="keywordtype">int</span> <a class="code" href="structwtbarr.html#1e88ad32570534a006e96cba721489b5">m</a>; <span class="comment">/* Array axis number for index vectors. */</span>
<a name="l01358"></a>01358 <span class="keywordtype">int</span> <a class="code" href="structwtbarr.html#f8ea7b15992ab7a86be63ff83318be41">kind</a>; <span class="comment">/* wcstab array type. */</span>
<a name="l01359"></a>01359 <span class="keywordtype">char</span> <a class="code" href="structwtbarr.html#9f1fcad814aa3da08dfa75ede2a07deb">extnam</a>[72]; <span class="comment">/* EXTNAME of binary table extension. */</span>
<a name="l01360"></a>01360 <span class="keywordtype">int</span> <a class="code" href="structwtbarr.html#24487eda7b17800f41bd4a452c6306d5">extver</a>; <span class="comment">/* EXTVER of binary table extension. */</span>
<a name="l01361"></a>01361 <span class="keywordtype">int</span> <a class="code" href="structwtbarr.html#10c8dba85b62e2794071dd50a41c4bb1">extlev</a>; <span class="comment">/* EXTLEV of binary table extension. */</span>
<a name="l01362"></a>01362 <span class="keywordtype">char</span> <a class="code" href="structwtbarr.html#750832793167bbeebd1074e29844415d">ttype</a>[72]; <span class="comment">/* TTYPEn of column containing the array. */</span>
<a name="l01363"></a>01363 <span class="keywordtype">long</span> <a class="code" href="structwtbarr.html#2ff7c235353320c6dd98951484012ee7">row</a>; <span class="comment">/* Table row number. */</span>
<a name="l01364"></a>01364 <span class="keywordtype">int</span> <a class="code" href="structwtbarr.html#f862b4f90b0406ed8dd0c240768d4bd3">ndim</a>; <span class="comment">/* Expected wcstab array dimensionality. */</span>
<a name="l01365"></a>01365 <span class="keywordtype">int</span> *<a class="code" href="structwtbarr.html#901403d05f985d4a1fbd2fdc9585bd50">dimlen</a>; <span class="comment">/* Where to write the array axis lengths. */</span>
<a name="l01366"></a>01366 <span class="keywordtype">double</span> **<a class="code" href="structwtbarr.html#41c30234dbdf18ac094872cf39562172">arrayp</a>; <span class="comment">/* Where to write the address of the array */</span>
<a name="l01367"></a>01367 <span class="comment">/* allocated to store the wcstab array. */</span>
<a name="l01368"></a>01368 };
<a name="l01369"></a>01369
<a name="l01370"></a>01370
<a name="l01371"></a><a class="code" href="structwcsprm.html">01371</a> <span class="keyword">struct </span><a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> {
<a name="l01372"></a>01372 <span class="comment">/* Initialization flag (see the prologue above). */</span>
<a name="l01373"></a>01373 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l01374"></a><a class="code" href="structwcsprm.html#35bff8de85e5a8892e1b68db69ca7a68">01374</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#35bff8de85e5a8892e1b68db69ca7a68">flag</a>; <span class="comment">/* Set to zero to force initialization. */</span>
<a name="l01375"></a>01375
<a name="l01376"></a>01376 <span class="comment">/* FITS header keyvalues to be provided (see the prologue above). */</span>
<a name="l01377"></a>01377 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l01378"></a><a class="code" href="structwcsprm.html#70cac2976524a5f0a6aeb2b3fcb95834">01378</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#70cac2976524a5f0a6aeb2b3fcb95834">naxis</a>; <span class="comment">/* Number of axes (pixel and coordinate). */</span>
<a name="l01379"></a><a class="code" href="structwcsprm.html#adad828f07e3affd1511e533b00da19f">01379</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#adad828f07e3affd1511e533b00da19f">crpix</a>; <span class="comment">/* CRPIXja keyvalues for each pixel axis. */</span>
<a name="l01380"></a><a class="code" href="structwcsprm.html#3495a5b0ef529706ec9a0af5c3163d63">01380</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#3495a5b0ef529706ec9a0af5c3163d63">pc</a>; <span class="comment">/* PCi_ja linear transformation matrix. */</span>
<a name="l01381"></a><a class="code" href="structwcsprm.html#de355cdce054938cfa36e06ef9c51446">01381</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#de355cdce054938cfa36e06ef9c51446">cdelt</a>; <span class="comment">/* CDELTia keyvalues for each coord axis. */</span>
<a name="l01382"></a><a class="code" href="structwcsprm.html#7a0a1ce2432cef9377f70367ea1fd18c">01382</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#7a0a1ce2432cef9377f70367ea1fd18c">crval</a>; <span class="comment">/* CRVALia keyvalues for each coord axis. */</span>
<a name="l01383"></a>01383
<a name="l01384"></a><a class="code" href="structwcsprm.html#a0ae3f3605566be2e85e51e5b52c3b52">01384</a> char (*<a class="code" href="structwcsprm.html#a0ae3f3605566be2e85e51e5b52c3b52">cunit</a>)[72]; <span class="comment">/* CUNITia keyvalues for each coord axis. */</span>
<a name="l01385"></a><a class="code" href="structwcsprm.html#e1f462606974e1324cd38f143eda691e">01385</a> char (*<a class="code" href="structwcsprm.html#e1f462606974e1324cd38f143eda691e">ctype</a>)[72]; <span class="comment">/* CTYPEia keyvalues for each coord axis. */</span>
<a name="l01386"></a>01386
<a name="l01387"></a><a class="code" href="structwcsprm.html#f8f679749574250cb9ba09e1f05fab5d">01387</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#f8f679749574250cb9ba09e1f05fab5d">lonpole</a>; <span class="comment">/* LONPOLEa keyvalue. */</span>
<a name="l01388"></a><a class="code" href="structwcsprm.html#5e04127eb71da6e1350467a7a6d236f5">01388</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#5e04127eb71da6e1350467a7a6d236f5">latpole</a>; <span class="comment">/* LATPOLEa keyvalue. */</span>
<a name="l01389"></a>01389
<a name="l01390"></a><a class="code" href="structwcsprm.html#da1b98589c0127d34766b4c6b5d6cb41">01390</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#da1b98589c0127d34766b4c6b5d6cb41">restfrq</a>; <span class="comment">/* RESTFRQa keyvalue. */</span>
<a name="l01391"></a><a class="code" href="structwcsprm.html#5d0b60efc55a61525b9beb26ead4859e">01391</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#5d0b60efc55a61525b9beb26ead4859e">restwav</a>; <span class="comment">/* RESTWAVa keyvalue. */</span>
<a name="l01392"></a>01392
<a name="l01393"></a><a class="code" href="structwcsprm.html#0e31f1eef036258c2957da9b985945dd">01393</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#0e31f1eef036258c2957da9b985945dd">npv</a>; <span class="comment">/* Number of PVi_ma keywords, and the */</span>
<a name="l01394"></a><a class="code" href="structwcsprm.html#912eed291f15134e8cfb8750acc6c4bc">01394</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#912eed291f15134e8cfb8750acc6c4bc">npvmax</a>; <span class="comment">/* number for which space was allocated. */</span>
<a name="l01395"></a><a class="code" href="structwcsprm.html#04fbd6ed1b338e225f2291523e64be2c">01395</a> <span class="keyword">struct </span><a class="code" href="structpvcard.html" title="Store for PVi_ma keyrecords.">pvcard</a> *<a class="code" href="structwcsprm.html#04fbd6ed1b338e225f2291523e64be2c">pv</a>; <span class="comment">/* PVi_ma keywords for each i and m. */</span>
<a name="l01396"></a>01396
<a name="l01397"></a><a class="code" href="structwcsprm.html#4c89dafecd036e169f96cb84d53ace65">01397</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#4c89dafecd036e169f96cb84d53ace65">nps</a>; <span class="comment">/* Number of PSi_ma keywords, and the */</span>
<a name="l01398"></a><a class="code" href="structwcsprm.html#42052d557bdef2c5640a6d19b6d9ed8b">01398</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#42052d557bdef2c5640a6d19b6d9ed8b">npsmax</a>; <span class="comment">/* number for which space was allocated. */</span>
<a name="l01399"></a><a class="code" href="structwcsprm.html#9eca2fcc30058310d020181ae16bf256">01399</a> <span class="keyword">struct </span><a class="code" href="structpscard.html" title="Store for PSi_ma keyrecords.">pscard</a> *<a class="code" href="structwcsprm.html#9eca2fcc30058310d020181ae16bf256">ps</a>; <span class="comment">/* PSi_ma keywords for each i and m. */</span>
<a name="l01400"></a>01400
<a name="l01401"></a>01401 <span class="comment">/* Alternative header keyvalues (see the prologue above). */</span>
<a name="l01402"></a>01402 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l01403"></a><a class="code" href="structwcsprm.html#fd2f31d782b3becce4ca2f9b495ec0b1">01403</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#fd2f31d782b3becce4ca2f9b495ec0b1">cd</a>; <span class="comment">/* CDi_ja linear transformation matrix. */</span>
<a name="l01404"></a><a class="code" href="structwcsprm.html#f124a4259475ea355ced38e73a05363a">01404</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#f124a4259475ea355ced38e73a05363a">crota</a>; <span class="comment">/* CROTAia keyvalues for each coord axis. */</span>
<a name="l01405"></a><a class="code" href="structwcsprm.html#8b3a65921acc0dabfa4efd19a003ea6e">01405</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#8b3a65921acc0dabfa4efd19a003ea6e">altlin</a>; <span class="comment">/* Alternative representations */</span>
<a name="l01406"></a>01406 <span class="comment">/* Bit 0: PCi_ja is present, */</span>
<a name="l01407"></a>01407 <span class="comment">/* Bit 1: CDi_ja is present, */</span>
<a name="l01408"></a>01408 <span class="comment">/* Bit 2: CROTAia is present. */</span>
<a name="l01409"></a><a class="code" href="structwcsprm.html#c3c9c869bef4e4850dfd9762b33ce908">01409</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#c3c9c869bef4e4850dfd9762b33ce908">velref</a>; <span class="comment">/* AIPS velocity code, VELREF. */</span>
<a name="l01410"></a>01410
<a name="l01411"></a>01411 <span class="comment">/* Auxiliary coordinate system information, not used by WCSLIB. */</span>
<a name="l01412"></a><a class="code" href="structwcsprm.html#e7609283351ea46484690f873f8ea9c3">01412</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#e7609283351ea46484690f873f8ea9c3">alt</a>[4];
<a name="l01413"></a><a class="code" href="structwcsprm.html#9ee8fb568ca75874bab00825b768f8ca">01413</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#9ee8fb568ca75874bab00825b768f8ca">colnum</a>;
<a name="l01414"></a><a class="code" href="structwcsprm.html#7320fc64e7705cc7495eba07482b5c55">01414</a> <span class="keywordtype">int</span> *<a class="code" href="structwcsprm.html#7320fc64e7705cc7495eba07482b5c55">colax</a>;
<a name="l01415"></a>01415
<a name="l01416"></a><a class="code" href="structwcsprm.html#922f0f57b8c35cad3d01ceedeba01d4b">01416</a> char (*<a class="code" href="structwcsprm.html#922f0f57b8c35cad3d01ceedeba01d4b">cname</a>)[72];
<a name="l01417"></a><a class="code" href="structwcsprm.html#49eee6450b1a646d3fe01b8965a63af4">01417</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#49eee6450b1a646d3fe01b8965a63af4">crder</a>;
<a name="l01418"></a><a class="code" href="structwcsprm.html#15485177ea8bbacefc29a5a5cba98c8f">01418</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#15485177ea8bbacefc29a5a5cba98c8f">csyer</a>;
<a name="l01419"></a><a class="code" href="structwcsprm.html#e6b40e2adeb31414871c7cae68619d63">01419</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#e6b40e2adeb31414871c7cae68619d63">dateavg</a>[72];
<a name="l01420"></a><a class="code" href="structwcsprm.html#ad387ccbd7847672b5dc2223d9124120">01420</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#ad387ccbd7847672b5dc2223d9124120">dateobs</a>[72];
<a name="l01421"></a><a class="code" href="structwcsprm.html#88b55f6c8d122f3ff63532de85698864">01421</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#88b55f6c8d122f3ff63532de85698864">equinox</a>;
<a name="l01422"></a><a class="code" href="structwcsprm.html#0730c37f09502eb364f4e7d7addb8ab8">01422</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#0730c37f09502eb364f4e7d7addb8ab8">mjdavg</a>;
<a name="l01423"></a><a class="code" href="structwcsprm.html#c0cb013b1505fb7abd4167ac0db0e0aa">01423</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#c0cb013b1505fb7abd4167ac0db0e0aa">mjdobs</a>;
<a name="l01424"></a><a class="code" href="structwcsprm.html#6a88e64207df5007151c2c25028ce3eb">01424</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#6a88e64207df5007151c2c25028ce3eb">obsgeo</a>[3];
<a name="l01425"></a><a class="code" href="structwcsprm.html#65801f93622504672ee3faf8f2110e48">01425</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#65801f93622504672ee3faf8f2110e48">radesys</a>[72];
<a name="l01426"></a><a class="code" href="structwcsprm.html#c089e5d0e3191255ceaea7f8591b27ea">01426</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#c089e5d0e3191255ceaea7f8591b27ea">specsys</a>[72];
<a name="l01427"></a><a class="code" href="structwcsprm.html#9eac54f497e1244c8106dd3ebba12223">01427</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#9eac54f497e1244c8106dd3ebba12223">ssysobs</a>[72];
<a name="l01428"></a><a class="code" href="structwcsprm.html#f300da5a94594a9769ab312bb56dde83">01428</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#f300da5a94594a9769ab312bb56dde83">velosys</a>;
<a name="l01429"></a><a class="code" href="structwcsprm.html#0936d10c2ac93d13d096b1711ac639a1">01429</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#0936d10c2ac93d13d096b1711ac639a1">zsource</a>;
<a name="l01430"></a><a class="code" href="structwcsprm.html#8715975565c8bbd0c562a32eee40fd20">01430</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#8715975565c8bbd0c562a32eee40fd20">ssyssrc</a>[72];
<a name="l01431"></a><a class="code" href="structwcsprm.html#9fd60ce9e6bc31df07ed02ce64b48be4">01431</a> <span class="keywordtype">double</span> <a class="code" href="structwcsprm.html#9fd60ce9e6bc31df07ed02ce64b48be4">velangl</a>;
<a name="l01432"></a><a class="code" href="structwcsprm.html#2166fb650f937d8870711d8be5986b66">01432</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#2166fb650f937d8870711d8be5986b66">wcsname</a>[72];
<a name="l01433"></a>01433
<a name="l01434"></a>01434 <span class="comment">/* Coordinate lookup tables (see the prologue above). */</span>
<a name="l01435"></a>01435 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l01436"></a><a class="code" href="structwcsprm.html#94c26ce331cc876d63baeeada9820241">01436</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#94c26ce331cc876d63baeeada9820241">ntab</a>; <span class="comment">/* Number of separate tables. */</span>
<a name="l01437"></a><a class="code" href="structwcsprm.html#8625c0a6ff99c754566c46c2372df801">01437</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#8625c0a6ff99c754566c46c2372df801">nwtb</a>; <span class="comment">/* Number of wtbarr structs. */</span>
<a name="l01438"></a><a class="code" href="structwcsprm.html#292133b2b7143b969a3af6a3f2cf3709">01438</a> <span class="keyword">struct </span><a class="code" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> *<a class="code" href="structwcsprm.html#292133b2b7143b969a3af6a3f2cf3709">tab</a>; <span class="comment">/* Tabular transformation parameters. */</span>
<a name="l01439"></a><a class="code" href="structwcsprm.html#9063e8d0c956e9eae7f7d6f3608b9ed2">01439</a> <span class="keyword">struct </span><a class="code" href="structwtbarr.html" title="Extraction of coordinate lookup tables from BINTABLE.">wtbarr</a> *<a class="code" href="structwcsprm.html#9063e8d0c956e9eae7f7d6f3608b9ed2">wtb</a>; <span class="comment">/* Array of wtbarr structs. */</span>
<a name="l01440"></a>01440
<a name="l01441"></a>01441 <span class="comment">/* Information derived from the FITS header keyvalues by wcsset(). */</span>
<a name="l01442"></a>01442 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l01443"></a><a class="code" href="structwcsprm.html#5b56e1b378a6ae9f8dfff5c364f0653c">01443</a> <span class="keywordtype">char</span> <a class="code" href="structwcsprm.html#5b56e1b378a6ae9f8dfff5c364f0653c">lngtyp</a>[8], <a class="code" href="structwcsprm.html#e352318ce3202dab1b5db8b9ceec7703">lattyp</a>[8]; <span class="comment">/* Celestial axis types, e.g. RA, DEC. */</span>
<a name="l01444"></a><a class="code" href="structwcsprm.html#b9729795155b8f37afd80784fb70068b">01444</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#08098820949433d1336841d32d0b62b5">lng</a>, <a class="code" href="structwcsprm.html#b7f7173e6d2b1b8028a3275bdd751e79">lat</a>, <a class="code" href="structwcsprm.html#b9729795155b8f37afd80784fb70068b">spec</a>; <span class="comment">/* Longitude, latitude and spectral axis */</span>
<a name="l01445"></a>01445 <span class="comment">/* indices (0-relative). */</span>
<a name="l01446"></a><a class="code" href="structwcsprm.html#de8495d3ca5047eeadba5934d0bb2708">01446</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#de8495d3ca5047eeadba5934d0bb2708">cubeface</a>; <span class="comment">/* True if there is a CUBEFACE axis. */</span>
<a name="l01447"></a><a class="code" href="structwcsprm.html#b63cdcf6ff8febd1b40d0e044ca7d7ef">01447</a> <span class="keywordtype">int</span> *<a class="code" href="structwcsprm.html#b63cdcf6ff8febd1b40d0e044ca7d7ef">types</a>; <span class="comment">/* Coordinate type codes for each axis. */</span>
<a name="l01448"></a><a class="code" href="structwcsprm.html#b253d36f0dc1716952285c6078622e66">01448</a> <span class="keywordtype">void</span> *<a class="code" href="structwcsprm.html#b253d36f0dc1716952285c6078622e66">padding</a>; <span class="comment">/* (Dummy inserted for alignment purposes.) */</span>
<a name="l01449"></a>01449
<a name="l01450"></a><a class="code" href="structwcsprm.html#3224bd06f8f4d2d7d398533eb44a49e8">01450</a> <span class="keyword">struct </span><a class="code" href="structlinprm.html" title="Linear transformation parameters.">linprm</a> <a class="code" href="structwcsprm.html#3224bd06f8f4d2d7d398533eb44a49e8">lin</a>; <span class="comment">/* Linear transformation parameters. */</span>
<a name="l01451"></a><a class="code" href="structwcsprm.html#c8391dd770637dbb841067996b7777ba">01451</a> <span class="keyword">struct </span><a class="code" href="structcelprm.html" title="Celestial transformation parameters.">celprm</a> <a class="code" href="structwcsprm.html#c8391dd770637dbb841067996b7777ba">cel</a>; <span class="comment">/* Celestial transformation parameters. */</span>
<a name="l01452"></a><a class="code" href="structwcsprm.html#e83952aec7c1ac76c090bc89bf4eeea7">01452</a> <span class="keyword">struct </span><a class="code" href="structspcprm.html" title="Spectral transformation parameters.">spcprm</a> <a class="code" href="structwcsprm.html#e83952aec7c1ac76c090bc89bf4eeea7">spc</a>; <span class="comment">/* Spectral transformation parameters. */</span>
<a name="l01453"></a>01453
<a name="l01454"></a>01454 <span class="comment">/* Error handling */</span>
<a name="l01455"></a>01455 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l01456"></a><a class="code" href="structwcsprm.html#f54ce939604be183231f0ee006e2f8ed">01456</a> <span class="keyword">struct </span><a class="code" href="structwcserr.html" title="Error message handling.">wcserr</a> *<a class="code" href="structwcsprm.html#f54ce939604be183231f0ee006e2f8ed">err</a>;
<a name="l01457"></a>01457
<a name="l01458"></a>01458 <span class="comment">/* Private - the remainder are for memory management. */</span>
<a name="l01459"></a>01459 <span class="comment">/*------------------------------------------------------------------------*/</span>
<a name="l01460"></a><a class="code" href="structwcsprm.html#603ef3ab7f3bc42cf8d8bf99b79b63ac">01460</a> <span class="keywordtype">void</span> *<a class="code" href="structwcsprm.html#603ef3ab7f3bc42cf8d8bf99b79b63ac">m_padding</a>;
<a name="l01461"></a><a class="code" href="structwcsprm.html#5ed753e401cda620a04adfb4ebfb8e0d">01461</a> <span class="keywordtype">int</span> <a class="code" href="structwcsprm.html#5780880281f2f9d085d2e06919b7647a">m_flag</a>, <a class="code" href="structwcsprm.html#5ed753e401cda620a04adfb4ebfb8e0d">m_naxis</a>;
<a name="l01462"></a><a class="code" href="structwcsprm.html#6778d31ec5a2ee643dc5f0a8af630b03">01462</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#164e3852bcd2dea8b5f73e1dff79ddf5">m_crpix</a>, *<a class="code" href="structwcsprm.html#6778d31ec5a2ee643dc5f0a8af630b03">m_pc</a>, *<a class="code" href="structwcsprm.html#42e0ff2da3b0c1ca0a9509f787ed1951">m_cdelt</a>, *<a class="code" href="structwcsprm.html#5072893bd9beddb33967697d501acdce">m_crval</a>;
<a name="l01463"></a><a class="code" href="structwcsprm.html#f1cb3e68560d1ac42c620cfe3900af95">01463</a> char (*<a class="code" href="structwcsprm.html#f1cb3e68560d1ac42c620cfe3900af95">m_cunit</a>)[72], (*m_ctype)[72];
<a name="l01464"></a><a class="code" href="structwcsprm.html#6a3fa7adc304567271c5cc0eda3ac986">01464</a> <span class="keyword">struct </span><a class="code" href="structpvcard.html" title="Store for PVi_ma keyrecords.">pvcard</a> *<a class="code" href="structwcsprm.html#6a3fa7adc304567271c5cc0eda3ac986">m_pv</a>;
<a name="l01465"></a><a class="code" href="structwcsprm.html#042875def8cab8354c5b2c40ab9fa374">01465</a> <span class="keyword">struct </span><a class="code" href="structpscard.html" title="Store for PSi_ma keyrecords.">pscard</a> *<a class="code" href="structwcsprm.html#042875def8cab8354c5b2c40ab9fa374">m_ps</a>;
<a name="l01466"></a><a class="code" href="structwcsprm.html#5444415c94c7ab0226788f5efe93221d">01466</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#7a88af56c4c978c6d4213ae1f4bec87a">m_cd</a>, *<a class="code" href="structwcsprm.html#5444415c94c7ab0226788f5efe93221d">m_crota</a>;
<a name="l01467"></a><a class="code" href="structwcsprm.html#4ed527b90d49e8365c1b727f7bec29c7">01467</a> <span class="keywordtype">int</span> *<a class="code" href="structwcsprm.html#4ed527b90d49e8365c1b727f7bec29c7">m_colax</a>;
<a name="l01468"></a><a class="code" href="structwcsprm.html#092c11d209ecdd16bb79858c68e4d582">01468</a> char (*<a class="code" href="structwcsprm.html#092c11d209ecdd16bb79858c68e4d582">m_cname</a>)[72];
<a name="l01469"></a><a class="code" href="structwcsprm.html#13fab263ca03f35844fdaca289b7dfac">01469</a> <span class="keywordtype">double</span> *<a class="code" href="structwcsprm.html#0d15534535c7f9308c9daa2cceff29e7">m_crder</a>, *<a class="code" href="structwcsprm.html#13fab263ca03f35844fdaca289b7dfac">m_csyer</a>;
<a name="l01470"></a><a class="code" href="structwcsprm.html#e09d5bf005e3bd7ee880353e8816ceb8">01470</a> <span class="keyword">struct </span><a class="code" href="structtabprm.html" title="Tabular transformation parameters.">tabprm</a> *<a class="code" href="structwcsprm.html#e09d5bf005e3bd7ee880353e8816ceb8">m_tab</a>;
<a name="l01471"></a><a class="code" href="structwcsprm.html#ce7e0986c79d73bd3a0613034b71974f">01471</a> <span class="keyword">struct </span><a class="code" href="structwtbarr.html" title="Extraction of coordinate lookup tables from BINTABLE.">wtbarr</a> *<a class="code" href="structwcsprm.html#ce7e0986c79d73bd3a0613034b71974f">m_wtb</a>;
<a name="l01472"></a>01472 };
<a name="l01473"></a>01473
<a name="l01474"></a>01474 <span class="comment">/* Size of the wcsprm struct in int units, used by the Fortran wrappers. */</span>
<a name="l01475"></a><a class="code" href="wcs_8h.html#6852f6dd2883c82296f1108b897d337e">01475</a> <span class="preprocessor">#define WCSLEN (sizeof(struct wcsprm)/sizeof(int))</span>
<a name="l01476"></a>01476 <span class="preprocessor"></span>
<a name="l01477"></a>01477
<a name="l01478"></a>01478 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#42b2578d76ace7ca6114d82b7ae46a89" title="Memory allocation for PVi_ma.">wcsnpv</a>(<span class="keywordtype">int</span> n);
<a name="l01479"></a>01479
<a name="l01480"></a>01480 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#e790c9ce6c9b7a4845cf1c3c97b1e97a" title="Memory allocation for PSi_ma.">wcsnps</a>(<span class="keywordtype">int</span> n);
<a name="l01481"></a>01481
<a name="l01482"></a>01482 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#2afc8255fde0965dddaa374463666d45" title="Default constructor for the wcsprm struct.">wcsini</a>(<span class="keywordtype">int</span> alloc, <span class="keywordtype">int</span> naxis, <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs);
<a name="l01483"></a>01483
<a name="l01484"></a>01484 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#864c99fef9f3eee29085ce42d0ee0d64" title="Subimage extraction routine for the wcsprm struct.">wcssub</a>(<span class="keywordtype">int</span> alloc, <span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcssrc, <span class="keywordtype">int</span> *nsub, <span class="keywordtype">int</span> axes[],
<a name="l01485"></a>01485 <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcsdst);
<a name="l01486"></a>01486
<a name="l01487"></a>01487 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#4ab38bc642c4656f62c43acf84a849f1" title="Destructor for the wcsprm struct.">wcsfree</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs);
<a name="l01488"></a>01488
<a name="l01489"></a>01489 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#b9aeb8cf1afb1bfb22e989580d90fca8" title="Print routine for the wcsprm struct.">wcsprt</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs);
<a name="l01490"></a>01490
<a name="l01491"></a>01491 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#8fe5dcd9927240dc0348b850ee662367" title="Print error messages from a wcsprm struct.">wcsperr</a>(<span class="keyword">const</span> <span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs, <span class="keyword">const</span> <span class="keywordtype">char</span> *prefix);
<a name="l01492"></a>01492
<a name="l01493"></a>01493 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#e5cc3f5d249755583403cdf54d2ebb91" title="Setup routine for the wcsprm struct.">wcsset</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs);
<a name="l01494"></a>01494
<a name="l01495"></a>01495 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#27d3dd209db3e76cf4c50f48c01ba986" title="Pixel-to-world transformation.">wcsp2s</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs, <span class="keywordtype">int</span> ncoord, <span class="keywordtype">int</span> nelem, <span class="keyword">const</span> <span class="keywordtype">double</span> pixcrd[],
<a name="l01496"></a>01496 <span class="keywordtype">double</span> imgcrd[], <span class="keywordtype">double</span> phi[], <span class="keywordtype">double</span> theta[], <span class="keywordtype">double</span> world[],
<a name="l01497"></a>01497 <span class="keywordtype">int</span> stat[]);
<a name="l01498"></a>01498
<a name="l01499"></a>01499 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#60673d05a3513659ac848a9cb3d0cb07" title="World-to-pixel transformation.">wcss2p</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs, <span class="keywordtype">int</span> ncoord, <span class="keywordtype">int</span> nelem, <span class="keyword">const</span> <span class="keywordtype">double</span> world[],
<a name="l01500"></a>01500 <span class="keywordtype">double</span> phi[], <span class="keywordtype">double</span> theta[], <span class="keywordtype">double</span> imgcrd[], <span class="keywordtype">double</span> pixcrd[],
<a name="l01501"></a>01501 <span class="keywordtype">int</span> stat[]);
<a name="l01502"></a>01502
<a name="l01503"></a>01503 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#f3f00b876c8212d43f32a51feeadaa81" title="Hybrid coordinate transformation.">wcsmix</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs, <span class="keywordtype">int</span> mixpix, <span class="keywordtype">int</span> mixcel, <span class="keyword">const</span> <span class="keywordtype">double</span> vspan[],
<a name="l01504"></a>01504 <span class="keywordtype">double</span> vstep, <span class="keywordtype">int</span> viter, <span class="keywordtype">double</span> world[], <span class="keywordtype">double</span> phi[],
<a name="l01505"></a>01505 <span class="keywordtype">double</span> theta[], <span class="keywordtype">double</span> imgcrd[], <span class="keywordtype">double</span> pixcrd[]);
<a name="l01506"></a>01506
<a name="l01507"></a>01507 <span class="keywordtype">int</span> <a class="code" href="wcs_8h.html#57975833fe0588eb7c7b6d79f13a7693" title="Spectral axis translation.">wcssptr</a>(<span class="keyword">struct</span> <a class="code" href="structwcsprm.html" title="Coordinate transformation parameters.">wcsprm</a> *wcs, <span class="keywordtype">int</span> *<a class="code" href="structwtbarr.html#8743b84c99b4b5e7ab7bf0653507a180">i</a>, <span class="keywordtype">char</span> ctype[9]);
<a name="l01508"></a>01508
<a name="l01509"></a>01509 <span class="comment">/* Defined mainly for backwards compatibility, use wcssub() instead. */</span>
<a name="l01510"></a><a class="code" href="wcs_8h.html#c55946dadc53ac592cb686275902ae7b">01510</a> <span class="preprocessor">#define wcscopy(alloc, wcssrc, wcsdst) wcssub(alloc, wcssrc, 0, 0, wcsdst)</span>
<a name="l01511"></a>01511 <span class="preprocessor"></span>
<a name="l01512"></a>01512
<a name="l01513"></a>01513 <span class="comment">/* Deprecated. */</span>
<a name="l01514"></a><a class="code" href="wcs_8h.html#1bcf49cfe1ed1bb2bc4c930f98d808fa">01514</a> <span class="preprocessor">#define wcsini_errmsg wcs_errmsg</span>
<a name="l01515"></a><a class="code" href="wcs_8h.html#465ef3c77aaf546324dae0692e6de7fe">01515</a> <span class="preprocessor"></span><span class="preprocessor">#define wcssub_errmsg wcs_errmsg</span>
<a name="l01516"></a><a class="code" href="wcs_8h.html#e1738854472218541bda531653ef2709">01516</a> <span class="preprocessor"></span><span class="preprocessor">#define wcscopy_errmsg wcs_errmsg</span>
<a name="l01517"></a><a class="code" href="wcs_8h.html#3d64b57cec404114c75bd25a562e8053">01517</a> <span class="preprocessor"></span><span class="preprocessor">#define wcsfree_errmsg wcs_errmsg</span>
<a name="l01518"></a><a class="code" href="wcs_8h.html#8f5c31a6983b17abbe2fead61550d55c">01518</a> <span class="preprocessor"></span><span class="preprocessor">#define wcsprt_errmsg wcs_errmsg</span>
<a name="l01519"></a><a class="code" href="wcs_8h.html#84a67c964e212bbf004c264b3ca70fee">01519</a> <span class="preprocessor"></span><span class="preprocessor">#define wcsset_errmsg wcs_errmsg</span>
<a name="l01520"></a><a class="code" href="wcs_8h.html#de3959355dc9d0987e7ccc4070795c38">01520</a> <span class="preprocessor"></span><span class="preprocessor">#define wcsp2s_errmsg wcs_errmsg</span>
<a name="l01521"></a><a class="code" href="wcs_8h.html#37c4884cf58baf25b2984ec3bccb80a5">01521</a> <span class="preprocessor"></span><span class="preprocessor">#define wcss2p_errmsg wcs_errmsg</span>
<a name="l01522"></a><a class="code" href="wcs_8h.html#cfbadc770489b6b5186b95eaa35467f1">01522</a> <span class="preprocessor"></span><span class="preprocessor">#define wcsmix_errmsg wcs_errmsg</span>
<a name="l01523"></a>01523 <span class="preprocessor"></span>
<a name="l01524"></a>01524 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l01525"></a>01525 <span class="preprocessor"></span><span class="preprocessor">#undef wtbarr</span>
<a name="l01526"></a>01526 <span class="preprocessor"></span>}
<a name="l01527"></a>01527 <span class="preprocessor">#endif</span>
<a name="l01528"></a>01528 <span class="preprocessor"></span>
<a name="l01529"></a>01529 <span class="preprocessor">#endif </span><span class="comment">/* WCSLIB_WCS */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Oct 4 19:02:30 2011 for WCSLIB 4.8.2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|