1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437
|
/*
*class++
* Name:
* SpecFrame
* Purpose:
* Spectral coordinate system description.
* Constructor Function:
c astSpecFrame
f AST_SPECFRAME
* Description:
* A SpecFrame is a specialised form of one-dimensional Frame which
* represents various coordinate systems used to describe positions within
* an electro-magnetic spectrum. The particular coordinate system to be
* used is specified by setting the SpecFrame's System attribute (the
* default is wavelength) qualified, as necessary, by other attributes
* such as the rest frequency, the standard of rest, the epoch of
* observation, units, etc (see the description of the System attribute
* for details).
*
* By setting a value for thr SpecOrigin attribute, a SpecFrame can be made
* to represent offsets from a given spectral position, rather than absolute
* spectral values.
* Inheritance:
* The SpecFrame class inherits from the Frame class.
* Attributes:
* In addition to those attributes common to all Frames, every
* SpecFrame also has the following attributes:
*
* - AlignSpecOffset: Align SpecFrames using the offset coordinate system?
* - AlignStdOfRest: Standard of rest in which to align SpecFrames
* - RefDec: Declination of the source (FK5 J2000)
* - RefRA: Right ascension of the source (FK5 J2000)
* - RestFreq: Rest frequency
* - SourceSys: Source velocity spectral system
* - SourceVel: Source velocity
* - SourceVRF: Source velocity rest frame
* - SpecOrigin: The zero point for SpecFrame axis values
* - StdOfRest: Standard of rest
*
* Several of the Frame attributes inherited by the SpecFrame class
* refer to a specific axis of the Frame (for instance Unit(axis),
* Label(axis), etc). Since a SpecFrame is strictly one-dimensional,
* it allows these attributes to be specified without an axis index.
* So for instance, "Unit" is allowed in place of "Unit(1)".
* Functions:
c In addition to those functions applicable to all Frames, the
c following functions may also be applied to all SpecFrames:
f In addition to those routines applicable to all Frames, the
f following routines may also be applied to all SpecFrames:
*
c - astSetRefPos: Set reference position in any celestial system
f - AST_SETREFPOS: Set reference position in any celestial system
c - astGetRefPos: Get reference position in any celestial system
f - AST_GETREFPOS: Get reference position in any celestial system
* Copyright:
* Copyright (C) 1997-2006 Council for the Central Laboratory of the
* Research Councils
* Licence:
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation, either
* version 3 of the License, or (at your option) any later
* version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
* Authors:
* DSB: David S. Berry (Starlink)
* History:
* 4-NOV-2002 (DSB):
* Original version.
* 2-FEB-2005 (DSB):
* - Avoid using astStore to allocate more storage than is supplied
* in the "data" pointer. This can cause access violations since
* astStore will then read beyond the end of the "data" area.
* 22-MAR-2005 (DSB):
* - Re-structure MakeSpecMapping in order to avoid unnecessary
* access to SpecFrame attributes which may not be set, and to
* check that all required attributes have been set if UseDefs is
* zero.
* 23-MAR-2005 (DSB):
* - Added missing rest frames to SorEqual.
* 12-AUG-2005 (DSB):
* - Remove GeoLon and GeoLat attributes. Use the new ObsLon and
* ObsLat attributes in the parent Frame class instead. Note, for
* backward compatibility the public attribute accessors and the
* astLoadSpecFrame functions still recogonise GeoLon and GeoLat,
* but use the ObsLat/ObsLon attributes internally.
* 14-FEB-2006 (DSB):
* Override astGetObjSize.
* 1-MAR-2006 (DSB):
* Replace astSetPermMap within DEBUG blocks by astBeginPM/astEndPM.
* 6-OCT-2006 (DSB):
* Guard against annulling null pointers in subFrame.
* 18-OCT-2006 (DSB):
* Added SpecOrigin and AlignSpecOffset attributes.
* 23-OCT-2006 (DSB):
* Fix memory leak caused by addition of SpecOrigin and AlignSpecOffset
* attributes.
* 15-NOV-2006 (DSB):
* Only write out SpecOrigin if it is not bad.
* 8-JAN-2006 (DSB):
* - SubFrame: Copy the SourceSystem and SourceStdOfRest attributes
* to the System and StdOfRest attributes of the "align_frm"
* SpecFrame before calling MakeSpecMapping. Previously, the
* values assigned to SourceSystem and SourceStdOfRest were
* ignored, and alignment was always performed in the templates System
* and StdOfRest.
* - MakeSpecMapping: Correct logic used to decide if steps 2 and 7
* can be cancelled.
* - OriginSystem: Clear the AlignSpecOffset attributes before
* finding the Mapping between the old and new Systems.
* 16-JAN-2006 (DSB):
* Fix bug in Dump that caused SrcVRF not to be written out.
* 31-JAN-2007 (DSB):
* Modified so that a SpecFrame can be used as a template to find a
* SpecFrame contained within a CmpFrame. This involves changes in
* Match and the removal of the local versions of SetMaxAxes and
* SetMinAxes.
* 8-AUG-2007 (DSB):
* Changed Overlay to avoid the possibility of making permanent
* changes to the supplied template Frame.
* 3-SEP-2007 (DSB):
* In SubFrame, since AlignSystem is extended by the SpecFrame class
* it needs to be cleared before invoking the parent SubFrame
* method in cases where the result Frame is not a SkyFrame.
* 2-OCT-2007 (DSB):
* In Overlay, clear AlignSystem as well as System before calling
* the parent overlay method.
* 4-SEP-2009 (DSB):
* In MakeSpecMapping, in order to produce alignment that is not
* affected by the epoch or reference position, make the alignment
* frame adapt to the epoch and reference position of the target
* and result Frames.
* 14-SEP-2009 (DSB):
* In MakeSpecMapping, extend the 4-SEP-2009 fix to cover other
* attributes that define the available rest frames (e.g.
* SourceVRF, SourceVel, ObsLat, ObsLon, ObsAlt).
* 16-SEP-2009 (DSB):
* In MakeSpecMapping, retain the original alignment frame attribute
* values if we are restoring the integrity of a FrameSet.
* 29-APR-2011 (DSB):
* Prevent astFindFrame from matching a subclass template against a
* superclass target.
*class--
*/
/* Module Macros. */
/* ============== */
/* Set the name of the class we are implementing. This indicates to
the header files that define class interfaces that they should make
"protected" symbols available. */
#define astCLASS SpecFrame
/* Define the first and last acceptable System values. */
#define FIRST_SYSTEM AST__FREQ
#define LAST_SYSTEM AST__VREL
/* Define the first and last acceptable StdOfRest values. */
#define FIRST_SOR AST__TPSOR
#define LAST_SOR AST__SCSOR
/* The supported spectral coordinate systems fall into two groups;
"relative", and "absolute". The relative systems define each axis
value with respect to the rest frequency, whereas the absolute systems
have axis values which do not depend on the rest frequency. Define a
macro which returns one if the specified system is absolute, and zero
otherwise. */
#define ABS_SYSTEM(sys) \
( ( sys == AST__ENERGY || \
sys == AST__WAVENUM || \
sys == AST__WAVELEN || \
sys == AST__AIRWAVE || \
sys == AST__FREQ ) ? 1 : 0 )
/* Define other numerical constants for use in this module. */
#define GETATTRIB_BUFF_LEN 50
#define GETLABEL_BUFF_LEN 200
#define GETSYMBOL_BUFF_LEN 20
#define GETTITLE_BUFF_LEN 200
/* Header files. */
/* ============= */
/* Interface definitions. */
/* ---------------------- */
#include "globals.h" /* Thread-safe global data access */
#include "error.h" /* Error reporting facilities */
#include "memory.h" /* Memory allocation facilities */
#include "unit.h" /* Units management facilities */
#include "globals.h" /* Thread-safe global data access */
#include "object.h" /* Base Object class */
#include "specmap.h" /* Spectral coordinate Mappings */
#include "frame.h" /* Parent Frame class */
#include "skyframe.h" /* Celestial coordinate frames */
#include "specframe.h" /* Interface definition for this class */
#include "mapping.h" /* Coordinate Mappings */
#include "cmpmap.h" /* Compound Mappings */
#include "unitmap.h" /* Unit Mappings */
#include "pal.h" /* SlaLib interface */
#include "shiftmap.h" /* Change of origin */
/* Error code definitions. */
/* ----------------------- */
#include "ast_err.h" /* AST error codes */
/* C header files. */
/* --------------- */
#include <stdarg.h>
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <stddef.h>
#include <math.h>
#include <limits.h>
/* Module Variables. */
/* ================= */
/* Address of this static variable is used as a unique identifier for
member of this class. */
static int class_check;
/* Pointers to parent class methods which are used or extended by this
class. */
static int (* parent_getobjsize)( AstObject *, int * );
static AstSystemType (* parent_getalignsystem)( AstFrame *, int * );
static AstSystemType (* parent_getsystem)( AstFrame *, int * );
static const char *(* parent_getattrib)( AstObject *, const char *, int * );
static const char *(* parent_getdomain)( AstFrame *, int * );
static const char *(* parent_getlabel)( AstFrame *, int, int * );
static const char *(* parent_getsymbol)( AstFrame *, int, int * );
static const char *(* parent_gettitle)( AstFrame *, int * );
static const char *(* parent_getunit)( AstFrame *, int, int * );
static int (* parent_match)( AstFrame *, AstFrame *, int, int **, int **, AstMapping **, AstFrame **, int * );
static int (* parent_subframe)( AstFrame *, AstFrame *, int, const int *, const int *, AstMapping **, AstFrame **, int * );
static int (* parent_testattrib)( AstObject *, const char *, int * );
static void (* parent_setunit)( AstFrame *, int, const char *, int * );
static void (* parent_clearattrib)( AstObject *, const char *, int * );
static void (* parent_overlay)( AstFrame *, const int *, AstFrame *, int * );
static void (* parent_setattrib)( AstObject *, const char *, int * );
static void (* parent_setsystem)( AstFrame *, AstSystemType, int * );
static void (* parent_clearsystem)( AstFrame *, int * );
static void (* parent_clearunit)( AstFrame *, int, int * );
/* Define a variable to hold a SkyFrame which will be used for formatting
and unformatting sky positions, etc. */
static AstSkyFrame *skyframe;
/* Define macros for accessing each item of thread specific global data. */
#ifdef THREAD_SAFE
/* Define how to initialise thread-specific globals. */
#define GLOBAL_inits \
globals->Class_Init = 0; \
globals->GetAttrib_Buff[ 0 ] = 0; \
globals->GetLabel_Buff[ 0 ] = 0; \
globals->GetSymbol_Buff[ 0 ] = 0; \
globals->GetTitle_Buff[ 0 ] = 0; \
/* Create the function that initialises global data for this module. */
astMAKE_INITGLOBALS(SpecFrame)
/* Define macros for accessing each item of thread specific global data. */
#define class_init astGLOBAL(SpecFrame,Class_Init)
#define class_vtab astGLOBAL(SpecFrame,Class_Vtab)
#define getattrib_buff astGLOBAL(SpecFrame,GetAttrib_Buff)
#define getlabel_buff astGLOBAL(SpecFrame,GetLabel_Buff)
#define getsymbol_buff astGLOBAL(SpecFrame,GetSymbol_Buff)
#define gettitle_buff astGLOBAL(SpecFrame,GetTitle_Buff)
static pthread_mutex_t mutex2 = PTHREAD_MUTEX_INITIALIZER;
#define LOCK_MUTEX2 pthread_mutex_lock( &mutex2 );
#define UNLOCK_MUTEX2 pthread_mutex_unlock( &mutex2 );
/* If thread safety is not needed, declare and initialise globals at static
variables. */
#else
/* Buffer returned by GetAttrib. */
static char getattrib_buff[ 51 ];
/* Default GetLabel string buffer */
static char getlabel_buff[ 201 ];
/* Default GetSymbol buffer */
static char getsymbol_buff[ 21 ];
/* Default Title string buffer */
static char gettitle_buff[ 201 ];
/* Define the class virtual function table and its initialisation flag
as static variables. */
static AstSpecFrameVtab class_vtab; /* Virtual function table */
static int class_init = 0; /* Virtual function table initialised? */
#define LOCK_MUTEX2
#define UNLOCK_MUTEX2
#endif
/* Prototypes for Private Member Functions. */
/* ======================================== */
static AstStdOfRestType StdOfRestCode( const char *, int * );
static int GetObjSize( AstObject *, int * );
static AstSystemType GetAlignSystem( AstFrame *, int * );
static AstSystemType SystemCode( AstFrame *, const char *, int * );
static AstSystemType ValidateSystem( AstFrame *, AstSystemType, const char *, int * );
static const char *DefUnit( AstSystemType, const char *, const char *, int * );
static const char *GetDomain( AstFrame *, int * );
static const char *GetLabel( AstFrame *, int, int * );
static const char *GetSymbol( AstFrame *, int, int * );
static const char *GetTitle( AstFrame *, int * );
static const char *GetUnit( AstFrame *, int, int * );
static const char *SpecMapUnit( AstSystemType, const char *, const char *, int * );
static const char *StdOfRestString( AstStdOfRestType, int * );
static const char *SystemLabel( AstSystemType, int * );
static const char *SystemString( AstFrame *, AstSystemType, int * );
static double ConvertSourceVel( AstSpecFrame *, AstStdOfRestType, AstSystemType, int * );
static int EqualSor( AstSpecFrame *, AstSpecFrame *, int * );
static int GetActiveUnit( AstFrame *, int * );
static int MakeSpecMapping( AstSpecFrame *, AstSpecFrame *, AstSpecFrame *, int, AstMapping **, int * );
static int Match( AstFrame *, AstFrame *, int, int **, int **, AstMapping **, AstFrame **, int * );
static int SorConvert( AstSpecFrame *, AstSpecFrame *, AstSpecMap *, int * );
static int SubFrame( AstFrame *, AstFrame *, int, const int *, const int *, AstMapping **, AstFrame **, int * );
static int TestActiveUnit( AstFrame *, int * );
static void ClearUnit( AstFrame *, int, int * );
static void Copy( const AstObject *, AstObject *, int * );
static void Delete( AstObject *, int * );
static void Dump( AstObject *, AstChannel *, int * );
static void GetRefPos( AstSpecFrame *, AstSkyFrame *, double *, double *, int * );
static void Overlay( AstFrame *, const int *, AstFrame *, int * );
static void SetRefPos( AstSpecFrame *, AstSkyFrame *, double, double, int * );
static void SetUnit( AstFrame *, int, const char *, int * );
static void VerifyAttrs( AstSpecFrame *, const char *, const char *, const char *, int * );
static double ToUnits( AstSpecFrame *, const char *, double, const char *, int * );
static void OriginStdOfRest( AstSpecFrame *, AstStdOfRestType, const char *, int * );
static void OriginSystem( AstSpecFrame *, AstSystemType, const char *, int * );
static AstSystemType GetSystem( AstFrame *, int * );
static void SetSystem( AstFrame *, AstSystemType, int * );
static void ClearSystem( AstFrame *, int * );
static const char *GetAttrib( AstObject *, const char *, int * );
static int TestAttrib( AstObject *, const char *, int * );
static void ClearAttrib( AstObject *, const char *, int * );
static void SetAttrib( AstObject *, const char *, int * );
static AstStdOfRestType GetAlignStdOfRest( AstSpecFrame *, int * );
static int TestAlignStdOfRest( AstSpecFrame *, int * );
static void ClearAlignStdOfRest( AstSpecFrame *, int * );
static void SetAlignStdOfRest( AstSpecFrame *, AstStdOfRestType, int * );
static AstStdOfRestType GetStdOfRest( AstSpecFrame *, int * );
static int TestStdOfRest( AstSpecFrame *, int * );
static void ClearStdOfRest( AstSpecFrame *, int * );
static void SetStdOfRest( AstSpecFrame *, AstStdOfRestType, int * );
static double GetRestFreq( AstSpecFrame *, int * );
static int TestRestFreq( AstSpecFrame *, int * );
static void ClearRestFreq( AstSpecFrame *, int * );
static void SetRestFreq( AstSpecFrame *, double, int * );
static double GetSourceVel( AstSpecFrame *, int * );
static int TestSourceVel( AstSpecFrame *, int * );
static void ClearSourceVel( AstSpecFrame *, int * );
static void SetSourceVel( AstSpecFrame *, double, int * );
static double GetRefRA( AstSpecFrame *, int * );
static int TestRefRA( AstSpecFrame *, int * );
static void ClearRefRA( AstSpecFrame *, int * );
static void SetRefRA( AstSpecFrame *, double, int * );
static double GetRefDec( AstSpecFrame *, int * );
static int TestRefDec( AstSpecFrame *, int * );
static void ClearRefDec( AstSpecFrame *, int * );
static void SetRefDec( AstSpecFrame *, double, int * );
static AstStdOfRestType GetSourceVRF( AstSpecFrame *, int * );
static int TestSourceVRF( AstSpecFrame *, int * );
static void ClearSourceVRF( AstSpecFrame *, int * );
static void SetSourceVRF( AstSpecFrame *, AstStdOfRestType, int * );
static AstSystemType GetSourceSys( AstSpecFrame *, int * );
static int TestSourceSys( AstSpecFrame *, int * );
static void ClearSourceSys( AstSpecFrame *, int * );
static void SetSourceSys( AstSpecFrame *, AstSystemType, int * );
static double GetSpecOrigin( AstSpecFrame *, int * );
static int TestSpecOrigin( AstSpecFrame *, int * );
static void ClearSpecOrigin( AstSpecFrame *, int * );
static void SetSpecOrigin( AstSpecFrame *, double, int * );
static double GetSpecOriginCur( AstSpecFrame *, int * );
static int GetAlignSpecOffset( AstSpecFrame *, int * );
static int TestAlignSpecOffset( AstSpecFrame *, int * );
static void SetAlignSpecOffset( AstSpecFrame *, int, int * );
static void ClearAlignSpecOffset( AstSpecFrame *, int * );
/* Member functions. */
/* ================= */
static void ClearAttrib( AstObject *this_object, const char *attrib, int *status ) {
/*
* Name:
* ClearAttrib
* Purpose:
* Clear an attribute value for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void ClearAttrib( AstObject *this, const char *attrib, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astClearAttrib protected
* method inherited from the Frame class).
* Description:
* This function clears the value of a specified attribute for a
* SpecFrame, so that the default value will subsequently be used.
* Parameters:
* this
* Pointer to the SpecFrame.
* attrib
* Pointer to a null terminated string specifying the attribute
* name. This should be in lower case with no surrounding white
* space.
* status
* Pointer to the inherited status variable.
* Notes:
* - This function uses one-based axis numbering so that it is
* suitable for external (public) use.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
char *new_attrib; /* Pointer value to new attribute name */
int len; /* Length of attrib string */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_object;
/* Obtain the length of the "attrib" string. */
len = strlen( attrib );
/* Check the attribute name and clear the appropriate attribute. */
/* First look for axis attributes defined by the Frame class. Since a
SpecFrame has only 1 axis, we allow these attributes to be specified
without a trailing "(axis)" string. */
if ( !strcmp( attrib, "direction" ) ||
!strcmp( attrib, "bottom" ) ||
!strcmp( attrib, "top" ) ||
!strcmp( attrib, "format" ) ||
!strcmp( attrib, "label" ) ||
!strcmp( attrib, "symbol" ) ||
!strcmp( attrib, "unit" ) ) {
/* Create a new attribute name from the original by appending the string
"(1)" and then use the parent ClearAttrib method. */
new_attrib = astMalloc( len + 4 );
if( new_attrib ) {
memcpy( new_attrib, attrib, len );
memcpy( new_attrib + len, "(1)", 4 );
(*parent_clearattrib)( this_object, new_attrib, status );
new_attrib = astFree( new_attrib );
}
/* AlignStdOfRest. */
/* --------------- */
} else if ( !strcmp( attrib, "alignstdofrest" ) ) {
astClearAlignStdOfRest( this );
/* GeoLat. */
/* ------- */
/* Retained for backward compatibility with older versions of AST in which
SpecFrame had GeoLon/Lat attributes (now ObsLon/Lat are used instead). */
} else if ( !strcmp( attrib, "geolat" ) ) {
astClearAttrib( this, "obslat" );
/* GeoLon. */
/* ------- */
} else if ( !strcmp( attrib, "geolon" ) ) {
astClearAttrib( this, "obslon" );
/* RefDec. */
/* ---------- */
} else if ( !strcmp( attrib, "refdec" ) ) {
astClearRefDec( this );
/* RefRA. */
/* --------- */
} else if ( !strcmp( attrib, "refra" ) ) {
astClearRefRA( this );
/* RestFreq. */
/* --------- */
} else if ( !strcmp( attrib, "restfreq" ) ) {
astClearRestFreq( this );
/* SourceVel. */
/* ---------- */
} else if ( !strcmp( attrib, "sourcevel" ) ) {
astClearSourceVel( this );
/* SpecOrigin. */
/* ---------- */
} else if ( !strcmp( attrib, "specorigin" ) ) {
astClearSpecOrigin( this );
/* AlignSpecOffset. */
/* ---------------- */
} else if ( !strcmp( attrib, "alignspecoffset" ) ) {
astClearAlignSpecOffset( this );
/* SourceVRF */
/* --------- */
} else if ( !strcmp( attrib, "sourcevrf" ) ) {
astClearSourceVRF( this );
/* SourceSys */
/* --------- */
} else if ( !strcmp( attrib, "sourcesys" ) ) {
astClearSourceSys( this );
/* StdOfRest. */
/* ---------- */
} else if ( !strcmp( attrib, "stdofrest" ) ) {
astClearStdOfRest( this );
/* If the attribute is not recognised, pass it on to the parent method
for further interpretation. */
} else {
(*parent_clearattrib)( this_object, attrib, status );
}
}
static void ClearSystem( AstFrame *this_frame, int *status ) {
/*
* Name:
* ClearSystem
* Purpose:
* Clear the System attribute for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void ClearSystem( AstFrame *this_frame, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astClearSystem protected
* method inherited from the Frame class).
* Description:
* This function clears the System attribute for a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to SpecFrame structure */
AstSystemType newsys; /* System after clearing */
AstSystemType oldsys; /* System before clearing */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* Save the original system */
oldsys = astGetSystem( this_frame );
/* Use the parent ClearSystem method to clear the System value. */
(*parent_clearsystem)( this_frame, status );
/* Get the default System. */
newsys = astGetSystem( this_frame );
/* If the system has actually changed. */
if( newsys != oldsys ) {
/* Changing the System value will in general require the Units to change
as well. If the used has previously specified the units to be used with
the new system, then re-instate them (they are stored in the "usedunits"
array in the SpecFrame structure). Otherwise, clear the units so that
the default units will eb used with the new System. */
if( (int) newsys < this->nuunits && this->usedunits &&
this->usedunits[ (int) newsys ] ) {
astSetUnit( this, 0, this->usedunits[ (int) newsys ] );
} else {
astClearUnit( this, 0 );
}
/* Also, clear all attributes which have system-specific defaults. */
astClearLabel( this_frame, 0 );
astClearSymbol( this_frame, 0 );
astClearTitle( this_frame );
/* Modify the SpecOrigin value to use the new System */
OriginSystem( this, oldsys, "astClearSystem", status );
}
}
static void ClearStdOfRest( AstSpecFrame *this, int *status ) {
/*
*+
* Name:
* astClearStdOfRest
* Purpose:
* Clear the StdOfRest attribute for a SpecFrame.
* Type:
* Protected function.
* Synopsis:
* #include "timeframe.h"
* void astClearStdOfRest( AstSpecFrame *this )
* Class Membership:
* SpecFrame virtual function
* Description:
* This function clears the StdOfRest attribute for a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
*-
*/
/* Check the global error status. */
if ( !astOK ) return;
/* Modify the SpecOrigin value stored in the SpecFrame structure to refer to the
default rest frame (heliocentric). */
OriginStdOfRest( this, AST__HLSOR, "astClearStdOfRest", status );
/* Store a bad value for the standard of rest in the SpecFrame structure. */
this->stdofrest = AST__BADSOR;
}
static void ClearUnit( AstFrame *this_frame, int axis, int *status ) {
/*
* Name:
* ClearUnit
* Purpose:
* Clear the value of the Unit string for a SpecFrame's axis.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void ClearUnit( AstFrame *this_frame, int axis )
* Class Membership:
* SpecFrame member function (over-rides the astClearUnit method inherited
* from the Frame class).
* Description:
* This function clears the Unit string for a specified axis of a
* SpecFrame. It also clears the UsedUnit item in the SpecFrame
* structure corresponding to the current System.
* Parameters:
* this
* Pointer to the SpecFrame.
* axis
* The number of the axis (zero-based).
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
int system; /* The SpecFrame's System value */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* Validate the axis index. */
astValidateAxis( this, axis, 1, "astClearUnit" );
/* Clear the UsedUnit item for the current System, if current set. */
system = (int) astGetSystem( this );
if( system < this->nuunits && this->usedunits ) {
this->usedunits[ system ] = astFree( this->usedunits[ system ] );
}
/* Use the parent method to clear the Unit attribute of the axis. */
(*parent_clearunit)( this_frame, axis, status );
}
static double ConvertSourceVel( AstSpecFrame *this, AstStdOfRestType newsor,
AstSystemType newsys, int *status ) {
/*
* Name:
* ConvertSourceVel
* Purpose:
* Convert the SourceVel value to a specified rest frame and spectral
* system.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* double ConvertSourceVel( AstSpecFrame *this, AstStdOfRestType newsor,
* AstSystemType newsys, int *status )
* Class Membership:
* SpecFrame member function
* Description:
* This function convert the SourceVel value to a specified rest frame
* and spectral system, and returns the new value.
* Parameters:
* this
* Pointer to the SpecFrame.
* newsor
* The rest frame in which the source velocity is required.
* newsys
* The spectral system (AST__VREL or AST__REDSHIFT) in which the
* source velocity is required.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The converted source velocity (m/s), or redshift.
* Notes:
* - This function returns zero if an error occurs.
*/
/* Local Variables: */
AstSpecFrame *from; /* Pointer to a source SpecFrame */
AstSpecFrame *to; /* Pointer to a destination SpecFrame */
AstSpecMap *specmap; /* Pointer to a SpecMap */
AstStdOfRestType sor; /* Standard of rest in which SourceVel is defined */
AstSystemType sys; /* Spectral system in which SourceVel is defined */
double ret; /* The returned value */
double rf; /* Rest frequency (Hz) */
double temp; /* Temporary storage */
/* Initialise */
ret = 0.0;
/* Check the global error status. */
if ( !astOK ) return ret;
/* Get the value of the SourceVel attribute. This will be a velocity in m/s
(relativistic, radio or optical), or unitless redshift or beta factor,
depending on the current value of SourceSys. */
ret = astGetSourceVel( this );
/* Check it can be used (depends on whether a value has been set and
whether the UseDefs attribute is zero). */
VerifyAttrs( this, "convert source velocity to a new standard of rest",
"SourceVel", "astMatch", status );
/* Get the rest frame and spectral system to which value refers. */
sor = astGetSourceVRF( this );
sys = astGetSourceSys( this );
/* If necessary, convert to the requested rest frame and spectral system. */
if( sor != newsor || sys != newsys ) {
/* Verify that usable value is available for the RestFreq attribute. An
error is reported if not. */
VerifyAttrs( this, "convert source velocity to a new standard of rest",
"RestFreq", "astMatch", status );
/* Take two copies of the supplied SpecFrame and set their StdOfRest
attributes to the required values. */
from = astCopy( this );
astSetStdOfRest( from, sor );
to = astCopy( this );
astSetStdOfRest( to, newsor );
/* Initialise a new SpecMap to describe the conversion. The new SpecMap
initially represents a UnitMap. */
specmap = astSpecMap( 1, 0, "", status );
/* Add a conversion from the spectral system in which the SourceVEl value
is stored, to relativistic velocity. */
if( sys == AST__VRADIO ) {
astSpecAdd( specmap, "VRTOVL", 0, NULL );
} else if( sys == AST__VOPTICAL ) {
astSpecAdd( specmap, "VOTOVL", 0, NULL );
} else if( sys == AST__REDSHIFT ) {
astSpecAdd( specmap, "ZOTOVL", 0, NULL );
} else if( sys == AST__BETA ) {
astSpecAdd( specmap, "BTTOVL", 0, NULL );
}
/* Add a conversion from velocity to frequency since SorConvert converts
frequencies. */
rf = astGetRestFreq( this );
astSpecAdd( specmap, "VLTOFR", 1, &rf );
/* Now add a conversion from frequency in the SourveVRF standard of rest to
frequency in the required rest frame. */
SorConvert( from, to, specmap, status );
/* Add a conversion from frequency back to velocity. Note, the value of the
rest frequency does not affect the overall conversion. */
astSpecAdd( specmap, "FRTOVL", 1, &rf );
/* Add a conversion from relativistic velocity to the required spectral
system, if needed. */
if( newsys == AST__VRADIO ) {
astSpecAdd( specmap, "VLTOVR", 0, NULL );
} else if( newsys == AST__VOPTICAL ) {
astSpecAdd( specmap, "VLTOVO",0, NULL );
} else if( newsys == AST__REDSHIFT ) {
astSpecAdd( specmap, "VLTOZO",0, NULL );
} else if( newsys == AST__BETA ) {
astSpecAdd( specmap, "VLTOBT",0, NULL );
}
/* Use the SpecMap to convert the source velocity in the SourceVRF
standard of rest and SourceSys spectral system to the required rest
frame and spectral system. */
temp = ret;
astTran1( specmap, 1, &temp, 1, &ret );
/* Free resources */
specmap = astAnnul( specmap );
to = astAnnul( to );
from = astAnnul( from );
}
/* Return zero if an error has occurred. */
if( !astOK ) ret = 0.0;
/* Return the answer. */
return ret;
}
static const char *DefUnit( AstSystemType system, const char *method,
const char *class, int *status ){
/*
* Name:
* DefUnit
* Purpose:
* Return the default units for a spectral coordinate system type.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *DefUnit( AstSystemType system, const char *method,
* const char *class, int *status )
* Class Membership:
* SpecFrame member function.
* Description:
* This function returns a textual representation of the default
* units associated with the specified spectral coordinate system.
* Parameters:
* system
* The spectral coordinate system.
* method
* Pointer to a string holding the name of the calling method.
* This is only for use in constructing error messages.
* class
* Pointer to a string holding the name of the supplied object class.
* This is only for use in constructing error messages.
* status
* Pointer to the inherited status variable.
* Returned Value:
* As tring describing the default units. This string follows the
* units syntax described in FITS WCS paper I "Representations of world
* coordinates in FITS" (Greisen & Calabretta).
* Notes:
* - A NULL pointer is returned if this function is invoked with
* the global error status set or if it should fail for any reason.
*/
/* Local Variables: */
const char *result; /* Value to return */
/* Initialize */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get an identifier for the default units. */
if( system == AST__FREQ ) {
result = "GHz";
} else if( system == AST__ENERGY ) {
result = "J";
} else if( system == AST__WAVENUM ) {
result = "1/m";
} else if( system == AST__WAVELEN ) {
result = "Angstrom";
} else if( system == AST__AIRWAVE ) {
result = "Angstrom";
} else if( system == AST__VRADIO ) {
result = "km/s";
} else if( system == AST__VOPTICAL ) {
result = "km/s";
} else if( system == AST__REDSHIFT ) {
result = "";
} else if( system == AST__BETA ) {
result = "";
} else if( system == AST__VREL ) {
result = "km/s";
/* Report an error if the coordinate system was not recognised. */
} else {
astError( AST__SCSIN, "%s(%s): Corrupt %s contains illegal System "
"identification code (%d).", status, method, class, class,
(int) system );
}
/* Return the result. */
return result;
}
static int EqualSor( AstSpecFrame *this, AstSpecFrame *that, int *status ) {
/*
* Name:
* EqualSor
* Purpose:
* Do two SpecFrames use the same standard of rest?
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int EqualSor( AstSpecFrame *this, AstSpecFrame *that, int *status )
* Class Membership:
* SpecFrame member function
* Description:
* This function returns non-zero if the two supplied SpecFrames use
* the same standard of rest.
* Parameters:
* this
* Pointer to the first SpecFrame.
* that
* Pointer to the second SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Non-zero if the two SpecFrames use the same standard of rest. Zero
* otherwise.
*/
/* Local Variables: */
AstStdOfRestType sor; /* Standard of rest */
int result; /* Value to return */
/* Check the global error status. */
if ( !astOK ) return 0;
/* Initialise. */
result = 1;
/* Compare StdOfRest attributes. */
sor = astGetStdOfRest( this );
if( astGetStdOfRest( that ) != sor ) {
result = 0;
/* If the standards of rest are equal we need to check the the attributes
which specify the precise rest frame. */
} else {
/* The reference RA and Dec need to be equal */
if( !astEQUAL( astGetRefRA( this ), astGetRefRA( that ) ) ||
!astEQUAL( astGetRefDec( this ), astGetRefDec( that ) ) ) {
result = 0;
/* For source rest frame, the source velocities, rest frames and systems must
be equal */
} else if( sor == AST__SCSOR ){
if( !astEQUAL( astGetSourceVel( this ), astGetSourceVel( that ) ) ||
astGetSourceVRF( this ) != astGetSourceVRF( that ) ||
astGetSourceSys( this ) != astGetSourceSys( that ) ) {
result = 0;
}
/* For geocentric, barycentric and heliocentric rest frames, the epochs must
be the same */
} else if( sor == AST__GESOR || sor == AST__BYSOR || sor == AST__HLSOR ){
if( !astEQUAL( astGetEpoch( this ), astGetEpoch( that ) ) ) result = 0;
/* For topocentric rest frame, the epoch and position of the observer must be
the same */
} else if( sor == AST__TPSOR ){
if( !astEQUAL( astGetEpoch( this ), astGetEpoch( that ) ) ||
!astEQUAL( astGetObsAlt( this ), astGetObsAlt( that ) ) ||
!astEQUAL( astGetObsLon( this ), astGetObsLon( that ) ) ||
!astEQUAL( astGetObsLat( this ), astGetObsLat( that ) ) ) result = 0;
} else if( sor != AST__LKSOR && sor != AST__LDSOR &&
sor != AST__GLSOR && sor != AST__LGSOR && astOK ) {
astError( AST__INTER, "SorEqual(SpecFrame): Function SorEqual "
"does not yet support rest frame %d (AST internal "
"programming error)", status, sor );
}
}
/* Return the result */
return result;
}
static int GetObjSize( AstObject *this_object, int *status ) {
/*
* Name:
* GetObjSize
* Purpose:
* Return the in-memory size of an Object.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int GetObjSize( AstObject *this, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetObjSize protected
* method inherited from the parent class).
* Description:
* This function returns the in-memory size of the supplied SpecFrame,
* in bytes.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The Object size, in bytes.
* Notes:
* - A value of zero will be returned if this function is invoked
* with the global status set, or if it should fail for any reason.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to SpecFrame structure */
int result; /* Result value to return */
int i;
/* Initialise. */
result = 0;
/* Check the global error status. */
if ( !astOK ) return result;
/* Obtain a pointers to the SpecFrame structure. */
this = (AstSpecFrame *) this_object;
/* Invoke the GetObjSize method inherited from the parent class, and then
add on any components of the class structure defined by thsi class
which are stored in dynamically allocated memory. */
result = (*parent_getobjsize)( this_object, status );
if( this->usedunits ) {
for( i = 0; i < this->nuunits; i++ ) {
result += astTSizeOf( this->usedunits[ i ] );
}
result += astTSizeOf( this->usedunits );
}
/* If an error occurred, clear the result value. */
if ( !astOK ) result = 0;
/* Return the result, */
return result;
}
static int GetActiveUnit( AstFrame *this_frame, int *status ) {
/*
* Name:
* GetActiveUnit
* Purpose:
* Obtain the value of the ActiveUnit flag for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int GetActiveUnit( AstFrame *this_frame, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetActiveUnit protected
* method inherited from the Frame class).
* Description:
* This function returns the value of the ActiveUnit flag for a
* SpecFrame, which is always 1.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The value to use for the ActiveUnit flag (1).
*/
return 1;
}
static const char *GetAttrib( AstObject *this_object, const char *attrib, int *status ) {
/*
* Name:
* GetAttrib
* Purpose:
* Get the value of a specified attribute for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *GetAttrib( AstObject *this, const char *attrib, int *status )
* Class Membership:
* SpecFrame member function (over-rides the protected astGetAttrib
* method inherited from the Frame class).
* Description:
* This function returns a pointer to the value of a specified
* attribute for a SpecFrame, formatted as a character string.
* Parameters:
* this
* Pointer to the SpecFrame.
* attrib
* Pointer to a null-terminated string containing the name of
* the attribute whose value is required. This name should be in
* lower case, with all white space removed.
* status
* Pointer to the inherited status variable.
* Returned Value:
* - Pointer to a null-terminated string containing the attribute
* value.
* Notes:
* - This function uses one-based axis numbering so that it is
* suitable for external (public) use.
* - The returned string pointer may point at memory allocated
* within the SpecFrame, or at static memory. The contents of the
* string may be over-written or the pointer may become invalid
* following a further invocation of the same function or any
* modification of the SpecFrame. A copy of the string should
* therefore be made if necessary.
* - A NULL pointer will be returned if this function is invoked
* with the global error status set, or if it should fail for any
* reason.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Declare the thread specific global data */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
AstStdOfRestType sor; /* Standard of rest */
AstSystemType sys; /* Spectral system */
char *new_attrib; /* Pointer value to new attribute name */
const char *result; /* Pointer value to return */
double dval; /* Attribute value */
int ival; /* Attribute value */
int len; /* Length of attrib string */
/* Initialise. */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get a pointer to the structure holding thread-specific global data. */
astGET_GLOBALS(this_object);
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_object;
/* Create an FK5 J2000 SkyFrame which will be used for formatting and
unformatting sky positions, etc. */
LOCK_MUTEX2
if( !skyframe ) {
astBeginPM;
skyframe = astSkyFrame( "system=FK5,equinox=J2000", status );
astEndPM;
}
UNLOCK_MUTEX2
/* Obtain the length of the attrib string. */
len = strlen( attrib );
/* Compare "attrib" with each recognised attribute name in turn,
obtaining the value of the required attribute. If necessary, write
the value into "getattrib_buff" as a null-terminated string in an appropriate
format. Set "result" to point at the result string. */
/* First look for axis attributes defined by the Frame class. Since a
SpecFrame has only 1 axis, we allow these attributes to be specified
without a trailing "(axis)" string. */
if ( !strcmp( attrib, "direction" ) ||
!strcmp( attrib, "bottom" ) ||
!strcmp( attrib, "top" ) ||
!strcmp( attrib, "format" ) ||
!strcmp( attrib, "label" ) ||
!strcmp( attrib, "symbol" ) ||
!strcmp( attrib, "unit" ) ) {
/* Create a new attribute name from the original by appending the string
"(1)" and then use the parent GetAttrib method. */
new_attrib = astMalloc( len + 4 );
if( new_attrib ) {
memcpy( new_attrib, attrib, len );
memcpy( new_attrib + len, "(1)", 4 );
result = (*parent_getattrib)( this_object, new_attrib, status );
new_attrib = astFree( new_attrib );
}
/* AlignStdOfRest. */
/* --------------- */
/* Obtain the AlignStdOfRest code and convert to a string. */
} else if ( !strcmp( attrib, "alignstdofrest" ) ) {
sor = astGetAlignStdOfRest( this );
if ( astOK ) {
result = StdOfRestString( sor, status );
/* Report an error if the value was not recognised. */
if ( !result ) {
astError( AST__SCSIN,
"astGetAttrib(%s): Corrupt %s contains invalid AlignStdOfRest "
"identification code (%d).", status, astGetClass( this ),
astGetClass( this ), (int) sor );
}
}
/* AlignSpecOffset */
/* --------------- */
} else if ( !strcmp( attrib, "alignspecoffset" ) ) {
ival = astGetAlignSpecOffset( this );
if ( astOK ) {
(void) sprintf( getattrib_buff, "%d", ival );
result = getattrib_buff;
}
/* GeoLat. */
/* ------- */
/* Retained for backward compatibility with older versions of AST in which
SpecFrame had GeoLon/Lat attributes (now ObsLon/Lat are used instead). */
} else if ( !strcmp( attrib, "geolat" ) ) {
result = astGetAttrib( this, "obslat" );
/* GeoLon. */
/* ------- */
} else if ( !strcmp( attrib, "geolon" ) ) {
result = astGetAttrib( this, "obslon" );
/* RefDec. */
/* ------- */
/* Convert to a string using the SkyFrame Format method. */
} else if ( !strcmp( attrib, "refdec" ) ) {
dval = astGetRefDec( this );
if ( astOK ) {
result = astFormat( skyframe, 1, dval );
}
/* RefRA. */
/* ------ */
/* Convert to a string using the SkyFrame Format method. */
} else if ( !strcmp( attrib, "refra" ) ) {
dval = astGetRefRA( this );
if ( astOK ) {
result = astFormat( skyframe, 0, dval );
}
/* RestFreq. */
/* --------- */
} else if ( !strcmp( attrib, "restfreq" ) ) {
dval = astGetRestFreq( this );
if ( astOK ) {
(void) sprintf( getattrib_buff, "%.*g", AST__DBL_DIG, dval*1.0E-9 );
result = getattrib_buff;
}
/* SourceVel */
/* --------- */
} else if ( !strcmp( attrib, "sourcevel" ) ) {
dval = astGetSourceVel( this );
if ( astOK ) {
/* Convert from m/s to km/s if the SourceVel value is a velocity. . */
if( astGetSourceSys( this ) == AST__VREL ||
astGetSourceSys( this ) == AST__VRADIO ||
astGetSourceSys( this ) == AST__VOPTICAL ) dval *= 1.0E-3;
/* Format */
(void) sprintf( getattrib_buff, "%.*g", AST__DBL_DIG, dval );
result = getattrib_buff;
}
/* SpecOrigin. */
/* ----------- */
} else if ( !strcmp( attrib, "specorigin" ) ) {
dval = GetSpecOriginCur( this, status );
if( astOK ) {
(void) sprintf( getattrib_buff, "%.*g", AST__DBL_DIG, dval );
result = getattrib_buff;
}
/* SourceVRF */
/* ----------*/
} else if ( !strcmp( attrib, "sourcevrf" ) ) {
sor = astGetSourceVRF( this );
if ( astOK ) {
result = StdOfRestString( sor, status );
/* Report an error if the value was not recognised. */
if ( !result ) {
astError( AST__SCSIN,
"astGetAttrib(%s): Corrupt %s contains invalid SourceVRF "
"identification code (%d).", status, astGetClass( this ),
astGetClass( this ), (int) sor );
}
}
/* SourceSys */
/* ----------*/
} else if ( !strcmp( attrib, "sourcesys" ) ) {
sys = astGetSourceSys( this );
if ( astOK ) {
result = SystemString( (AstFrame *) this, sys, status );
/* Report an error if the value was not recognised. */
if ( !result ) {
astError( AST__SCSIN,
"astGetAttrib(%s): Corrupt %s contains invalid SourceSys "
"identification code (%d).", status, astGetClass( this ),
astGetClass( this ), (int) sys );
}
}
/* StdOfRest. */
/* ---------- */
/* Obtain the StdOfRest code and convert to a string. */
} else if ( !strcmp( attrib, "stdofrest" ) ) {
sor = astGetStdOfRest( this );
if ( astOK ) {
result = StdOfRestString( sor, status );
/* Report an error if the value was not recognised. */
if ( !result ) {
astError( AST__SCSIN,
"astGetAttrib(%s): Corrupt %s contains invalid StdOfRest "
"identification code (%d).", status, astGetClass( this ),
astGetClass( this ), (int) sor );
}
}
/* If the attribute name was not recognised, pass it on to the parent
method for further interpretation. */
} else {
result = (*parent_getattrib)( this_object, attrib, status );
}
/* Return the result. */
return result;
}
static const char *GetDomain( AstFrame *this_frame, int *status ) {
/*
* Name:
* GetDomain
* Purpose:
* Obtain a pointer to the Domain attribute string for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *GetDomain( AstFrame *this, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetDomain protected
* method inherited from the Frame class).
* Description:
* This function returns a pointer to the Domain attribute string
* for a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* A pointer to a constant null-terminated string containing the
* Domain value.
* Notes:
* - The returned pointer or the string it refers to may become
* invalid following further invocation of this function or
* modification of the SpecFrame.
* - A NULL pointer is returned if this function is invoked with
* the global error status set or if it should fail for any reason.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to SpecFrame structure */
const char *result; /* Pointer value to return */
/* Initialise. */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* If a Domain attribute string has been set, invoke the parent method
to obtain a pointer to it. */
if ( astTestDomain( this ) ) {
result = (*parent_getdomain)( this_frame, status );
/* Otherwise, provide a pointer to a suitable default string. */
} else {
result = "SPECTRUM";
}
/* Return the result. */
return result;
}
static const char *GetLabel( AstFrame *this, int axis, int *status ) {
/*
* Name:
* GetLabel
* Purpose:
* Access the Label string for a SpecFrame axis.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *GetLabel( AstFrame *this, int axis, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetLabel method inherited
* from the Frame class).
* Description:
* This function returns a pointer to the Label string for a specified axis
* of a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* axis
* Axis index (zero-based) identifying the axis for which information is
* required.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to a constant null-terminated character string containing the
* requested information.
* Notes:
* - A NULL pointer will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Declare the thread specific global data */
AstMapping *map; /* Mapping between units */
AstSystemType system; /* Code identifying type of spectral coordinates */
char *new_lab; /* Modified label string */
const char *result; /* Pointer to label string */
double orig; /* Spec origin */
/* Check the global error status. */
if ( !astOK ) return NULL;
/* Get a pointer to the structure holding thread-specific global data. */
astGET_GLOBALS(this);
/* Initialise. */
result = NULL;
/* Validate the axis index. */
astValidateAxis( this, axis, 1, "astGetLabel" );
/* Check if a value has been set for the required axis label string. If so,
invoke the parent astGetLabel method to obtain a pointer to it. */
if ( astTestLabel( this, axis ) ) {
result = (*parent_getlabel)( this, axis, status );
/* Otherwise, identify the spectral coordinate system described by the
SpecFrame. */
} else {
system = astGetSystem( this );
/* If OK, supply a pointer to a suitable default label string. */
if ( astOK ) {
result = strcpy( getlabel_buff, SystemLabel( system, status ) );
getlabel_buff[ 0 ] = toupper( getlabel_buff[ 0 ] );
/* If a non-zero SpecOrigin has been specified, include the offset now. */
orig = GetSpecOriginCur( (AstSpecFrame *) this, status );
if( orig != 0.0 ) {
sprintf( getlabel_buff + strlen( getlabel_buff ), " offset from %s",
astFormat( this, 0, orig ) );
}
/* Modify this default to take account of the current value of the Unit
attribute, if set. */
if( astTestUnit( this, axis ) ) {
/* Find a Mapping from the default Units for the current System, to the
units indicated by the Unit attribute. This Mapping is used to modify
the existing default label appropriately. For instance, if the default
units is "Hz" and the actual units is "log(Hz)", then the default label
of "Frequency" is changed to "log( frequency )". */
map = astUnitMapper( DefUnit( system, "astGetLabel",
astGetClass( this ), status ),
astGetUnit( this, axis ), result,
&new_lab );
if( new_lab ) {
result = strcpy( getlabel_buff, new_lab );
new_lab = astFree( new_lab );
}
/* Annul the unused Mapping. */
if( map ) map = astAnnul( map );
}
}
}
/* Return the result. */
return result;
}
static void GetRefPos( AstSpecFrame *this, AstSkyFrame *frm, double *lon,
double *lat, int *status ){
/*
*++
* Name:
c astGetRefPos
f AST_GETREFPOS
* Purpose:
* Return the reference position in a specified celestial coordinate system.
* Type:
* Public virtual function.
* Synopsis:
c #include "specframe.h"
c void astGetRefPos( AstSpecFrame *this, AstSkyFrame *frm, double *lon,
c double *lat )
f CALL AST_GETREFPOS( THIS, FRM, LON, LAT, STATUS )
* Class Membership:
* Frame method.
* Description:
c This function
f This routine
* returns the reference position (specified by attributes RefRA and
* RefDec) converted to the celestial coordinate system represented by
* a supplied SkyFrame. The celestial longitude and latitude values
* are returned in radians.
* Parameters:
c this
f THIS = INTEGER (Given)
* Pointer to the SpecFrame.
c frm
f FRM = INTEGER (Given)
* Pointer to the SkyFrame which defines the required celestial
* coordinate system.
c If NULL
f If AST__NULL
* is supplied, then the longitude and latitude values are returned
* as FK5 J2000 RA and Dec values.
c lon
f LON = DOUBLE PRECISION (Returned)
c A pointer to a double in which to store the
f The
* longitude of the reference point, in the coordinate system
* represented by the supplied SkyFrame (radians).
c lat
f LAT = DOUBLE PRECISION (Returned)
c A pointer to a double in which to store the
f The
* latitude of the reference point, in the coordinate system
* represented by the supplied SkyFrame (radians).
f STATUS = INTEGER (Given and Returned)
f The global status.
* Notes:
* - Values of AST__BAD will be returned if this function is
c invoked with the AST error status set, or if it should fail for
f invoked with STATUS set to an error value, or if it should fail for
* any reason.
*--
*/
/* Local Variables: */
AstFrameSet *fs; /* Conversion FrameSet */
AstFrame *fb; /* Base Frame */
AstFrame *fc; /* Current Frame */
double xin[ 1 ]; /* Axis 1 values */
double yin[ 1 ]; /* Axis 2 values */
double xout[ 1 ]; /* Axis 1 values */
double yout[ 1 ]; /* Axis 2 values */
/* Initialise. */
if( lon ) *lon = AST__BAD;
if( lat ) *lat = AST__BAD;
/* Check the global error status. */
if ( !astOK ) return;
/* If no SkyFrame was supplied, just return the stored RefRA and RefDec
values. */
if( !frm ) {
if( lon ) *lon = astGetRefRA( this );
if( lat ) *lat = astGetRefDec( this );
/* Otherwise, convert the stored values to the requested system. */
} else {
/* Create an FK5 J2000 SkyFrame which will be used for formatting and
unformatting sky positions, etc. */
LOCK_MUTEX2
if( !skyframe ) {
astBeginPM;
skyframe = astSkyFrame( "system=FK5,equinox=J2000", status );
astEndPM;
}
UNLOCK_MUTEX2
/* Find the Mapping from the SkyFrame which describes the internal format
in which the RefRA and RefDec attribute values are stored, to the
supplied Frame. */
fs = astFindFrame( skyframe, frm, "" );
/* If alignment was possible, use the Mapping to transform the internal
RefRA and RefDec values. Check for axis permutatuion. */
if( fs ) {
fb = astGetFrame( fs, AST__BASE );
if( astGetLonAxis( fb ) == 0 ) {
xin[ 0 ] = astGetRefRA( this );
yin[ 0 ] = astGetRefDec( this );
} else {
yin[ 0 ] = astGetRefRA( this );
xin[ 0 ] = astGetRefDec( this );
}
astTran2( fs, 1, xin, yin, 1, xout, yout );
/* Store the returned values, checking to see if the axes of the supplied
SkyFrame have been permuted. */
fc = astGetFrame( fs, AST__CURRENT );
if( astGetLonAxis( fc ) == 0 ) {
if( lon ) *lon = xout[ 0 ];
if( lat ) *lat = yout[ 0 ];
} else {
if( lon ) *lon = yout[ 0 ];
if( lat ) *lat = xout[ 0 ];
}
/* Annul object references. */
fc = astAnnul( fc );
fb = astAnnul( fb );
fs = astAnnul( fs );
}
}
}
static const char *GetSymbol( AstFrame *this, int axis, int *status ) {
/*
* Name:
* GetSymbol
* Purpose:
* Obtain a pointer to the Symbol string for a SpecFrame axis.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *GetSymbol( AstFrame *this, int axis, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetSymbol method inherited
* from the Frame class).
* Description:
* This function returns a pointer to the Symbol string for a specified axis
* of a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* axis
* Axis index (zero-based) identifying the axis for which information is
* required.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to a constant null-terminated character string containing the
* requested information.
* Notes:
* - A NULL pointer will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Declare the thread specific global data */
AstMapping *map; /* Mapping between units */
AstSystemType system; /* Code identifying type of sky coordinates */
char *new_sym; /* Modified symbol string */
const char *result; /* Pointer to symbol string */
/* Check the global error status. */
if ( !astOK ) return NULL;
/* Get a pointer to the structure holding thread-specific global data. */
astGET_GLOBALS(this);
/* Initialise. */
result = NULL;
/* Validate the axis index. */
astValidateAxis( this, axis, 1, "astGetSymbol" );
/* Check if a value has been set for the required axis symbol string. If so,
invoke the parent astGetSymbol method to obtain a pointer to it. */
if ( astTestSymbol( this, axis ) ) {
result = (*parent_getsymbol)( this, axis, status );
/* Otherwise, identify the sky coordinate system described by the SpecFrame. */
} else {
system = astGetSystem( this );
/* If OK, supply a pointer to a suitable default Symbol string. */
if ( astOK ) {
if( system == AST__FREQ ) {
result = "FREQ";
} else if( system == AST__ENERGY ) {
result = "ENER";
} else if( system == AST__WAVENUM ) {
result = "WAVN";
} else if( system == AST__WAVELEN ) {
result = "WAVE";
} else if( system == AST__AIRWAVE ) {
result = "AWAV";
} else if( system == AST__VRADIO ) {
result = "VRAD";
} else if( system == AST__VOPTICAL ) {
result = "VOPT";
} else if( system == AST__REDSHIFT ) {
result = "ZOPT";
} else if( system == AST__BETA ) {
result = "BETA";
} else if( system == AST__VREL ) {
result = "VELO";
/* Report an error if the coordinate system was not recognised. */
} else {
astError( AST__SCSIN, "astGetSymbol(%s): Corrupt %s contains "
"invalid System identification code (%d).", status,
astGetClass( this ), astGetClass( this ), (int) system );
}
/* Modify this default to take account of the current value of the Unit
attribute, if set. */
if( astTestUnit( this, axis ) ) {
/* Find a Mapping from the default Units for the current System, to the
units indicated by the Unit attribute. This Mapping is used to modify
the existing default symbol appropriately. For instance, if the default
units is "Hz" and the actual units is "log(Hz)", then the default symbol
of "nu" is changed to "log( nu )". */
map = astUnitMapper( DefUnit( system, "astGetSymbol",
astGetClass( this ), status ),
astGetUnit( this, axis ), result,
&new_sym );
if( new_sym ) {
result = strcpy( getsymbol_buff, new_sym );
new_sym = astFree( new_sym );
}
/* Annul the unused Mapping. */
if( map ) map = astAnnul( map );
}
}
}
/* Return the result. */
return result;
}
static AstSystemType GetAlignSystem( AstFrame *this_frame, int *status ) {
/*
* Name:
* GetAlignSystem
* Purpose:
* Obtain the AlignSystem attribute for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "Specframe.h"
* AstSystemType GetAlignSystem( AstFrame *this_frame, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetAlignSystem protected
* method inherited from the Frame class).
* Description:
* This function returns the AlignSystem attribute for a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The AlignSystem value.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to SpecFrame structure */
AstSystemType result; /* Value to return */
/* Initialise. */
result = AST__BADSYSTEM;
/* Check the global error status. */
if ( !astOK ) return result;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* If a AlignSystem attribute has been set, invoke the parent method to obtain
it. */
if ( astTestAlignSystem( this ) ) {
result = (*parent_getalignsystem)( this_frame, status );
/* Otherwise, provide a suitable default. */
} else {
result = AST__WAVELEN;
}
/* Return the result. */
return result;
}
static AstSystemType GetSystem( AstFrame *this_frame, int *status ) {
/*
* Name:
* GetSystem
* Purpose:
* Obtain the System attribute for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* AstSystemType GetSystem( AstFrame *this_frame, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetSystem protected
* method inherited from the Frame class).
* Description:
* This function returns the System attribute for a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The System value.
* Notes:
* - AST__BADSYSTEM is returned if this function is invoked with
* the global error status set or if it should fail for any reason.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to SpecFrame structure */
AstSystemType result; /* Value to return */
/* Initialise. */
result = AST__BADSYSTEM;
/* Check the global error status. */
if ( !astOK ) return result;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* If a System attribute has been set, invoke the parent method to obtain
it. */
if ( astTestSystem( this ) ) {
result = (*parent_getsystem)( this_frame, status );
/* Otherwise, provide a suitable default. */
} else {
result = AST__WAVELEN;
}
/* Return the result. */
return result;
}
static const char *GetTitle( AstFrame *this_frame, int *status ) {
/*
* Name:
* GetTitle
* Purpose:
* Obtain a pointer to the Title string for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *GetTitle( AstFrame *this_frame, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astGetTitle method inherited
* from the Frame class).
* Description:
* This function returns a pointer to the Title string for a SpecFrame.
* A pointer to a suitable default string is returned if no Title value has
* previously been set.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to a null-terminated character string containing the requested
* information.
* Notes:
* - A NULL pointer will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Declare the thread specific global data */
AstSpecFrame *this; /* Pointer to SpecFrame structure */
AstStdOfRestType sor; /* Code identifying standard of rest */
AstSystemType system; /* Code identifying type of coordinates */
const char *sor_string; /* Pointer to SOR description */
const char *result; /* Pointer to result string */
double rf; /* Rest frequency */
int nc; /* No. of characters added */
int pos; /* Buffer position to enter text */
/* Check the global error status. */
if ( !astOK ) return NULL;
/* Get a pointer to the structure holding thread-specific global data. */
astGET_GLOBALS(this_frame);
/* Initialise. */
result = NULL;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* See if a Title string has been set. If so, use the parent astGetTitle
method to obtain a pointer to it. */
if ( astTestTitle( this ) ) {
result = (*parent_gettitle)( this_frame, status );
/* Otherwise, we will generate a default Title string. Obtain the values of the
SpecFrame's attributes that determine what this string will be. */
} else {
system = astGetSystem( this );
sor = astGetStdOfRest( this );
sor_string = StdOfRestString( sor, status );
rf = astGetRestFreq( this );
/* Classify the coordinate system type and create an appropriate Title
string. (Note that when invoking the astFmtDecimalYr function we must
use a separate sprintf on each occasion so as not to over-write its
internal buffer before the result string has been used.) */
if ( astOK ) {
result = gettitle_buff;
/* Begin with the system's default label. */
pos = sprintf( gettitle_buff, "%s", SystemLabel( system, status ) );
gettitle_buff[ 0 ] = toupper( gettitle_buff[ 0 ] );
/* Append the standard of rest in parentheses, if set. */
if( astTestStdOfRest( this ) ) {
nc = sprintf( gettitle_buff+pos, " (%s)", sor_string );
pos += nc;
}
/* Append the rest frequency if relevant. */
if( !ABS_SYSTEM(system) && ( astTestRestFreq( this ) ||
astGetUseDefs( this ) ) ) {
pos += sprintf( gettitle_buff+pos, ", rest frequency = %g GHz", rf*1.0E-9 );
}
}
}
/* If an error occurred, clear the returned pointer value. */
if ( !astOK ) result = NULL;
/* Return the result. */
return result;
}
static double GetSpecOriginCur( AstSpecFrame *this, int *status ) {
/*
* Name:
* GetSpecOriginCur
* Purpose:
* Obtain the SpecOrigin attribute for a SpecFrame in current units.
* Type:
* Private function.
* Synopsis:
* #include "timeframe.h"
* double GetSpecOriginCur( AstSpecFrame *this, int *status )
* Class Membership:
* SpecFrame virtual function
* Description:
* This function returns the SpecOrigin attribute for a SpecFrame, in
* the current units of the SpecFrame. The protected astGetSpecOrigin
* method can be used to obtain the time origin in the default units of
* the SpecFrame's System.
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The SpecOrigin value, in the units, system and rest frame specified
* by the current values of the Unit, System and StdOfRest attributes
* within "this".
* Notes:
* - AST__BAD is returned if this function is invoked with
* the global error status set or if it should fail for any reason.
*/
/* Local Variables: */
AstMapping *map;
const char *cur;
const char *def;
double result;
double defval;
/* Initialise. */
result = AST__BAD;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get the value in the default units */
result = astGetSpecOrigin( this );
/* If SpecOrigin is non-zero and non-BAD we convert it to the current units.*/
if( result != 0.0 && result != AST__BAD ) {
/* Get the default units for the SpecFrame's System. */
def = DefUnit( astGetSystem( this ), "astGetSpecOrigin", "SpecFrame", status );
/* Get the current units from the SpecFrame. */
cur = astGetUnit( this, 0 );
/* If the units differ, get a Mapping from default to current units. */
if( cur && def ){
if( strcmp( cur, def ) ) {
map = astUnitMapper( def, cur, NULL, NULL );
/* Report an error if the units are incompatible. */
if( !map ) {
astError( AST__BADUN, "%s(%s): The current units (%s) are not suitable "
"for a SpecFrame.", status, "astGetSpecOrigin", astGetClass( this ),
cur );
/* Otherwise, transform the stored origin value.*/
} else {
defval = result;
astTran1( map, 1, &defval, 1, &result );
map = astAnnul( map );
}
}
}
}
/* Return the result. */
return result;
}
static const char *GetUnit( AstFrame *this_frame, int axis, int *status ) {
/*
* Name:
* GetUnit
* Purpose:
* Obtain a pointer to the Unit string for a SpecFrame's axis.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *GetUnit( AstFrame *this_frame, int axis )
* Class Membership:
* SpecFrame member function (over-rides the astGetUnit method inherited
* from the Frame class).
* Description:
* This function returns a pointer to the Unit string for a specified axis
* of a SpecFrame. If the Unit attribute has not been set for the axis, a
* pointer to a suitable default string is returned instead.
* Parameters:
* this
* Pointer to the SpecFrame.
* axis
* The number of the axis (zero-based) for which information is required.
* Returned Value:
* A pointer to a null-terminated string containing the Unit value.
* Notes:
* - A NULL pointer will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
AstSystemType system; /* The SpecFrame's System value */
const char *result; /* Pointer value to return */
/* Check the global error status. */
if ( !astOK ) return NULL;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* Validate the axis index. */
astValidateAxis( this, axis, 1, "astGetUnit" );
/* If a value has been set for the Unit attribute, use the parent
GetUnit method to return a pointer to the required Unit string. */
if( astTestUnit( this, axis ) ){
result = (*parent_getunit)( this_frame, axis, status );
/* Otherwise, identify the spectral coordinate system described by the
SpecFrame. */
} else {
system = astGetSystem( this );
/* Return a string describing the default units. */
result = DefUnit( system, "astGetUnit", astGetClass( this ), status );
}
/* If an error occurred, clear the returned value. */
if ( !astOK ) result = NULL;
/* Return the result. */
return result;
}
void astInitSpecFrameVtab_( AstSpecFrameVtab *vtab, const char *name, int *status ) {
/*
*+
* Name:
* astInitSpecFrameVtab
* Purpose:
* Initialise a virtual function table for a SpecFrame.
* Type:
* Protected function.
* Synopsis:
* #include "specframe.h"
* void astInitSpecFrameVtab( AstSpecFrameVtab *vtab, const char *name )
* Class Membership:
* SpecFrame vtab initialiser.
* Description:
* This function initialises the component of a virtual function
* table which is used by the SpecFrame class.
* Parameters:
* vtab
* Pointer to the virtual function table. The components used by
* all ancestral classes will be initialised if they have not already
* been initialised.
* name
* Pointer to a constant null-terminated character string which contains
* the name of the class to which the virtual function table belongs (it
* is this pointer value that will subsequently be returned by the Object
* astClass function).
*-
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Pointer to thread-specific global data */
AstFrameVtab *frame; /* Pointer to Frame component of Vtab */
AstObjectVtab *object; /* Pointer to Object component of Vtab */
/* Check the local error status. */
if ( !astOK ) return;
/* Get a pointer to the thread specific global data structure. */
astGET_GLOBALS(NULL);
/* Initialize the component of the virtual function table used by the
parent class. */
astInitFrameVtab( (AstFrameVtab *) vtab, name );
/* Store a unique "magic" value in the virtual function table. This
will be used (by astIsASpecFrame) to determine if an object belongs
to this class. We can conveniently use the address of the (static)
class_check variable to generate this unique value. */
vtab->id.check = &class_check;
vtab->id.parent = &(((AstFrameVtab *) vtab)->id);
/* Initialise member function pointers. */
/* ------------------------------------ */
/* Store pointers to the member functions (implemented here) that
provide virtual methods for this class. */
vtab->GetRefPos = GetRefPos;
vtab->SetRefPos = SetRefPos;
vtab->ClearAlignStdOfRest = ClearAlignStdOfRest;
vtab->TestAlignStdOfRest = TestAlignStdOfRest;
vtab->GetAlignStdOfRest = GetAlignStdOfRest;
vtab->SetAlignStdOfRest = SetAlignStdOfRest;
vtab->ClearSourceVRF = ClearSourceVRF;
vtab->TestSourceVRF = TestSourceVRF;
vtab->GetSourceVRF = GetSourceVRF;
vtab->SetSourceVRF = SetSourceVRF;
vtab->ClearSourceSys = ClearSourceSys;
vtab->TestSourceSys = TestSourceSys;
vtab->GetSourceSys = GetSourceSys;
vtab->SetSourceSys = SetSourceSys;
vtab->ClearRefDec = ClearRefDec;
vtab->TestRefDec = TestRefDec;
vtab->GetRefDec = GetRefDec;
vtab->SetRefDec = SetRefDec;
vtab->ClearRefRA = ClearRefRA;
vtab->TestRefRA = TestRefRA;
vtab->GetRefRA = GetRefRA;
vtab->SetRefRA = SetRefRA;
vtab->ClearRestFreq = ClearRestFreq;
vtab->TestRestFreq = TestRestFreq;
vtab->GetRestFreq = GetRestFreq;
vtab->SetRestFreq = SetRestFreq;
vtab->ClearStdOfRest = ClearStdOfRest;
vtab->TestStdOfRest = TestStdOfRest;
vtab->GetStdOfRest = GetStdOfRest;
vtab->SetStdOfRest = SetStdOfRest;
vtab->ClearSourceVel = ClearSourceVel;
vtab->TestSourceVel = TestSourceVel;
vtab->GetSourceVel = GetSourceVel;
vtab->SetSourceVel = SetSourceVel;
vtab->ClearSpecOrigin = ClearSpecOrigin;
vtab->TestSpecOrigin = TestSpecOrigin;
vtab->GetSpecOrigin = GetSpecOrigin;
vtab->SetSpecOrigin = SetSpecOrigin;
vtab->TestAlignSpecOffset = TestAlignSpecOffset;
vtab->SetAlignSpecOffset = SetAlignSpecOffset;
vtab->GetAlignSpecOffset = GetAlignSpecOffset;
vtab->ClearAlignSpecOffset = ClearAlignSpecOffset;
/* Save the inherited pointers to methods that will be extended, and
replace them with pointers to the new member functions. */
object = (AstObjectVtab *) vtab;
frame = (AstFrameVtab *) vtab;
parent_getobjsize = object->GetObjSize;
object->GetObjSize = GetObjSize;
parent_clearattrib = object->ClearAttrib;
object->ClearAttrib = ClearAttrib;
parent_getattrib = object->GetAttrib;
object->GetAttrib = GetAttrib;
parent_setattrib = object->SetAttrib;
object->SetAttrib = SetAttrib;
parent_testattrib = object->TestAttrib;
object->TestAttrib = TestAttrib;
parent_getdomain = frame->GetDomain;
frame->GetDomain = GetDomain;
parent_getsystem = frame->GetSystem;
frame->GetSystem = GetSystem;
parent_setsystem = frame->SetSystem;
frame->SetSystem = SetSystem;
parent_clearsystem = frame->ClearSystem;
frame->ClearSystem = ClearSystem;
parent_getalignsystem = frame->GetAlignSystem;
frame->GetAlignSystem = GetAlignSystem;
parent_getlabel = frame->GetLabel;
frame->GetLabel = GetLabel;
parent_getsymbol = frame->GetSymbol;
frame->GetSymbol = GetSymbol;
parent_gettitle = frame->GetTitle;
frame->GetTitle = GetTitle;
parent_clearunit = frame->ClearUnit;
frame->ClearUnit = ClearUnit;
parent_getunit = frame->GetUnit;
frame->GetUnit = GetUnit;
parent_setunit = frame->SetUnit;
frame->SetUnit = SetUnit;
parent_match = frame->Match;
frame->Match = Match;
parent_overlay = frame->Overlay;
frame->Overlay = Overlay;
parent_subframe = frame->SubFrame;
frame->SubFrame = SubFrame;
/* Store replacement pointers for methods which will be over-ridden by new
member functions implemented here. */
frame->GetActiveUnit = GetActiveUnit;
frame->TestActiveUnit = TestActiveUnit;
frame->ValidateSystem = ValidateSystem;
frame->SystemString = SystemString;
frame->SystemCode = SystemCode;
/* Declare the copy constructor, destructor and class dump
function. */
astSetCopy( vtab, Copy );
astSetDelete( vtab, Delete );
astSetDump( vtab, Dump, "SpecFrame",
"Description of spectral coordinate system" );
/* If we have just initialised the vtab for the current class, indicate
that the vtab is now initialised, and store a pointer to the class
identifier in the base "object" level of the vtab. */
if( vtab == &class_vtab ) {
class_init = 1;
astSetVtabClassIdentifier( vtab, &(vtab->id) );
}
}
static int MakeSpecMapping( AstSpecFrame *target, AstSpecFrame *result,
AstSpecFrame *align_frm, int report,
AstMapping **map, int *status ) {
/*
* Name:
* MakeSpecMapping
* Purpose:
* Generate a Mapping between two SpecFrames.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int MakeSpecMapping( AstSpecFrame *target, AstSpecFrame *result,
* AstSpecFrame *align_frm, int report,
* AstMapping **map, int *status ) {
* Class Membership:
* SpecFrame member function.
* Description:
* This function takes two SpecFrames and generates a Mapping that
* converts between them, taking account of differences in their
* coordinate systems, rest frequency, standard of rest, etc.
*
* In order to cut down the number of transformations to be considered,
* the scheme works by first converting from the target frame to an
* "alignment" Frame, using the attributes of the target to define the
* transformation. A transformation is then found from the alignment
* frame to the required result Frame, using the attributes of the
* result to define the transformation. The alignment Frame is
* described by the AlignSystem and AlignStdOfRest attributes of the
* "align_frm" SpecFrame.
*
* Thus, different forms of alignment can be obtained by suitable
* choice of the attributes of "align_frm". For instance, to compare the
* radio velocity dispersion of two lines at different rest frequencies,
* you would set "system=radio velocity" and (probably) "stdofrest=local
* group" in "align_frm". On the other hand if you wanted to re-calibrate
* an existing radio velocity Frame within a FrameSet to use a different
* rest frequency, you would make the SpecFrame the current Frame and then
* set the rest frequency attribute for the FrameSet. The "integrity
* checking" system in the FrameSet class would then get the Mapping
* between the original and the modified SpecFrames. In this case, the
* "alignment system" needs to be "frequency" since you want the original
* and modified SpecFrames to be aligned in frequency, not radio velocity.
* Parameters:
* target
* Pointer to the first SpecFrame.
* result
* Pointer to the second SpecFrame.
* align_frm
* A SpecFrame defining the system and standard of rest in which to
* align the target and result SpecFrames.
* report
* Should errors be reported if no match is possible? These reports
* will describe why no match was possible.
* map
* Pointer to a location which is to receive a pointer to the
* returned Mapping. The forward transformation of this Mapping
* will convert from "target" coordinates to "result"
* coordinates, and the inverse transformation will convert in
* the opposite direction (all coordinate values in radians).
* status
* Pointer to the inherited status variable.
* Returned Value:
* Non-zero if the Mapping could be generated, or zero if the two
* SpecFrames are sufficiently un-related that no meaningful Mapping
* can be produced (albeit an "unmeaningful" Mapping will be returned
* in this case, which will need to be annulled).
* Notes:
* A value of zero is returned if this function is invoked with the
* global error status set or if it should fail for any reason.
*/
/* Local Constants: */
#define MAX_ARGS 1 /* Max arguments for an SpecMap conversion */
/* Local Variables: */
AstMapping *map1; /* Intermediate Mapping */
AstMapping *map2; /* Intermediate Mapping */
AstMapping *umap1; /* First Units Mapping */
AstMapping *umap2; /* Second Units Mapping */
AstSpecMap *specmap; /* Pointer to SpecMap */
AstShiftMap *sm; /* ShiftMap pointer */
AstSpecFrame *align_target; /* Alignment Frame with target properties */
AstSpecFrame *align_result; /* Alignment Frame with result properties */
AstSystemType serr; /* Erroneous system */
AstSystemType align_system; /* Code to identify alignment system */
AstSystemType target_system; /* Code to identify target system */
AstSystemType result_system; /* Code to identify result system */
const char *uerr; /* Erroneous units */
const char *ures; /* Results units */
const char *utarg; /* Target units */
const char *vmess; /* Text for use in error messages */
double args[ MAX_ARGS ]; /* Conversion argument array */
double target_rf; /* Target rest frequency (Hz) */
double result_rf; /* Result rest frequency (Hz) */
double target_origin; /* Target origin */
double result_origin; /* Result origin */
int match; /* Mapping can be generated? */
int step2; /* Perform the 2nd step in the Mapping? */
int step3; /* Perform the 3rd step in the Mapping? */
int step4; /* Perform the 4th step in the Mapping? */
int step5; /* Perform the 5th step in the Mapping? */
int step6; /* Perform the 6th step in the Mapping? */
int step7; /* Perform the 7th step in the Mapping? */
/* Check the global error status. */
if ( !astOK ) return 0;
/* Initialise the returned values. */
match = 1;
*map = NULL;
/* Create an initial (null) SpecMap. This is a 1D Mapping which converts
spectral axis values between different systems and standard of rest.
The axis units used by the SpecMap class match the default units used
by this class. Any discrepancy between units is taken into account at
the end of this function, once the total SpecMap has been created. */
specmap = astSpecMap( 1, 0, "", status );
/* Define local macros as shorthand for adding spectral coordinate
conversions to this SpecMap. Each macro simply stores details of
the additional arguments in the "args" array and then calls
astSpecAdd. The macros differ in the number of additional argument
values. */
#define TRANSFORM_0(cvt) \
astSpecAdd( specmap, cvt, 0, NULL );
#define TRANSFORM_1(cvt,arg0) \
args[ 0 ] = arg0; \
astSpecAdd( specmap, cvt, 1, args );
/* Get all the necessary attributes from the result, target and alignment
Frames. */
target_rf = astGetRestFreq( target );
result_rf = astGetRestFreq( result );
target_system = astGetSystem( target );
result_system = astGetSystem( result );
align_system = astGetSystem( align_frm );
/* Define text for error messages.*/
vmess = "convert between spectral systems";
/* Verify that values for the standard of rest have been set if required
(i.e if the UseDefs attribute of either SpecFrame is false). */
VerifyAttrs( result, vmess, "StdOfRest", "astMatch", status );
VerifyAttrs( target, vmess, "StdOfRest", "astMatch", status );
/* There are two different strategies for alignment. I'll use the Source
rest frame as an example, although the same argument applies to other
rest frames. In the first strategy, all "Source" rest frames are
considered equal. That is, if two SpecFrames respresent (for example)
frequencies in the source frame, then the SpecFrames are aligned using
a UnitMap even if the details of the two source rest frames differ.
This is usually what users want to see when (for instance) aligning
plots of two spectra which both represent source frequencies but where
the source frames details differ. In the second strategy, "Source"
rest frames are aligned using a SpecMap that takes into account any
differences in the properties of the source rest frames. This is what
should happen when changes are made to the properties of a SpecFrame
within a FrameSet. For instance, if the user changes the SourceVel
attribute of the current Frame (assumed here to be a SpecFrame) in a
FrameSet, then the process of restoring the integrity of the FrameSet
(see frameset.c for details of integrity restoration) should cause the
base->current Mapping in the FrameSet to be modified to reflect the
new SourceVel value.
So if the current call to this function is part of the process of
restoring a FrameSet's integrity following changes to the FrameSet's
current Frame, then we want to retain the properties of the supplied
alignment Frame. So we use clones of the supplied alignment Frame. */
if( astGetFrameFlags( target ) & AST__INTFLAG ) {
align_target = astClone( align_frm );
align_result = astClone( align_frm );
/* Buf if we are not restoring the integrity of a FrameSet, we want
to ignore any differences in the properties that define the available
rest frames. So create copies of the alignment Frame in which the
properies defining the available rest frames are the same as in the
target and result Frames. */
} else {
align_target = astCopy( align_frm );
astSetEpoch( align_target, astGetEpoch( target ) );
astSetRefRA( align_target, astGetRefRA( target ) );
astSetRefDec( align_target, astGetRefDec( target ) );
astSetSourceVRF( align_target, astGetSourceVRF( target ) );
astSetSourceVel( align_target, astGetSourceVel( target ) );
astSetObsLat( align_target, astGetObsLat( target ) );
astSetObsLon( align_target, astGetObsLon( target ) );
astSetObsAlt( align_target, astGetObsAlt( target ) );
align_result = astCopy( align_frm );
astSetEpoch( align_result, astGetEpoch( result ) );
astSetRefRA( align_result, astGetRefRA( result ) );
astSetRefDec( align_result, astGetRefDec( result ) );
astSetSourceVRF( align_result, astGetSourceVRF( result ) );
astSetSourceVel( align_result, astGetSourceVel( result ) );
astSetObsLat( align_result, astGetObsLat( result ) );
astSetObsLon( align_result, astGetObsLon( result ) );
astSetObsAlt( align_result, astGetObsAlt( result ) );
}
/* The supported spectral coordinate systems fall into two groups;
"relative", and "absolute". The relative systems define each axis
value with respect to the rest frequency, whereas the absolute systems
have axis values which do not depend on the rest frequency. In order
to convert an axis value from a system in one group to a system in the
other group, the rest frequency must be known. However, the rest
frequency is not necessary in order to convert axis values between two
systems belonging to the same group. Determine if the alignment system
is absolute or relative. If absolute, we ignore the system of the supplied
"align_frm" and align in frequency, since aligning in any absolute system
will automatically ensure that all the other absolute systems are aligned.
Similarly, aligning in any relative system will automatically ensure that
all the other relative systems are aligned. Doing this cuts down the
complexity of the conversion process since we do not need to check every
possible alignment system. */
align_system = ( ABS_SYSTEM( align_system ) ) ? AST__FREQ : AST__VREL;
/* The total Mapping is made up of the following steps in series:
0) Convert from an offset value to an absolute value (if SpecOrigin set)
1) Convert target units to default units for the targets system
2) Convert from target system in target SOR to frequency in target SOR
3) Convert from freq in target SOR to freq in alignment SOR
4) Convert from freq in alignment SOR to alignment system in alignment SOR
5) Convert from alignment system in alignment SOR to freq in alignment SOR
6) Convert from freq in alignment SOR to freq in result SOR
7) Convert from freq in result SOR to result system in result SOR
8) Convert default units for the result system to results unit
9) Convert from an absolute value to an offset value (if SpecOrigin set)
Steps 1,2,3,4 are performed using the attributes of the target (rest
frequency, reference farem, etc), whilst steps 5,6,7,8 are performed
using the attributes of the target (rest frequency, reference frame,
etc). It is necessary to go from target system to alignment system
via frequency because SOR conversion can only be performed in the
frequency domain.
Some of these steps may not be necessary. Initially assume all steps
are necessary (we leave steps 0, 1, 8 and 9 out of this process and
implement them once all other steps have been done). */
step2 = 1;
step3 = 1;
step4 = 1;
step5 = 1;
step6 = 1;
step7 = 1;
/* Step 2 is not necessary if the target system is frequency. */
if( target_system == AST__FREQ ) step2 = 0;
/* Step 3 is not necessary if the alignment SOR is the same as the target
SOR. */
if( EqualSor( target, align_target, status ) ) step3 = 0;
/* Step 6 is not necessary if the alignment SOR is the same as the result
SOR. */
if( EqualSor( result, align_result, status ) ) step6 = 0;
/* Step 7 is not necessary if the result system is frequency. */
if( result_system == AST__FREQ ) step7 = 0;
/* Steps 4 and 5 are not necessary if the alignment system is frequency,
or if the target and result rest frequencies are equal. */
if( align_system == AST__FREQ || result_rf == target_rf ) step4 = step5 = 0;
/* Steps 3 and 6 are not necessary if steps 4 and 5 are not necessary, and
the target sor equals the result sor. */
if( !step4 && !step5 && EqualSor( target, result, status ) ) step3 = step6 = 0;
/* Steps 2 and 7 are not necessary if steps 3, 4, 5 and 6 are not necessary,
and the target sor equals the result sor, and the target and results
systems are equal (if the systems are relative they must also have equal
rest frequencies). */
if( !step3 && !step4 && !step5 && !step6 && EqualSor( target, result, status ) &&
target_system == result_system ) {
if( !ABS_SYSTEM( target_system ) && result_rf == target_rf ) step2 = step7 = 0;
}
/* Now we know which steps are needed, let's do them (we delay unit
conversion to the end)... */
/* Step 2: target system in target rest frame to frequency in target rest
frame. */
if( step2 ) {
if( target_system != AST__FREQ ) {
/* If the target system is absolute, we can convert directly to frequency. */
if ( target_system == AST__ENERGY ) {
TRANSFORM_0( "ENTOFR" )
} else if ( target_system == AST__WAVENUM ) {
TRANSFORM_0( "WNTOFR" )
} else if ( target_system == AST__WAVELEN ) {
TRANSFORM_0( "WVTOFR" )
} else if ( target_system == AST__AIRWAVE ) {
TRANSFORM_0( "AWTOFR" )
/* If the target target_system is relative, we first need to convert to
apparent radial velocity, and then to frequency using the rest frequency. */
} else {
if ( target_system == AST__VRADIO ) {
TRANSFORM_0( "VRTOVL" )
} else if ( target_system == AST__VOPTICAL ) {
TRANSFORM_0( "VOTOVL" )
} else if ( target_system == AST__REDSHIFT ) {
TRANSFORM_0( "ZOTOVL" )
} else if ( target_system == AST__BETA ) {
TRANSFORM_0( "BTTOVL" )
}
VerifyAttrs( target, vmess, "RestFreq", "astMatch", status );
TRANSFORM_1( "VLTOFR", target_rf )
}
}
}
/* Step 3: frequency in target rest frame to frequency in alignment rest
frame. */
if( step3 ) match = SorConvert( target, align_target, specmap, status );
/* Step 4: frequency in alignment rest frame to alignment system in alignment
rest frame. The alignment will be either relativistic velocity or
frequency. */
if( step4 ) {
if( align_system == AST__VREL ) {
VerifyAttrs( target, vmess, "RestFreq", "astMatch", status );
TRANSFORM_1( "FRTOVL", target_rf )
}
}
/* Step 5: Alignment system in alignment rest frame to frequency in alignment
rest frame (from now on use the attributes of the result SpecFrame to
define the conversion parameters). */
if( step5 ) {
if( align_system == AST__VREL ) {
VerifyAttrs( result, vmess, "RestFreq", "astMatch", status );
TRANSFORM_1( "VLTOFR", result_rf )
}
}
/* Step 6: frequency in alignment rest frame to frequency in result rest
frame. */
if( step6 ) match = SorConvert( align_result, result, specmap, status );
/* Step 7: frequency in result rest frame to result system in result rest
frame. */
if( step7 ) {
if( result_system != AST__FREQ ) {
/* If the results system is absolute, we can convert directly. */
if ( result_system == AST__ENERGY ) {
TRANSFORM_0( "FRTOEN" )
} else if ( result_system == AST__WAVENUM ) {
TRANSFORM_0( "FRTOWN" )
} else if ( result_system == AST__WAVELEN ) {
TRANSFORM_0( "FRTOWV" )
} else if ( result_system == AST__AIRWAVE ) {
TRANSFORM_0( "FRTOAW" )
/* If the result system is relative, we first need to convert to apparent
radial velocity from frequency using the rest frequency. Report an error
if the rest frequency is undefined. */
} else {
VerifyAttrs( result, vmess, "RestFreq", "astMatch", status );
TRANSFORM_1( "FRTOVL", result_rf )
/* Now convert from apparent radial velocity to the required result system. */
if ( result_system == AST__VRADIO ) {
TRANSFORM_0( "VLTOVR" )
} else if ( result_system == AST__VOPTICAL ) {
TRANSFORM_0( "VLTOVO" )
} else if ( result_system == AST__REDSHIFT ) {
TRANSFORM_0( "VLTOZO" )
} else if ( result_system == AST__BETA ) {
TRANSFORM_0( "VLTOBT" )
}
}
}
}
/* The SpecMap created above class assumes that the axis values supplied to
its Transform method are in units which correspond to the default units
for its class (the returned values also use these units). However,
the Unit attributes of the supplied Frames may have been set to some
non-default value, and so we need to add Mappings before and after the
SpecMap which convert to and from the default units. Find the Mapping
from the target Frame Units to the default Units for the target's system. */
utarg = astGetUnit( target, 0 );
umap1 = astUnitMapper( utarg, SpecMapUnit( target_system, "MakeSpecMap",
"SpecFrame", status ), NULL, NULL );
/* Find the Mapping from the default Units for the result's system to the
Units of the result Frame. */
ures = astGetUnit( result, 0 );
umap2 = astUnitMapper( SpecMapUnit( result_system, "MakeSpecMap",
"SpecFrame", status ), ures, NULL, NULL );
/* If both units Mappings were created OK, sandwich the SpecMap between
them. */
if( umap1 && umap2 ) {
map1 = (AstMapping *) astCmpMap( umap1, specmap, 1, "", status );
map2 = (AstMapping *) astCmpMap( map1, umap2, 1, "", status );
map1 = astAnnul( map1 );
/* If the simplified SpecMap is a UnitMap, and the target and result
units are the same, we do not need to know the mapping between units.
Otherwise, report an error and indicate that we cannot convert between
the Frames. */
} else {
map2 = astSimplify( specmap );
if( !astIsAUnitMap( map2 ) || strcmp( ures, utarg ) ) {
match = 0;
if( astOK && report ) {
if( !umap1 ) {
uerr = utarg;
serr = astGetSystem( target );
} else {
uerr = ures;
serr = astGetSystem( result );
}
astError( AST__BADUN, "astMatch(SpecFrame): Inappropriate units (%s) "
"specified for a %s axis.", status, uerr, SystemLabel( serr, status ) );
}
}
}
/* Step 0: offset to absolute value in target system. Prepend the Maping created
above with a ShiftMap that does the required shift of origin. */
target_origin = GetSpecOriginCur( target, status );
if( target_origin != 0.0 ) {
sm = astShiftMap( 1, &target_origin, "", status );
map1 = (AstMapping *) astCmpMap( sm, map2, 1, "", status );
sm = astAnnul( sm );
} else {
map1 = astClone( map2 );
}
map2 = astAnnul( map2 );
/* Step 9: absolute value to offset in result system. If we are aligning in the
offset system, use the transformed target origin as the new zero point.
Otherwise use the origin from the result frame. First get the origin for the
result system. */
if( astGetAlignSpecOffset( target ) && astGetAlignSpecOffset( result ) ) {
result_origin = 0.0;
astTran1( map1, 1, &result_origin, 1, &result_origin );
} else {
result_origin = GetSpecOriginCur( result, status );
}
/* Now create the ShiftMap and apend it to the end of the Maping. */
if( result_origin != 0.0 ) {
result_origin = -result_origin;
sm = astShiftMap( 1, &result_origin, "", status );
map2 = (AstMapping *) astCmpMap( map1, sm, 1, "", status );
sm = astAnnul( sm );
} else {
map2 = astClone( map1 );
}
map1 = astAnnul( map1 );
/* Return the simplified Mapping. */
*map = astSimplify( map2 );
/* Annul remaining resources. */
map2 = astAnnul( map2 );
specmap = astAnnul( specmap );
if( umap1 ) umap1 = astAnnul( umap1 );
if( umap2 ) umap2 = astAnnul( umap2 );
align_result = astAnnul( align_result );
align_target = astAnnul( align_target );
/* If an error occurred, annul the returned Mapping and clear the returned
values. */
if ( !astOK ) {
*map = astAnnul( *map );
match = 0;
}
/* Return the result. */
return match;
/* Undefine macros local to this function. */
#undef MAX_ARGS
#undef TRANSFORM_0
#undef TRANSFORM_1
}
static int Match( AstFrame *template_frame, AstFrame *target, int matchsub,
int **template_axes, int **target_axes, AstMapping **map,
AstFrame **result, int *status ) {
/*
* Name:
* Match
* Purpose:
* Determine if conversion is possible between two coordinate systems.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int Match( AstFrame *template, AstFrame *target, int matchsub,
* int **template_axes, int **target_axes,
* AstMapping **map, AstFrame **result, int *status )
* Class Membership:
* SpecFrame member function (over-rides the protected astMatch method
* inherited from the Frame class).
* Description:
* This function matches a "template" SpecFrame to a "target" Frame and
* determines whether it is possible to convert coordinates between them.
* If it is, a mapping that performs the transformation is returned along
* with a new Frame that describes the coordinate system that results when
* this mapping is applied to the "target" coordinate system. In addition,
* information is returned to allow the axes in this "result" Frame to be
* associated with the corresponding axes in the "target" and "template"
* Frames from which they are derived.
* Parameters:
* template
* Pointer to the template SpecFrame. This describes the coordinate
* system (or set of possible coordinate systems) into which we wish to
* convert our coordinates.
* target
* Pointer to the target Frame. This describes the coordinate system in
* which we already have coordinates.
* matchsub
* If zero then a match only occurs if the template is of the same
* class as the target, or of a more specialised class. If non-zero
* then a match can occur even if this is not the case.
* template_axes
* Address of a location where a pointer to int will be returned if the
* requested coordinate conversion is possible. This pointer will point
* at a dynamically allocated array of integers with one element for each
* axis of the "result" Frame (see below). It must be freed by the caller
* (using astFree) when no longer required.
*
* For each axis in the result Frame, the corresponding element of this
* array will return the index of the template SpecFrame axis from
* which it is derived. If it is not derived from any template
* SpecFrame axis, a value of -1 will be returned instead.
* target_axes
* Address of a location where a pointer to int will be returned if the
* requested coordinate conversion is possible. This pointer will point
* at a dynamically allocated array of integers with one element for each
* axis of the "result" Frame (see below). It must be freed by the caller
* (using astFree) when no longer required.
*
* For each axis in the result Frame, the corresponding element of this
* array will return the index of the target Frame axis from which it
* is derived. If it is not derived from any target Frame axis, a value
* of -1 will be returned instead.
* map
* Address of a location where a pointer to a new Mapping will be
* returned if the requested coordinate conversion is possible. If
* returned, the forward transformation of this Mapping may be used to
* convert coordinates between the "target" Frame and the "result"
* Frame (see below) and the inverse transformation will convert in the
* opposite direction.
* result
* Address of a location where a pointer to a new Frame will be returned
* if the requested coordinate conversion is possible. If returned, this
* Frame describes the coordinate system that results from applying the
* returned Mapping (above) to the "target" coordinate system. In
* general, this Frame will combine attributes from (and will therefore
* be more specific than) both the target and the template Frames. In
* particular, when the template allows the possibility of transformaing
* to any one of a set of alternative coordinate systems, the "result"
* Frame will indicate which of the alternatives was used.
* status
* Pointer to the inherited status variable.
* Returned Value:
* A non-zero value is returned if the requested coordinate conversion is
* possible. Otherwise zero is returned (this will not in itself result in
* an error condition).
* Notes:
* - A value of zero will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
* Implementation Notes:
* This implementation addresses the matching of a SpecFrame class
* object to any other class of Frame. A SpecFrame will match any class
* of SpecFrame (i.e. possibly from a derived class) but will not match
* a less specialised class of Frame.
*/
/* Local Variables: */
AstFrame *frame0; /* Pointer to Frame underlying axis 0 */
AstSpecFrame *template; /* Pointer to template SpecFrame structure */
int iaxis0; /* Axis index underlying axis 0 */
int iaxis; /* Axis index */
int match; /* Coordinate conversion possible? */
int target_axis0; /* Index of SpecFrame axis in the target */
int target_naxes; /* Number of target axes */
/* Initialise the returned values. */
*template_axes = NULL;
*target_axes = NULL;
*map = NULL;
*result = NULL;
match = 0;
/* Check the global error status. */
if ( !astOK ) return match;
/* Obtain a pointer to the template SpecFrame structure. */
template = (AstSpecFrame *) template_frame;
/* Obtain the number of axes in the target Frame. */
target_naxes = astGetNaxes( target );
/* The first criterion for a match is that the template matches as a
Frame class object. This ensures that the number of axes (1) and
domain, etc. of the target Frame are suitable. Invoke the parent
"astMatch" method to verify this. */
match = (*parent_match)( template_frame, target, matchsub,
template_axes, target_axes, map, result, status );
/* If a match was found, annul the returned objects, which are not
needed, but keep the memory allocated for the axis association
arrays, which we will re-use. */
if ( astOK && match ) {
*map = astAnnul( *map );
*result = astAnnul( *result );
}
/* If OK so far, obtain pointers to the primary Frames which underlie
all target axes. Stop when a SpecFrame axis is found. */
if ( match && astOK ) {
match = 0;
for( iaxis = 0; iaxis < target_naxes; iaxis++ ) {
astPrimaryFrame( target, iaxis, &frame0, &iaxis0 );
if( astIsASpecFrame( frame0 ) ) {
frame0 = astAnnul( frame0 );
target_axis0 = iaxis;
match = 1;
break;
} else {
frame0 = astAnnul( frame0 );
}
}
}
/* Check at least one SpecFrame axis was found it the target. Store the
axis associataions. */
if( match && astOK ) {
(*template_axes)[ 0 ] = 0;
(*target_axes)[ 0 ] = target_axis0;
/* Use the target's "astSubFrame" method to create a new Frame (the
result Frame) with copies of the target axes in the required
order. This process also overlays the template attributes on to the
target Frame and returns a Mapping between the target and result
Frames which effects the required coordinate conversion. */
match = astSubFrame( target, template, 1, *target_axes, *template_axes,
map, result );
}
/* If an error occurred, or conversion to the result Frame's
coordinate system was not possible, then free all memory, annul the
returned objects, and reset the returned value. */
if ( !astOK || !match ) {
*template_axes = astFree( *template_axes );
*target_axes = astFree( *target_axes );
if( *map ) *map = astAnnul( *map );
if( *result ) *result = astAnnul( *result );
match = 0;
}
/* Return the result. */
return match;
}
static void OriginStdOfRest( AstSpecFrame *this, AstStdOfRestType newsor,
const char *method, int *status ){
/*
* Name:
* OriginStdOfRest
* Purpose:
* Convert the SpecOrigin in a SpecFrame to a new rest frame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void OriginStdOfRest( AstSpecFrame *this, AstStdOfRestType newsor,
* const char *method, int *status )
* Class Membership:
* SpecFrame member function
* Description:
* This function converts the value of the SpecOrigin attribute stored
* within a supplied SpecFrame from the rest frame currently associated
* with the SpecFrame, to the new rest frame indicated by "newsor".
* Parameters:
* this
* Point to the SpecFrame. On entry, the SpecOrigin value is
* assumed to refer to the re st frame given by the astGetStdOfRest
* method. On exit, the SpecOrigin value refers to the rest frame
* supplied in "newsor". The StdOfRest attribute of the SpecFrame
* should then be modified in order to keep things consistent.
* newsor
* The rest frame to which the SpecOrigin value stored within "this"
* should refer on exit.
* method
* Pointer to a string holding the name of the method to be
* included in any error messages.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstSpecFrame *sf;
AstFrameSet *fs;
double origin;
double neworigin;
/* Check the global error status. */
if ( !astOK ) return;
/* Do nothing if the SpecOrigin attribute has not been assigned a value. */
if( astTestSpecOrigin( this ) ) {
/* Do nothing if the rest frame will not change. */
if( newsor != astGetStdOfRest( this ) ) {
/* Save the original SpecOrigin value (in the current SpecFrame units) and then
clear it. */
origin = GetSpecOriginCur( this, status );
astClearSpecOrigin( this );
/* Take a copy of the SpecFrame and set the new StdOfRest. */
sf = astCopy( this );
astSetStdOfRest( sf, newsor );
/* Create a Mapping to perform the rest frame change, then use it to convert
the value to the new rest frame. */
fs = astConvert( this, sf, "" );
neworigin = AST__BAD;
if( fs ) {
astTran1( fs, 1, &origin, 1, &neworigin );
fs = astAnnul( fs );
}
/* If succesful, convert from the current units to the default units, and store
in "this". */
if( neworigin != AST__BAD ) {
astSetSpecOrigin( this, ToUnits( this, astGetUnit( this, 0 ), neworigin,
method, status ) );
} else if( astOK ) {
astError( AST__ATSER, "%s(%s): Cannot convert the SpecOrigin "
"value to a different rest frame.", status, method,
astGetClass( this ) );
}
}
}
}
static void OriginSystem( AstSpecFrame *this, AstSystemType oldsys,
const char *method, int *status ){
/*
* Name:
* OriginSystem
* Purpose:
* Convert the SpecOrigin in a SpecFrame to a new System.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void OriginSystem( AstSpecFrame *this, AstSystemType oldsys,
* const char *method, int *status )
* Class Membership:
* SpecFrame member function
* Description:
* This function converts the value of the SpecOrigin attribute stored
* within a supplied SpecFrame from its original System, etc, to the
* System, etc, currently associated with the SpecFrame.
* Parameters:
* this
* Point to the SpecFrame. On entry, the SpecOrigin value is
* assumed to refer to the System given by "oldsys", etc. On exit, the
* SpecOrigin value refers to the System returned by the astGetSystem
* method, etc.
* oldsys
* The System to which the SpecOrigin value stored within "this"
* refers on entry.
* method
* A string containing the method name for error messages.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstSpecFrame *sf1;
AstSpecFrame *sf2;
AstFrameSet *fs;
double origin;
double neworigin;
/* Check the global error status. */
if ( !astOK ) return;
/* Do nothing if the SpecOrigin attribute has not been assigned a value. */
if( astTestSpecOrigin( this ) ) {
/* Do nothing if the System will not change. */
if( oldsys != astGetSystem( this ) ) {
/* Note the original SpecOrigin value, in the SpecFrame's default units. */
origin = astGetSpecOrigin( this );
/* Take a copy of the original SpecFrame and ensure the Units, SpecOrigin and
AlignSpecOffset attributes are cleared. */
sf1 = astCopy( this );
astClearUnit( sf1, 0 );
astClearSpecOrigin( sf1 );
astClearAlignSpecOffset( sf1 );
/* Take another copy of the SpecFrame and set the old system. */
sf2 = astCopy( sf1 );
astSetSystem( sf2, oldsys );
/* Create a Mapping to perform the rest frame change, then use it to convert
the value to the current system. */
fs = astConvert( sf2, sf1, "" );
neworigin = AST__BAD;
if( fs ) {
astTran1( fs, 1, &origin, 1, &neworigin );
fs = astAnnul( fs );
}
/* Free resources */
sf1 = astAnnul( sf1 );
sf2 = astAnnul( sf2 );
/* If succesful, store it in "this". */
if( neworigin != AST__BAD ) {
astSetSpecOrigin( this, neworigin );
} else if( astOK ) {
astError( AST__ATSER, "%s(%s): Cannot convert the SpecOrigin "
"value to a different spectral system.", status, method,
astGetClass( this ) );
}
}
}
}
static void Overlay( AstFrame *template, const int *template_axes,
AstFrame *result, int *status ) {
/*
* Name:
* Overlay
* Purpose:
* Overlay the attributes of a template SpecFrame on to another Frame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void Overlay( AstFrame *template, const int *template_axes,
* AstFrame *result, int *status )
* Class Membership:
* SpecFrame member function (over-rides the protected astOverlay method
* inherited from the Frame class).
* Description:
* This function overlays attributes of a SpecFrame (the "template") on to
* another Frame, so as to over-ride selected attributes of that second
* Frame. Normally only those attributes which have been specifically set
* in the template will be transferred. This implements a form of
* defaulting, in which a Frame acquires attributes from the template, but
* retains its original attributes (as the default) if new values have not
* previously been explicitly set in the template.
*
* Note that if the result Frame is a SpecFrame and a change of spectral
* coordinate system occurs as a result of overlaying its System
* attribute, then some of its original attribute values may no
* longer be appropriate (e.g. the Title, or attributes describing
* its axes). In this case, these will be cleared before overlaying
* any new values.
* Parameters:
* template
* Pointer to the template SpecFrame, for which values should have been
* explicitly set for any attribute which is to be transferred.
* template_axes
* Pointer to an array of int, with one element for each axis of the
* "result" Frame (see below). For each axis in the result frame, the
* corresponding element of this array should contain the (zero-based)
* index of the template axis to which it corresponds. This array is used
* to establish from which template axis any axis-dependent attributes
* should be obtained.
*
* If any axis in the result Frame is not associated with a template
* axis, the corresponding element of this array should be set to -1.
*
* If a NULL pointer is supplied, the template and result axis
* indices are assumed to be identical.
* result
* Pointer to the Frame which is to receive the new attribute values.
* status
* Pointer to the inherited status variable.
* Returned Value:
* void
* Notes:
* - In general, if the result Frame is not from the same class as the
* template SpecFrame, or from a class derived from it, then attributes may
* exist in the template SpecFrame which do not exist in the result Frame.
* In this case, these attributes will not be transferred.
*/
/* Local Variables: */
AstFrame *templt; /* Copy of supplied template Frame */
AstSystemType new_system; /* Code identifying new cordinates */
AstSystemType old_system; /* Code identifying old coordinates */
const char *method; /* Pointer to method string */
const char *new_class; /* Pointer to template class string */
const char *old_class; /* Pointer to result class string */
int specframe; /* Result Frame is a SpecFrame? */
/* Check the global error status. */
if ( !astOK ) return;
/* Initialise strings used in error messages. */
new_class = astGetClass( template );
old_class = astGetClass( result );
method = "astOverlay";
/* Get the old and new systems. */
old_system = astGetSystem( result );
new_system = astGetSystem( template );
/* It may be necessary to make temporary changes to the template Frame
below. In order to ensure that we make no permanent changes to the
supplied frame, we will, if necessary, take a deep copy of the
supplied Frame, storing a pointer to the copy in "templt". If it is
not necessary to make any changes to the template, we still want
"templt" to hold a usable pointer, so we initialise it now to hold a
clone of the supplied pointer. This pointer will be replaced by a
pointer to a deep copy (if required) below. */
templt = astClone( template );
/* If the result Frame is a SpecFrame, we must test to see if overlaying its
System attribute will change the type of coordinate system it describes.
Determine the value of this attribute for the result and template
SpecFrames. */
specframe = astIsASpecFrame( result );
if( specframe ) {
/* If the coordinate system will change, any value already set for the result
SpecFrame's Title will no longer be appropriate, so clear it. */
if ( new_system != old_system ) {
astClearTitle( result );
/* If the systems have the same default units, we can retain the current
Unit value. */
if( strcmp( DefUnit( new_system, method, new_class, status ),
DefUnit( old_system, method, old_class, status ) ) ) {
astClearUnit( result, 0 );
}
/* If necessary, clear inappropriate values for all those axis attributes
whose access functions are over-ridden by this class (these access functions
will then provide suitable defaults appropriate to the new coordinate system
instead). */
astClearLabel( result, 0 );
astClearSymbol( result, 0 );
}
/* If the result Frame is not a SpecFrame, we must temporarily clear the
System and AlignSystem values since the values used by this class
are only appropriate to this class. Use a deep copy to avoid the danger
of making any permanent changes to the suppied Frame. */
} else {
if( astTestSystem( template ) ) {
templt = astAnnul( templt );
templt = astCopy( template );
astClearSystem( templt );
astClearAlignSystem( templt );
}
}
/* Invoke the parent class astOverlay method to transfer attributes inherited
from the parent class. */
(*parent_overlay)( templt, template_axes, result, status );
/* Check if the result Frame is a SpecFrame or from a class derived from
SpecFrame. If not, we cannot transfer SpecFrame attributes to it as it is
insufficiently specialised. In this case simply omit these attributes. */
if ( specframe && astOK ) {
/* Define macros that test whether an attribute is set in the template and,
if so, transfers its value to the result. */
#define OVERLAY(attribute) \
if ( astTest##attribute( template ) ) { \
astSet##attribute( result, astGet##attribute( template ) ); \
}
/* Use the macro to transfer each SpecFrame attribute in turn. Note,
SourceVRF must be overlayed before SourceVel. Otherwise the stored value
for SourceVel would be changed from the default SourceVRF to the specified
SourceVRF when SourceVRF was overlayed. */
OVERLAY(AlignStdOfRest)
OVERLAY(AlignSpecOffset);
OVERLAY(RefDec)
OVERLAY(RefRA)
OVERLAY(RestFreq)
OVERLAY(SourceSys)
OVERLAY(SourceVRF)
OVERLAY(SourceVel)
OVERLAY(StdOfRest)
OVERLAY(SpecOrigin)
}
/* Free resources */
templt = astAnnul( templt );
/* Undefine macros local to this function. */
#undef OVERLAY
}
static void SetAttrib( AstObject *this_object, const char *setting, int *status ) {
/*
* Name:
* SetAttrib
* Purpose:
* Set an attribute value for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void SetAttrib( AstObject *this, const char *setting, int *status )
* Class Membership:
* SpecFrame member function (extends the astSetAttrib method inherited from
* the Mapping class).
* Description:
* This function assigns an attribute value for a SpecFrame, the attribute
* and its value being specified by means of a string of the form:
*
* "attribute= value "
*
* Here, "attribute" specifies the attribute name and should be in lower
* case with no white space present. The value to the right of the "="
* should be a suitable textual representation of the value to be assigned
* and this will be interpreted according to the attribute's data type.
* White space surrounding the value is only significant for string
* attributes.
* Parameters:
* this
* Pointer to the SpecFrame.
* setting
* Pointer to a null terminated string specifying the new attribute
* value.
* status
* Pointer to the inherited status variable.
* Returned Value:
* void
* Notes:
* This protected method is intended to be invoked by the Object astSet
* method and makes additional attributes accessible to it.
*/
/* Local Vaiables: */
AstMapping *umap; /* Mapping between units */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
AstStdOfRestType sor; /* Standard of rest type code */
AstSystemType sys; /* Spectral system type code */
char *a; /* Pointer to next character */
char *new_setting; /* Pointer value to new attribute setting */
double dval; /* Double atribute value */
double dtemp; /* Temporary double atribute value */
int ival; /* Integer attribute value */
int len; /* Length of setting string */
int ulen; /* Used length of setting string */
int namelen; /* Length of attribute name in setting */
int nc; /* Number of characters read by astSscanf */
int off; /* Offset of attribute value */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_object;
/* Create an FK5 J2000 SkyFrame which will be used for formatting and
unformatting sky positions, etc. */
LOCK_MUTEX2
if( !skyframe ) {
astBeginPM;
skyframe = astSkyFrame( "system=FK5,equinox=J2000", status );
astEndPM;
}
UNLOCK_MUTEX2
/* Obtain the length of the setting string. */
len = strlen( setting );
/* Obtain the used length of the setting string. */
ulen = astChrLen( setting );
/* Test for each recognised attribute in turn, using "astSscanf" to parse the
setting string and extract the attribute value (or an offset to it in the
case of string values). In each case, use the value set in "nc" to check
that the entire string was matched. Once a value has been obtained, use the
appropriate method to set it. */
/* First look for axis attributes defined by the Frame class. Since a
SpecFrame has only 1 axis, we allow these attributes to be specified
without a trailing "(axis)" string. */
if ( !strncmp( setting, "direction=", 10 ) ||
!strncmp( setting, "bottom=", 7 ) ||
!strncmp( setting, "top=", 4 ) ||
!strncmp( setting, "format=", 7 ) ||
!strncmp( setting, "label=", 6 ) ||
!strncmp( setting, "symbol=", 7 ) ||
!strncmp( setting, "unit=", 5 ) ) {
/* Create a new setting string from the original by appending the string
"(1)" to the end of the attribute name and then use the parent SetAttrib
method. */
new_setting = astMalloc( len + 4 );
if( new_setting ) {
memcpy( new_setting, setting, len + 1 );
a = strchr( new_setting, '=' );
namelen = a - new_setting;
memcpy( a, "(1)", 4 );
a += 3;
strcpy( a, setting + namelen );
(*parent_setattrib)( this_object, new_setting, status );
new_setting = astFree( new_setting );
}
/* AlignStdOfRest. */
/* --------------- */
} else if ( nc = 0,
( 0 == astSscanf( setting, "alignstdofrest=%n%*s %n", &off, &nc ) )
&& ( nc >= len ) ) {
/* Convert the string to a StdOfRest code before use. */
sor = StdOfRestCode( setting + off, status );
if ( sor != AST__BADSOR ) {
astSetAlignStdOfRest( this, sor );
/* Report an error if the string value wasn't recognised. */
} else {
astError( AST__ATTIN, "astSetAttrib(%s): Invalid standard of rest "
"description \"%s\".", status, astGetClass( this ), setting+off );
}
/* GeoLat. */
/* ------- */
/* Retained for backward compatibility with older versions of AST in which
SpecFrame had GeoLon/Lat attributes (now ObsLon/Lat are used instead). */
} else if ( nc = 0,
( 0 == astSscanf( setting, "geolat=%n%*s %n", &off, &nc ) )
&& ( nc >= 7 ) ) {
new_setting = astStore( NULL, setting, len + 1 );
new_setting[ 0 ] = 'o';
new_setting[ 1 ] = 'b';
new_setting[ 2 ] = 's';
astSetAttrib( this, new_setting );
new_setting = astFree( new_setting );
/* GeoLon. */
/* ------- */
} else if ( nc = 0,
( 0 == astSscanf( setting, "geolon=%n%*s %n", &off, &nc ) )
&& ( nc >= 7 ) ) {
new_setting = astStore( NULL, setting, len + 1 );
new_setting[ 0 ] = 'o';
new_setting[ 1 ] = 'b';
new_setting[ 2 ] = 's';
astSetAttrib( this, new_setting );
new_setting = astFree( new_setting );
/* RefDec. */
/* ------- */
} else if ( nc = 0,
( 0 == astSscanf( setting, "refdec=%n%*s %n", &off, &nc ) )
&& ( nc >= 7 ) ) {
/* Convert the string to a radians value before use. */
ival = astUnformat( skyframe, 1, setting + off, &dval );
if ( ival == ulen - off ) {
astSetRefDec( this, dval );
/* Report an error if the string value wasn't recognised. */
} else {
astError( AST__ATTIN, "astSetAttrib(%s): Invalid reference "
"declination \"%s\".", status, astGetClass( this ), setting + off );
}
/* RefRA. */
/* ------ */
} else if ( nc = 0,
( 0 == astSscanf( setting, "refra=%n%*s %n", &off, &nc ) )
&& ( nc >= 6 ) ) {
/* Convert the string to a radians value before use. */
ival = astUnformat( skyframe, 0, setting + off, &dval );
if ( ival == ulen - off ) {
astSetRefRA( this, dval );
/* Report an error if the string value wasn't recognised. */
} else {
astError( AST__ATTIN, "astSetAttrib(%s): Invalid reference right "
"ascension \"%s\".", status, astGetClass( this ), setting + off );
}
/* AlignSpecOffset. */
/* ---------------- */
} else if ( nc = 0,
( 1 == astSscanf( setting, "alignspecoffset= %d %n", &ival, &nc ) )
&& ( nc >= len ) ) {
astSetAlignSpecOffset( this, ival );
/* RestFreq. */
/* --------- */
/* Without any units indication - assume GHz. Convert to Hz for storage. */
} else if ( nc = 0,
( 1 == astSscanf( setting, "restfreq= %lg %n", &dval, &nc ) )
&& ( nc >= len ) ) {
astSetRestFreq( this, dval*1.0E9 );
/* With units indication. */
} else if ( nc = 0,
( 1 == astSscanf( setting, "restfreq= %lg %n%*s %n", &dval, &off, &nc ) )
&& ( nc >= len ) ) {
dtemp = AST__BAD;
/* Is there a Mapping from the supplied units to Hz? If so, use the
Mapping to convert the supplied value to Hz. */
if( ( umap = astUnitMapper( setting + off, "Hz", NULL, NULL ) ) ) {
astTran1( umap, 1, &dval, 1, &dtemp );
umap = astAnnul( umap );
/* Otherwise, if there is a Mapping from the supplied units to metre,
assume the supplied unit is a vacuum wavelength. */
} else if( ( umap = astUnitMapper( setting + off, "m", NULL, NULL ) ) ) {
/* Convert the supplied wavelength to metres. */
astTran1( umap, 1, &dval, 1, &dtemp );
umap = astAnnul( umap );
/* Convert the wavelength (m) to frequency (Hz). */
if( dtemp != AST__BAD && dtemp != 0.0 ) {
dtemp = AST__C/dtemp;
} else if( astOK ) {
astError( AST__ATTIN, "astSetAttrib(%s): Invalid rest wavelength "
"\"%g %s\" supplied.", status, astGetClass( this ), dval, setting + off );
}
/* Otherwise, if there is a Mapping from the supplied units to Joule,
assume the supplied unit is an energy. */
} else if( ( umap = astUnitMapper( setting + off, "J", NULL, NULL ) ) ) {
/* Convert the supplied energy to Joules. */
astTran1( umap, 1, &dval, 1, &dtemp );
umap = astAnnul( umap );
/* Convert the energy (J) to frequency (Hz). */
if( dtemp != AST__BAD ) {
dtemp *= 1.0/AST__H;
} else if( astOK ) {
astError( AST__ATTIN, "astSetAttrib(%s): Invalid rest energy "
"\"%g %s\" supplied.", status, astGetClass( this ), dval, setting + off );
}
/* Otherwise report an error. */
} else if( astOK ) {
astError( AST__ATTIN, "astSetAttrib(%s): Rest frequency given in an "
"unsupported system of units \"%g %s\".", status,
astGetClass( this ), dval, setting + off );
}
/* Set the rest frequency. */
astSetRestFreq( this, dtemp );
/* SourceVel. */
/* ---------- */
} else if ( nc = 0,
( 1 == astSscanf( setting, "sourcevel= %lg %n", &dval, &nc ) )
&& ( nc >= len ) ) {
/* Convert from km/s to m/s if the SourceVel value is a velocity. */
if( astGetSourceSys( this ) == AST__VREL ||
astGetSourceSys( this ) == AST__VRADIO ||
astGetSourceSys( this ) == AST__VOPTICAL ) dval *= 1.0E3;
/* Store the value */
astSetSourceVel( this, dval );
/* SourceVRF */
/* --------- */
} else if ( nc = 0,
( 0 == astSscanf( setting, "sourcevrf=%n%*s %n", &off, &nc ) )
&& ( nc >= len ) ) {
/* Convert the string to a StdOfRest code before use. */
sor = StdOfRestCode( setting + off, status );
if ( sor != AST__BADSOR ) {
astSetSourceVRF( this, sor );
/* Report an error if the string value wasn't recognised. */
} else {
astError( AST__ATTIN, "astSetAttrib(%s): Invalid standard of rest "
"description \"%s\".", status, astGetClass( this ), setting+off );
}
/* SourceSys */
/* --------- */
} else if ( nc = 0,
( 0 == astSscanf( setting, "sourcesys=%n%*s %n", &off, &nc ) )
&& ( nc >= len ) ) {
/* Convert the string to a System code before use. */
sys = SystemCode( (AstFrame *) this, setting + off, status );
astSetSourceSys( this, sys );
/* StdOfRest. */
/* ---------- */
} else if ( nc = 0,
( 0 == astSscanf( setting, "stdofrest=%n%*s %n", &off, &nc ) )
&& ( nc >= len ) ) {
/* Convert the string to a StdOfRest code before use. */
sor = StdOfRestCode( setting + off, status );
if ( sor != AST__BADSOR ) {
astSetStdOfRest( this, sor );
/* Report an error if the string value wasn't recognised. */
} else {
astError( AST__ATTIN, "astSetAttrib(%s): Invalid standard of rest "
"description \"%s\".", status, astGetClass( this ), setting + off );
}
/* SpecOrigin */
/* ---------- */
/* Floating-point without any units indication - assume the current Unit
value. Convert from current units to default units for current system. */
} else if ( nc = 0,
( 1 == astSscanf( setting, "specorigin= %lg %n", &dval, &nc ) )
&& ( nc >= len ) ) {
astSetSpecOrigin( this, ToUnits( this, astGetUnit( this, 0 ), dval,
"astSetSpecOrigin", status ) );
/* Floating-point with units. Convert the supplied value to the default units
for the SpecFrame's System. */
} else if ( nc = 0,
( 1 == astSscanf( setting, "specorigin= %lg %n%*s %n", &dval, &off, &nc ) )
&& ( nc >= len ) ) {
astSetSpecOrigin( this, ToUnits( this, setting + off, dval, "astSetSpecOrigin", status ) );
/* Pass any unrecognised setting to the parent method for further
interpretation. */
} else {
(*parent_setattrib)( this_object, setting, status );
}
}
static void SetRefPos( AstSpecFrame *this, AstSkyFrame *frm, double lon,
double lat, int *status ){
/*
*++
* Name:
c astSetRefPos
f AST_SETREFPOS
* Purpose:
* Set the reference position in a specified celestial coordinate system.
* Type:
* Public virtual function.
* Synopsis:
c #include "specframe.h"
c void astSetRefPos( AstSpecFrame *this, AstSkyFrame *frm, double lon,
c double lat )
f CALL AST_SETREFPOS( THIS, FRM, LON, LAT, STATUS )
* Class Membership:
* Frame method.
* Description:
c This function
f This routine
* sets the reference position (see attributes RefRA and RefDec) using
* axis values (in radians) supplied within the celestial coordinate
* system represented by a supplied SkyFrame.
* Parameters:
c this
f THIS = INTEGER (Given)
* Pointer to the SpecFrame.
c frm
f FRM = INTEGER (Given)
* Pointer to the SkyFrame which defines the celestial coordinate
* system in which the longitude and latitude values are supplied.
c If NULL
f If AST__NULL
* is supplied, then the supplied longitude and latitude values are
* assumed to be FK5 J2000 RA and Dec values.
c lon
f LON = DOUBLE PRECISION (Given)
* The longitude of the reference point, in the coordinate system
* represented by the supplied SkyFrame (radians).
c lat
f LAT = DOUBLE PRECISION (Given)
* The latitude of the reference point, in the coordinate system
* represented by the supplied SkyFrame (radians).
f STATUS = INTEGER (Given and Returned)
f The global status.
*--
*/
/* Local Variables: */
AstFrameSet *fs; /* Conversion FrameSet */
AstFrame *fb; /* Base Frame */
AstFrame *fc; /* Current Frame */
double xin[ 1 ]; /* Axis 1 values */
double yin[ 1 ]; /* Axis 2 values */
double xout[ 1 ]; /* Axis 1 values */
double yout[ 1 ]; /* Axis 2 values */
/* Check the global error status. */
if ( !astOK ) return;
/* If no SkyFrame was supplied, just store the supplied RefRA and RefDec
values. */
if( !frm ) {
astSetRefRA( this, lon );
astSetRefDec( this, lat );
/* Otherwise, convert the supplied values from the requested system. */
} else {
/* Create an FK5 J2000 SkyFrame which will be used for formatting and
unformatting sky positions, etc. */
LOCK_MUTEX2
if( !skyframe ) {
astBeginPM;
skyframe = astSkyFrame( "system=FK5,equinox=J2000", status );
astEndPM;
}
UNLOCK_MUTEX2
/* Find the Mapping from the supplied SkyFrame, to the SkyFrame which
describes the internal format in which the RefRA and RefDec attribute
values are stored. */
fs = astFindFrame( frm, skyframe, "" );
/* If alignment was possible, use the Mapping to transform the supplied
axis values, checking to see if the axes of the supplied SkyFrame have
been permuted. */
if( fs ) {
/* Find the longitude axis in the Base Frame, and store the supplied
longitude and latitude values. */
fb = astGetFrame( fs, AST__BASE );
if( astGetLonAxis( fb ) == 0 ) {
xin[ 0 ] = lon;
yin[ 0 ] = lat;
} else {
xin[ 0 ] = lat;
yin[ 0 ] = lon;
}
astTran2( fs, 1, xin, yin, 1, xout, yout );
/* Store the corresponding RefRA and RefDec values. */
fc = astGetFrame( fs, AST__CURRENT );
if( astGetLonAxis( fc ) == 0 ) {
astSetRefRA( this, xout[ 0 ] );
astSetRefDec( this, yout[ 0 ] );
} else {
astSetRefRA( this, yout[ 0 ] );
astSetRefDec( this, xout[ 0 ] );
}
/* Annul object references. */
fc = astAnnul( fc );
fb = astAnnul( fb );
fs = astAnnul( fs );
}
}
}
static void SetStdOfRest( AstSpecFrame *this, AstStdOfRestType value, int *status ) {
/*
*+
* Name:
* astSetStdOfRest
* Purpose:
* Set the StdOfRest attribute for a SpecFrame.
* Type:
* Protected function.
* Synopsis:
* #include "specframe.h"
* void astSetStdOfRest( AstSpecFrame *this, AstStdOfRestType value )
* Class Membership:
* SpecFrame virtual function
* Description:
* This function set a new value for the StdOfRest attribute for a
* SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* value
* The new value.
*-
*/
/* Check the global error status. */
if ( !astOK ) return;
/* Validate the StdOfRest value being set and report an error if necessary. */
if( value < FIRST_SOR || value > LAST_SOR ) {
astError( AST__ATTIN, "%s(%s): Bad value (%d) given for StdOfRest attribute.", status,
"astSetStdOfRest", astGetClass( this ), (int) value );
/* Otherwise set the new StdOfRest */
} else {
/* Modify the SpecOrigin value stored in the SpecFrame structure to refer
to the new rest frame. */
OriginStdOfRest( this, value, "astSetStdOfRest", status );
/* Store the new value for the rest frame in the SpecFrame structure. */
this->stdofrest = value;
}
}
static void SetSystem( AstFrame *this_frame, AstSystemType newsys, int *status ) {
/*
* Name:
* SetSystem
* Purpose:
* Set the System attribute for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void SetSystem( AstFrame *this_frame, AstSystemType newsys, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astSetSystem protected
* method inherited from the Frame class).
* Description:
* This function sets the System attribute for a SpecFrame.
* Parameters:
* this
* Pointer to the SpecFrame.
* newsys
* The new System value to be stored.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to SpecFrame structure */
AstSystemType oldsys; /* Original System value */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* Save the original System value */
oldsys = astGetSystem( this_frame );
/* Use the parent SetSystem method to store the new System value. */
(*parent_setsystem)( this_frame, newsys, status );
/* If the system has changed... */
if( oldsys != newsys ) {
/* Changing the System value will in general require the Units to change
as well. If the user has previously specified the units to be used with
the new system, then re-instate them (they are stored in the "usedunits"
array in the SpecFrame structure). Otherwise, clear the units so that
the default units will eb used with the new System. */
if( (int) newsys < this->nuunits && this->usedunits &&
this->usedunits[ (int) newsys ] ) {
astSetUnit( this, 0, this->usedunits[ (int) newsys ] );
} else {
astClearUnit( this, 0 );
}
/* Modify the stored SpecOrigin. */
OriginSystem( this, oldsys, "astSetSystem", status );
/* Also, clear all attributes which have system-specific defaults. */
astClearLabel( this_frame, 0 );
astClearSymbol( this_frame, 0 );
astClearTitle( this_frame );
}
}
static void SetUnit( AstFrame *this_frame, int axis, const char *value, int *status ) {
/*
* Name:
* SetUnit
* Purpose:
* Set a pointer to the Unit string for a SpecFrame's axis.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void SetUnit( AstFrame *this_frame, int axis, const char *value )
* Class Membership:
* SpecFrame member function (over-rides the astSetUnit method inherited
* from the Frame class).
* Description:
* This function stores a pointer to the Unit string for a specified axis
* of a SpecFrame. It also stores the string in the "usedunits" array
* in the SpecFrame structure, in the element associated with the
* current System.
* Parameters:
* this
* Pointer to the SpecFrame.
* axis
* The number of the axis (zero-based) for which information is required.
* unit
* The new string to store.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
int i; /* Loop counter */
int system; /* The SpecFrame's System value */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_frame;
/* Validate the axis index. */
astValidateAxis( this, axis, 1, "astSetUnit" );
/* Store the supplied value as the UsedUnit for the current System. First
ensure the array is big enough. Free any previous value stored for the
current system. */
system = (int) astGetSystem( this );
if( system >= this->nuunits ) {
this->usedunits = astGrow( this->usedunits, system + 1,
sizeof(char *) );
if( astOK ) {
for( i = this->nuunits; i < system + 1; i++ ) this->usedunits[ i ] = NULL;
this->nuunits = system + 1;
}
}
/* Now store a copy of the value, if it is different to the stored string. */
if( astOK && ( !this->usedunits[ system ] ||
strcmp( this->usedunits[ system ], value ) ) ) {
this->usedunits[ system ] = astStore( this->usedunits[ system ],
value, strlen( value ) + 1 );
}
/* Now use the parent SetUnit method to store the value in the Axis
structure */
(*parent_setunit)( this_frame, axis, value, status );
}
static int SorConvert( AstSpecFrame *this, AstSpecFrame *that,
AstSpecMap *specmap, int *status ) {
/*
* Name:
* SorConvert
* Purpose:
* Add a conversion to a SpecMap which transforms between two
* standards of rest.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int SorConvert( AstSpecFrame *this, AstSpecFrame *that,
* AstSpecMap *specmap, int *status )
* Class Membership:
* SpecFrame member function.
* Description:
* This function adds a conversion to a SpecMap which transforms
* frequencies from the standard of rest specified by "this" to
* the standard of rest specified by "that". Note the conversion is
* always between frequency in the two rest frames no matter what the
* System attributes of the two SpecFrames may be (which are ignored).
* Parameters:
* this
* The SpecFrame which defines the input rest frame.
* that
* The SpecFrame which defines the output rest frame.
* specmap
* The SpecMap to which the conversion is to be added.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Zero is returned if the conversion could not be performed. One is
* returned otherwise.
*/
/* Local Constants: */
#define MAX_ARGS 7 /* Max arguments for an SpecMap conversion */
/* Local Variables: */
AstStdOfRestType from; /* Input standard of rest */
AstStdOfRestType to; /* Output standard of rest */
const char *vmess; /* Text for use in error messages */
double args[ MAX_ARGS ]; /* Conversion argument array */
double dec; /* DEC of source (radians, FK5 J2000) */
double epoch; /* Epoch of observation (MJD) */
double alt; /* Observers geodetic altitude (radians) */
double lat; /* Observers geodetic latitude (radians) */
double lon; /* Observers geodetic longitude (radians) */
double ra; /* RA of source (radians, FK5 J2000) */
int result; /* Returned value */
/* Initialise */
result = 1;
/* Check the global error status. */
if ( !astOK ) return result;
/* No conversion is required if the rest frames are equal. */
if( !EqualSor( this, that, status ) ) {
/* Define local macros as shorthand for adding spectral coordinate
conversions to the SpecMap. Each macro simply stores details of
the additional arguments in the "args" array and then calls
astSpecAdd. The macros differ in the number of additional argument
values. */
#define TRANSFORM_2(cvt,arg0,arg1) \
args[ 0 ] = arg0; \
args[ 1 ] = arg1; \
astSpecAdd( specmap, cvt, 2, args );
#define TRANSFORM_3(cvt,arg0,arg1,arg2) \
args[ 0 ] = arg0; \
args[ 1 ] = arg1; \
args[ 2 ] = arg2; \
astSpecAdd( specmap, cvt, 3, args );
#define TRANSFORM_6(cvt,arg0,arg1,arg2,arg3,arg4,arg5) \
args[ 0 ] = arg0; \
args[ 1 ] = arg1; \
args[ 2 ] = arg2; \
args[ 3 ] = arg3; \
args[ 4 ] = arg4; \
args[ 5 ] = arg5; \
astSpecAdd( specmap, cvt, 6, args );
/* A string for use in error messages. */
vmess = "convert between different standards of rest";
/* Get the required values from "this". */
from = astGetStdOfRest( this );
ra = astGetRefRA( this );
dec = astGetRefDec( this );
lon = astGetObsLon( this );
lat = astGetObsLat( this );
alt = astGetObsAlt( this );
epoch = astGetEpoch( this );
/* Verify that the reference RA and DEC can be used (they are needed by all
the conversions used below). */
VerifyAttrs( this, vmess, "RefRA RefDec", "astMatch", status );
/* Convert from the "this" rest frame to heliographic. */
if( from == AST__TPSOR ) {
VerifyAttrs( this, vmess, "ObsLon ObsLat ObsAlt Epoch", "astMatch", status );
TRANSFORM_6( "TPF2HL", lon, lat, alt, epoch, ra, dec )
} else if( from == AST__GESOR ) {
VerifyAttrs( this, vmess, "Epoch", "astMatch", status );
TRANSFORM_3( "GEF2HL", epoch, ra, dec )
} else if( from == AST__BYSOR ) {
VerifyAttrs( this, vmess, "Epoch", "astMatch", status );
TRANSFORM_3( "BYF2HL", epoch, ra, dec )
} else if( from == AST__LKSOR ) {
TRANSFORM_2( "LKF2HL", ra, dec )
} else if( from == AST__LDSOR ) {
TRANSFORM_2( "LDF2HL", ra, dec )
} else if( from == AST__LGSOR ) {
TRANSFORM_2( "LGF2HL", ra, dec )
} else if( from == AST__GLSOR ) {
TRANSFORM_2( "GLF2HL", ra, dec )
} else if( from == AST__SCSOR ) {
TRANSFORM_3( "USF2HL", ConvertSourceVel( this, AST__HLSOR, AST__VREL, status ),
ra, dec )
}
/* Now go from heliocentric to the "to" frame. */
to = astGetStdOfRest( that );
ra = astGetRefRA( that );
dec = astGetRefDec( that );
lon = astGetObsLon( that );
lat = astGetObsLat( that );
alt = astGetObsAlt( that );
epoch = astGetEpoch( that );
VerifyAttrs( that, vmess, "RefRA RefDec", "astMatch", status );
if( to == AST__TPSOR ) {
VerifyAttrs( that, vmess, "ObsLon ObsLat ObsAlt Epoch", "astMatch", status );
TRANSFORM_6( "HLF2TP", lon, lat, alt, epoch, ra, dec )
} else if( to == AST__GESOR ) {
VerifyAttrs( that, vmess, "Epoch", "astMatch", status );
TRANSFORM_3( "HLF2GE", epoch, ra, dec )
} else if( to == AST__BYSOR ) {
VerifyAttrs( that, vmess, "Epoch", "astMatch", status );
TRANSFORM_3( "HLF2BY", epoch, ra, dec )
} else if( to == AST__LKSOR ) {
TRANSFORM_2( "HLF2LK", ra, dec )
} else if( to == AST__LDSOR ) {
TRANSFORM_2( "HLF2LD", ra, dec )
} else if( to == AST__LGSOR ) {
TRANSFORM_2( "HLF2LG", ra, dec )
} else if( to == AST__GLSOR ) {
TRANSFORM_2( "HLF2GL", ra, dec )
} else if( to == AST__SCSOR ) {
TRANSFORM_3( "HLF2US", ConvertSourceVel( that, AST__HLSOR, AST__VREL, status ),
ra, dec )
}
}
/* Return the result. */
return result;
/* Undefine macros local to this function. */
#undef MAX_ARGS
#undef TRANSFORM_2
#undef TRANSFORM_3
#undef TRANSFORM_6
}
static const char *SpecMapUnit( AstSystemType system, const char *method,
const char *class, int *status ){
/*
* Name:
* SpecMapUnit
* Purpose:
* Return the default units for a spectral coordinate system type used
* by the SpecMap class.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *SpecMapUnit( AstSystemType system, const char *method,
* const char *class, int *status )
* Class Membership:
* SpecFrame member function.
* Description:
* This function returns a textual representation of the
* units used by the SpecMap class for the specified spectral
* coordinate system. In general, the SpecMap class uses SI units
* (m/s, Hz, m, etc), but this class (SpecFrame) has default units
* more appropriate to astronomers (km/s, GHz, Angstroms, etc).
* Parameters:
* system
* The spectral coordinate system.
* method
* Pointer to a string holding the name of the calling method.
* This is only for use in constructing error messages.
* class
* Pointer to a string holding the name of the supplied object class.
* This is only for use in constructing error messages.
* status
* Pointer to the inherited status variable.
* Returned Value:
* A string describing the default units. This string follows the
* units syntax described in FITS WCS paper I "Representations of world
* coordinates in FITS" (Greisen & Calabretta).
* Notes:
* - A NULL pointer is returned if this function is invoked with
* the global error status set or if it should fail for any reason.
*/
/* Local Variables: */
const char *result; /* Value to return */
/* Initialize */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get an identifier for the default units. */
if( system == AST__FREQ ) {
result = "Hz";
} else if( system == AST__ENERGY ) {
result = "J";
} else if( system == AST__WAVENUM ) {
result = "1/m";
} else if( system == AST__WAVELEN ) {
result = "m";
} else if( system == AST__AIRWAVE ) {
result = "m";
} else if( system == AST__VRADIO ) {
result = "m/s";
} else if( system == AST__VOPTICAL ) {
result = "m/s";
} else if( system == AST__REDSHIFT ) {
result = "";
} else if( system == AST__BETA ) {
result = "";
} else if( system == AST__VREL ) {
result = "m/s";
/* Report an error if the coordinate system was not recognised. */
} else {
astError( AST__SCSIN, "%s(%s): Corrupt %s contains illegal System "
"identification code (%d).", status, method, class, class,
(int) system );
}
/* Return the result. */
return result;
}
static AstStdOfRestType StdOfRestCode( const char *sor, int *status ) {
/*
* Name:
* StdOfRestCode
* Purpose:
* Convert a string into a standard of rest type code.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* AstStdOfRestType StdOfRestCode( const char *sor )
* Class Membership:
* SpecFrame member function.
* Description:
* This function converts a string used for the external description of
* a standard of rest into a SpecFrame standard of rest type code
* (StdOfRest attribute value). It is the inverse of the
* StdOfRestString function.
* Parameters:
* sor
* Pointer to a constant null-terminated string containing the
* external description of the standard of rest.
* Returned Value:
* The StdOfRest type code.
* Notes:
* - A value of AST__BADSOR is returned if the standard of rest
* description was not recognised. This does not produce an error.
* - A value of AST__BADSOR is also returned if this function
* is invoked with the global error status set or if it should fail
* for any reason.
*/
/* Local Variables: */
AstStdOfRestType result; /* Result value to return */
/* Initialise. */
result = AST__BADSOR;
/* Check the global error status. */
if ( !astOK ) return result;
/* Match the "sor" string against each possibility and assign the
result. */
if ( astChrMatch( "TOPO", sor ) || astChrMatch( "TOPOCENT", sor ) || astChrMatch( "TOPOCENTRIC", sor ) ) {
result = AST__TPSOR;
} else if ( astChrMatch( "GEO", sor ) || astChrMatch( "GEOCENTR", sor ) || astChrMatch( "GEOCENTRIC", sor ) ) {
result = AST__GESOR;
} else if ( astChrMatch( "BARY", sor ) || astChrMatch( "BARYCENT", sor ) || astChrMatch( "BARYCENTRIC", sor ) ) {
result = AST__BYSOR;
} else if ( astChrMatch( "HELIO", sor ) || astChrMatch( "HELIOCEN", sor ) || astChrMatch( "HELIOCENTRIC", sor ) ) {
result = AST__HLSOR;
} else if ( astChrMatch( "LSRK", sor ) || astChrMatch( "LSR", sor ) ) {
result = AST__LKSOR;
} else if ( astChrMatch( "LSRD", sor ) ) {
result = AST__LDSOR;
} else if ( astChrMatch( "GAL", sor ) || astChrMatch( "GALACTOC", sor ) || astChrMatch( "GALACTIC", sor ) ) {
result = AST__GLSOR;
} else if ( astChrMatch( "LG", sor ) || astChrMatch( "LOCALGRP", sor ) ||
astChrMatch( "LOCAL_GROUP", sor ) || astChrMatch( "LOCAL-GROUP", sor ) ) {
result = AST__LGSOR;
} else if ( astChrMatch( "SOURCE", sor ) || astChrMatch( "SRC", sor ) ) {
result = AST__SCSOR;
}
/* Return the result. */
return result;
}
static const char *StdOfRestString( AstStdOfRestType sor, int *status ) {
/*
* Name:
* StdOfRestString
* Purpose:
* Convert a standard of rest type code into a string.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *StdOfRestString( AstStdOfRestType sor, int *status )
* Class Membership:
* SpecFrame member function.
* Description:
* This function converts a SpecFrame standard of rest type code
* (StdOfRest attribute value) into a string suitable for use as an
* external representation of the standard of rest type.
* Parameters:
* sor
* The standard of rest type code.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to a constant null-terminated string containing the
* textual equivalent of the type code supplied.
* Notes:
* - A NULL pointer value is returned if the standard of rest
* code was not recognised. This does not produce an error.
* - A NULL pointer value is also returned if this function is
* invoked with the global error status set or if it should fail
* for any reason.
*/
/* Local Variables: */
const char *result; /* Pointer value to return */
/* Initialise. */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Match the "sor" value against each possibility and convert to a
string pointer. (Where possible, return the same string as would be
used in the FITS WCS representation of the standard of rest). */
switch ( sor ) {
case AST__TPSOR:
result = "Topocentric";
break;
case AST__GESOR:
result = "Geocentric";
break;
case AST__BYSOR:
result = "Barycentric";
break;
case AST__HLSOR:
result = "Heliocentric";
break;
case AST__LDSOR:
result = "LSRD";
break;
case AST__LKSOR:
result = "LSRK";
break;
case AST__LGSOR:
result = "Local_group";
break;
case AST__GLSOR:
result = "Galactic";
break;
case AST__SCSOR:
result = "Source";
break;
}
/* Return the result pointer. */
return result;
}
static int SubFrame( AstFrame *target_frame, AstFrame *template,
int result_naxes, const int *target_axes,
const int *template_axes, AstMapping **map,
AstFrame **result, int *status ) {
/*
* Name:
* SubFrame
* Purpose:
* Select axes from a SpecFrame and convert to the new coordinate
* system.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int SubFrame( AstFrame *target, AstFrame *template,
* int result_naxes, const int *target_axes,
* const int *template_axes, AstMapping **map,
* AstFrame **result, int *status )
* Class Membership:
* SpecFrame member function (over-rides the protected astSubFrame
* method inherited from the Frame class).
* Description:
* This function selects a requested sub-set (or super-set) of the axes
* from a "target" SpecFrame and creates a new Frame with copies of
* the selected axes assembled in the requested order. It then
* optionally overlays the attributes of a "template" Frame on to the
* result. It returns both the resulting Frame and a Mapping that
* describes how to convert between the coordinate systems described by
* the target and result Frames. If necessary, this Mapping takes
* account of any differences in the Frames' attributes due to the
* influence of the template.
* Parameters:
* target
* Pointer to the target SpecFrame, from which axes are to be
* selected.
* template
* Pointer to the template Frame, from which new attributes for the
* result Frame are to be obtained. Optionally, this may be NULL, in
* which case no overlaying of template attributes will be performed.
* result_naxes
* Number of axes to be selected from the target Frame. This number may
* be greater than or less than the number of axes in this Frame (or
* equal).
* target_axes
* Pointer to an array of int with result_naxes elements, giving a list
* of the (zero-based) axis indices of the axes to be selected from the
* target SpecFrame. The order in which these are given determines
* the order in which the axes appear in the result Frame. If any of the
* values in this array is set to -1, the corresponding result axis will
* not be derived from the target Frame, but will be assigned default
* attributes instead.
* template_axes
* Pointer to an array of int with result_naxes elements. This should
* contain a list of the template axes (given as zero-based axis indices)
* with which the axes of the result Frame are to be associated. This
* array determines which axes are used when overlaying axis-dependent
* attributes of the template on to the result. If any element of this
* array is set to -1, the corresponding result axis will not receive any
* template attributes.
*
* If the template argument is given as NULL, this array is not used and
* a NULL pointer may also be supplied here.
* map
* Address of a location to receive a pointer to the returned Mapping.
* The forward transformation of this Mapping will describe how to
* convert coordinates from the coordinate system described by the target
* SpecFrame to that described by the result Frame. The inverse
* transformation will convert in the opposite direction.
* result
* Address of a location to receive a pointer to the result Frame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* A non-zero value is returned if coordinate conversion is possible
* between the target and the result Frame. Otherwise zero is returned and
* *map and *result are returned as NULL (but this will not in itself
* result in an error condition). In general, coordinate conversion should
* always be possible if no template Frame is supplied but may not always
* be possible otherwise.
* Notes:
* - A value of zero will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
* Implementation Notes:
* - This implementation addresses the selection of axes from a
* SpecFrame object. This results in another object of the same class
* only if the single SpecFrame axis is selected exactly once.
* Otherwise, the result is a Frame class object which inherits the
* SpecFrame's axis information (if appropriate) but none of the other
* properties of a SpecFrame.
* - In the event that a SpecFrame results, the returned Mapping will
* take proper account of the relationship between the target and result
* coordinate systems.
* - In the event that a Frame class object results, the returned Mapping
* will only represent a selection/permutation of axes.
* Implementation Deficiencies:
* - Any axis selection is currently permitted. Probably this should be
* restricted so that each axis can only be selected once. The
* astValidateAxisSelection method will do this but currently there are bugs
* in the CmpFrame class that cause axis selections which will not pass this
* test. Install the validation when these are fixed.
*/
/* Local Variables: */
AstSpecFrame *target; /* Pointer to the SpecFrame structure */
AstSpecFrame *temp; /* Pointer to copy of target SpecFrame */
AstSpecFrame *align_frm; /* Frame in which to align the SpecFrames */
int match; /* Coordinate conversion is possible? */
int report; /* Report errors if SpecFrames cannot be aligned? */
/* Initialise the returned values. */
*map = NULL;
*result = NULL;
match = 0;
/* Check the global error status. */
if ( !astOK ) return match;
/* Obtain a pointer to the target SpecFrame structure. */
target = (AstSpecFrame *) target_frame;
/* Result is a SpecFrame. */
/* -------------------------- */
/* Check if the result Frame is to have one axis obtained by selecting
the single target SpecFrame axis. If so, the result will also be
a SpecFrame. */
if ( ( result_naxes == 1 ) && ( target_axes[ 0 ] == 0 ) ) {
/* Form the result from a copy of the target. */
*result = astCopy( target );
/* Initialise a flag to indicate that MakeSpecMapping should not report
errors if no Mapping can be created. */
report = 0;
/* If required, overlay the template attributes on to the result SpecFrame.
Also get the system and standard of rest in which to align the two
SpecFrames. These are the values from the template (if there is a
template). */
if ( template ) {
astOverlay( template, template_axes, *result );
if( astIsASpecFrame( template ) ) {
align_frm = astCopy( template );
/* Since we now know that both the template and target are SpecFrames, it
should usually be possible to convert betwen them. If conversion is
*not* possible (fpr instance if no rest frequency is availalbe, etc)
then the user will probably be interested in knowing the reason why
conversion is not possible. Therefore, indicate that MakeSpecMapping
should report errors if no Mapping can be created. */
report = 1;
} else {
align_frm = astCopy( target );
}
/* If no template was supplied, align in the System and StdOfRest of the
target. */
} else {
VerifyAttrs( target, "convert between different spectral systems",
"StdOfRest", "astMatch", status );
align_frm = astCopy( target );
}
/* The MakeSpecMapping function uses the System and StdOfRest attributes to
define the alignment frame. But the AlignSystem and AlignStdOfRest
attributes should be used for this purpose. Therefore, copy the values
of the AlignSystem and AlignStdOfRest attributes to the System and
StdOfRest attribute. */
astSetSystem( align_frm, astGetAlignSystem( align_frm ) );
astSetStdOfRest( align_frm, astGetAlignStdOfRest( align_frm ) );
/* Generate a Mapping that takes account of changes in the sky coordinate
system (equinox, epoch, etc.) between the target SpecFrame and the result
SpecFrame. If this Mapping can be generated, set "match" to indicate that
coordinate conversion is possible. If the template is a specframe,
report errors if a match is not possible. */
match = ( MakeSpecMapping( target, (AstSpecFrame *) *result,
align_frm, report, map, status ) != 0 );
/* Free resources. */
align_frm = astAnnul( align_frm );
/* Result is not a SpecFrame. */
/* ------------------------------ */
/* In this case, we select axes as if the target were from the Frame
class. However, since the resulting data will then be separated
from their enclosing SpecFrame, default attribute values may differ
if the methods for obtaining them were over-ridden by the SpecFrame
class. To overcome this, we ensure that these values are explicitly
set for the result Frame (rather than relying on their defaults). */
} else {
/* Make a temporary copy of the target SpecFrame. We will explicitly
set the attribute values in this copy so as not to modify the original. */
temp = astCopy( target );
/* Define a macro to test if an attribute is set. If not, set it
explicitly to its default value. */
#define SET(attribute) \
if ( !astTest##attribute( temp ) ) { \
astSet##attribute( temp, astGet##attribute( temp ) ); \
}
/* Set attribute values which apply to the Frame as a whole and which
we want to retain, but whose defaults are over-ridden by the
SpecFrame class. */
SET(Domain)
SET(Title)
/* Define a macro to test if an attribute is set for axis zero (the only
axis of a SpecFrame). If not, set it explicitly to its default value. */
#define SET_AXIS(attribute) \
if ( !astTest##attribute( temp, 0 ) ) { \
astSet##attribute( temp, 0, \
astGet##attribute( temp, 0 ) ); \
}
/* Use this macro to set explicit values for all the axis attributes
for which the SpecFrame class over-rides the default value. */
SET_AXIS(Label)
SET_AXIS(Symbol)
SET_AXIS(Unit)
/* Clear attributes which have an extended range of values allowed by
this class. */
astClearSystem( temp );
astClearAlignSystem( temp );
/* Invoke the astSubFrame method inherited from the Frame class to
produce the result Frame by selecting the required set of axes and
overlaying the template Frame's attributes. */
match = (*parent_subframe)( (AstFrame *) temp, template,
result_naxes, target_axes, template_axes,
map, result, status );
/* Delete the temporary copy of the target SpecFrame. */
temp = astDelete( temp );
}
/* If an error occurred or no match was found, annul the returned
objects and reset the returned result. */
if ( !astOK || !match ) {
if( *map ) *map = astAnnul( *map );
if( *result ) *result = astAnnul( *result );
match = 0;
}
/* Return the result. */
return match;
/* Undefine macros local to this function. */
#undef SET
#undef SET_AXIS
}
static AstSystemType SystemCode( AstFrame *this, const char *system, int *status ) {
/*
* Name:
* SystemCode
* Purpose:
* Convert a string into a coordinate system type code.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* AstSystemType SystemCode( AstFrame *this, const char *system, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astSystemCode method
* inherited from the Frame class).
* Description:
* This function converts a string used for the external
* description of a coordinate system into a SpecFrame
* coordinate system type code (System attribute value). It is the
* inverse of the astSystemString function.
* Parameters:
* this
* The Frame.
* system
* Pointer to a constant null-terminated string containing the
* external description of the sky coordinate system.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The System type code.
* Notes:
* - A value of AST__BADSYSTEM is returned if the sky coordinate
* system description was not recognised. This does not produce an
* error.
* - A value of AST__BADSYSTEM is also returned if this function
* is invoked with the global error status set or if it should fail
* for any reason.
*/
/* Local Variables: */
AstSystemType result; /* Result value to return */
/* Initialise. */
result = AST__BADSYSTEM;
/* Check the global error status. */
if ( !astOK ) return result;
/* Match the "system" string against each possibility and assign the
result. */
if ( astChrMatch( "FREQ", system ) ) {
result = AST__FREQ;
} else if ( astChrMatch( "ENER", system ) || astChrMatch( "ENERGY", system ) ) {
result = AST__ENERGY;
} else if ( astChrMatch( "WAVN", system ) || astChrMatch( "WAVENUM", system ) ) {
result = AST__WAVENUM;
} else if ( astChrMatch( "WAVE", system ) || astChrMatch( "WAVELEN", system ) ) {
result = AST__WAVELEN;
} else if ( astChrMatch( "AWAV", system ) || astChrMatch( "AIRWAVE", system ) ) {
result = AST__AIRWAVE;
} else if ( astChrMatch( "VRAD", system ) || astChrMatch( "VRADIO", system ) ) {
result = AST__VRADIO;
} else if ( astChrMatch( "VOPT", system ) || astChrMatch( "VOPTICAL", system ) ) {
result = AST__VOPTICAL;
} else if ( astChrMatch( "ZOPT", system ) || astChrMatch( "REDSHIFT", system ) ) {
result = AST__REDSHIFT;
} else if ( astChrMatch( "BETA", system ) ) {
result = AST__BETA;
} else if ( astChrMatch( "VELO", system ) || astChrMatch( "VREL", system ) ) {
result = AST__VREL;
}
/* Return the result. */
return result;
}
static const char *SystemLabel( AstSystemType system, int *status ) {
/*
* Name:
* SystemLabel
* Purpose:
* Return a label for a coordinate system type code.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *SystemLabel( AstSystemType system, int *status )
* Class Membership:
* SpecFrame member function.
* Description:
* This function converts a SpecFrame coordinate system type code
* (System attribute value) into a descriptive string for human readers.
* Parameters:
* system
* The coordinate system type code.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to a constant null-terminated string containing the
* textual equivalent of the type code supplied.
* Notes:
* - A NULL pointer value is returned if the sky coordinate system
* code was not recognised. This does not produce an error.
* - A NULL pointer value is also returned if this function is
* invoked with the global error status set or if it should fail
* for any reason.
*/
/* Local Variables: */
const char *result; /* Pointer value to return */
/* Initialise. */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Match the "system" value against each possibility and convert to a
string pointer. */
switch ( system ) {
case AST__FREQ:
result = "frequency";
break;
case AST__ENERGY:
result = "energy";
break;
case AST__WAVENUM:
result = "wave-number";
break;
case AST__WAVELEN:
result = "wavelength";
break;
case AST__AIRWAVE:
result = "wavelength in air";
break;
case AST__VRADIO:
result = "radio velocity";
break;
case AST__VOPTICAL:
result = "optical velocity";
break;
case AST__REDSHIFT:
result = "redshift";
break;
case AST__BETA:
result = "beta factor";
break;
case AST__VREL:
result = "apparent radial velocity";
break;
}
/* Return the result pointer. */
return result;
}
static const char *SystemString( AstFrame *this, AstSystemType system, int *status ) {
/*
* Name:
* SystemString
* Purpose:
* Convert a coordinate system type code into a string.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* const char *SystemString( AstFrame *this, AstSystemType system, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astSystemString method
* inherited from the Frame class).
* Description:
* This function converts a SpecFrame coordinate system type code
* (System attribute value) into a string suitable for use as an
* external representation of the coordinate system type.
* Parameters:
* this
* The Frame.
* system
* The coordinate system type code.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to a constant null-terminated string containing the
* textual equivalent of the type code supplied.
* Notes:
* - A NULL pointer value is returned if the sky coordinate system
* code was not recognised. This does not produce an error.
* - A NULL pointer value is also returned if this function is
* invoked with the global error status set or if it should fail
* for any reason.
*/
/* Local Variables: */
const char *result; /* Pointer value to return */
/* Initialise. */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Match the "system" value against each possibility and convert to a
string pointer. (Where possible, return the same string as would be
used in the FITS WCS representation of the coordinate system). */
switch ( system ) {
case AST__FREQ:
result = "FREQ";
break;
case AST__ENERGY:
result = "ENER";
break;
case AST__WAVENUM:
result = "WAVN";
break;
case AST__WAVELEN:
result = "WAVE";
break;
case AST__AIRWAVE:
result = "AWAV";
break;
case AST__VRADIO:
result = "VRAD";
break;
case AST__VOPTICAL:
result = "VOPT";
break;
case AST__REDSHIFT:
result = "ZOPT";
break;
case AST__BETA:
result = "BETA";
break;
case AST__VREL:
result = "VELO";
break;
}
/* Return the result pointer. */
return result;
}
static int TestActiveUnit( AstFrame *this_frame, int *status ) {
/*
* Name:
* TestActiveUnit
* Purpose:
* Test the ActiveUnit flag for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int TestActiveUnit( AstFrame *this_frame, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astTestActiveUnit protected
* method inherited from the Frame class).
* Description:
* This function test the value of the ActiveUnit flag for a SpecFrame,
* which is always "unset".
* Parameters:
* this
* Pointer to the SpecFrame.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The result of the test (0).
*/
return 0;
}
static int TestAttrib( AstObject *this_object, const char *attrib, int *status ) {
/*
* Name:
* TestAttrib
* Purpose:
* Test if a specified attribute value is set for a SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* int TestAttrib( AstObject *this, const char *attrib, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astTestAttrib protected
* method inherited from the Frame class).
* Description:
* This function returns a boolean result (0 or 1) to indicate whether
* a value has been set for one of a SpecFrame's attributes.
* Parameters:
* this
* Pointer to the SpecFrame.
* attrib
* Pointer to a null terminated string specifying the attribute
* name. This should be in lower case with no surrounding white
* space.
* status
* Pointer to the inherited status variable.
* Returned Value:
* One if a value has been set, otherwise zero.
* Notes:
* - This function uses one-based axis numbering so that it is
* suitable for external (public) use.
* - A value of zero will be returned if this function is invoked
* with the global status set, or if it should fail for any reason.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
char *new_attrib; /* Pointer value to new attribute name */
int len; /* Length of attrib string */
int result; /* Result value to return */
/* Initialise. */
result = 0;
/* Check the global error status. */
if ( !astOK ) return result;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_object;
/* Obtain the length of the attrib string. */
len = strlen( attrib );
/* Check the attribute name and test the appropriate attribute. */
/* First look for axis attributes defined by the Frame class. Since a
SpecFrame has only 1 axis, we allow these attributes to be specified
without a trailing "(axis)" string. */
if ( !strcmp( attrib, "direction" ) ||
!strcmp( attrib, "bottom" ) ||
!strcmp( attrib, "top" ) ||
!strcmp( attrib, "format" ) ||
!strcmp( attrib, "label" ) ||
!strcmp( attrib, "symbol" ) ||
!strcmp( attrib, "unit" ) ) {
/* Create a new attribute name from the original by appending the string
"(1)" and then use the parent TestAttrib method. */
new_attrib = astMalloc( len + 4 );
if( new_attrib ) {
memcpy( new_attrib, attrib, len );
memcpy( new_attrib + len, "(1)", 4 );
result = (*parent_testattrib)( this_object, new_attrib, status );
new_attrib = astFree( new_attrib );
}
/* AlignStdOfRest. */
/* --------------- */
} else if ( !strcmp( attrib, "alignstdofrest" ) ) {
result = astTestAlignStdOfRest( this );
/* GeoLat. */
/* ------- */
/* Retained for backward compatibility with older versions of AST in which
SpecFrame had GeoLon/Lat attributes (now ObsLon/Lat are used instead). */
} else if ( !strcmp( attrib, "geolat" ) ) {
result = astTestAttrib( this, "obslat" );
/* GeoLon. */
/* ------- */
} else if ( !strcmp( attrib, "geolon" ) ) {
result = astTestAttrib( this, "obslon" );
/* RefDec. */
/* ------- */
} else if ( !strcmp( attrib, "refdec" ) ) {
result = astTestRefDec( this );
/* RefRA. */
/* ------ */
} else if ( !strcmp( attrib, "refra" ) ) {
result = astTestRefRA( this );
/* RestFreq. */
/* --------- */
} else if ( !strcmp( attrib, "restfreq" ) ) {
result = astTestRestFreq( this );
/* SourceVel. */
/* ---------- */
} else if ( !strcmp( attrib, "sourcevel" ) ) {
result = astTestSourceVel( this );
/* SourceVRF */
/* --------- */
} else if ( !strcmp( attrib, "sourcevrf" ) ) {
result = astTestSourceVRF( this );
/* SourceSys */
/* --------- */
} else if ( !strcmp( attrib, "sourcesys" ) ) {
result = astTestSourceSys( this );
/* StdOfRest. */
/* ---------- */
} else if ( !strcmp( attrib, "stdofrest" ) ) {
result = astTestStdOfRest( this );
/* SpecOrigin. */
/* --------- */
} else if ( !strcmp( attrib, "specorigin" ) ) {
result = astTestSpecOrigin( this );
/* AlignSpecOffset */
/* --------------- */
} else if ( !strcmp( attrib, "alignspecoffset" ) ) {
result = astTestAlignSpecOffset( this );
/* If the attribute is not recognised, pass it on to the parent method
for further interpretation. */
} else {
result = (*parent_testattrib)( this_object, attrib, status );
}
/* Return the result, */
return result;
}
static double ToUnits( AstSpecFrame *this, const char *oldunit, double oldval,
const char *method, int *status ){
/*
*
* Name:
* ToUnits
* Purpose:
* Convert a supplied spectral value to the default units of the supplied
* SpecFrame.
* Type:
* Private function.
* Synopsis:
* #include "timeframe.h"
* double ToUnits( AstSpecFrame *this, const char *oldunit, double oldval,
* const char *method, int *status )
* Class Membership:
* SpecFrame member function
* Description:
* This function converts the supplied value from the supplied units to
* the default units associated with the supplied SpecFrame's System.
* Parameters:
* this
* Pointer to the SpecFrame.
* oldunit
* The units in which "oldval" is supplied.
* oldval
* The value to be converted.
* method
* Pointer to a string holding the name of the method to be
* included in any error messages.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The converted value.
*/
/* Local Variables: */
AstMapping *map;
const char *defunit;
double result;
/* Initialise. */
result = AST__BAD;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get default units associated with the System attribute of the supplied
SpecFrame, and find a Mapping from the old units to the default. */
defunit = DefUnit( astGetSystem( this ), method, "SpecFrame", status );
map = astUnitMapper( oldunit, defunit, NULL, NULL );
if( map ) {
/* Use the Mapping to convert the supplied value. */
astTran1( map, 1, &oldval, 1, &result );
/* Free resources. */
map = astAnnul( map );
/* Report an error if no conversion is possible. */
} else if( astOK ){
astError( AST__BADUN, "%s(%s): Cannot convert the supplied attribute "
"value from units of %s to %s.", status, method, astGetClass( this ),
oldunit, defunit );
}
/* Return the result */
return result;
}
static int ValidateSystem( AstFrame *this, AstSystemType system, const char *method, int *status ) {
/*
*
* Name:
* ValidateSystem
* Purpose:
* Validate a value for a Frame's System attribute.
* Type:
* Protected virtual function.
* Synopsis:
* #include "specframe.h"
* int ValidateSystem( AstFrame *this, AstSystemType system,
* const char *method, int *status )
* Class Membership:
* SpecFrame member function (over-rides the astValidateSystem method
* inherited from the Frame class).
* Description:
* This function checks the validity of the supplied system value.
* If the value is valid, it is returned unchanged. Otherwise, an
* error is reported and a value of AST__BADSYSTEM is returned.
* Parameters:
* this
* Pointer to the Frame.
* system
* The system value to be checked.
* method
* Pointer to a constant null-terminated character string
* containing the name of the method that invoked this function
* to validate an axis index. This method name is used solely
* for constructing error messages.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The validated system value.
* Notes:
* - A value of AST__BADSYSTEM will be returned if this function is invoked
* with the global error status set, or if it should fail for any
* reason.
*/
/* Local Variables: */
AstSystemType result; /* Validated system value */
/* Initialise. */
result = AST__BADSYSTEM;
/* Check the global error status. */
if ( !astOK ) return result;
/* If the value is out of bounds, report an error. */
if ( system < FIRST_SYSTEM || system > LAST_SYSTEM ) {
astError( AST__AXIIN, "%s(%s): Bad value (%d) given for the System "
"or AlignSystem attribute of a %s.", status, method,
astGetClass( this ), (int) system, astGetClass( this ) );
/* Otherwise, return the supplied value. */
} else {
result = system;
}
/* Return the result. */
return result;
}
static void VerifyAttrs( AstSpecFrame *this, const char *purp,
const char *attrs, const char *method, int *status ) {
/*
* Name:
* VerifyAttrs
* Purpose:
* Verify that usable attribute values are available.
* Type:
* Private function.
* Synopsis:
* #include "specframe.h"
* void VerifyAttrs( AstSpecFrame *this, const char *purp,
* const char *attrs, const char *method, int *status )
* Class Membership:
* SpecFrame member function
* Description:
* This function tests each attribute listed in "attrs". It returns
* without action if 1) an explicit value has been set for each attribute
* or 2) the UseDefs attribute of the supplied SpecFrame is non-zero.
*
* If UseDefs is zero (indicating that default values should not be
* used for attributes), and any of the named attributes does not have
* an explicitly set value, then an error is reported.
* Parameters:
* this
* Pointer to the SpecFrame.
* purp
* Pointer to a text string containing a message which will be
* included in any error report. This shouldindicate the purpose
* for which the attribute value is required.
* attrs
* A string holding a space separated list of attribute names.
* method
* A string holding the name of the calling method for use in error
* messages.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
const char *a;
const char *desc;
const char *p;
int len;
int set;
int state;
/* Check inherited status */
if( !astOK ) return;
/* If the SpecFrame has a non-zero value for its UseDefs attribute, then
all attributes are assumed to have usable values, since the defaults
will be used if no explicit value has been set. So we only need to do
any checks if UseDefs is zero. */
if( !astGetUseDefs( this ) ) {
/* Stop compiler warnings about uninitialised variables */
a = NULL;
desc = NULL;
len = 0;
set = 0;
/* Loop round the "attrs" string identifying the start and length of each
non-blank word in the string. */
state = 0;
p = attrs;
while( 1 ) {
if( state == 0 ) {
if( !isspace( *p ) ) {
a = p;
len = 1;
state = 1;
}
} else {
if( isspace( *p ) || !*p ) {
/* The end of a word has just been reached. Compare it to each known
attribute value. Get a flag indicating if the attribute has a set
value, and a string describing the attribute.*/
if( len > 0 ) {
if( !strncmp( "ObsLat", a, len ) ) {
set = astTestObsLat( this );
desc = "observer's latitude";
} else if( !strncmp( "ObsLon", a, len ) ) {
set = astTestObsLon( this );
desc = "observer's longitude";
} else if( !strncmp( "ObsAlt", a, len ) ) {
set = astTestObsAlt( this );
desc = "observer's altitude";
} else if( !strncmp( "RefRA", a, len ) ) {
set = astTestRefRA( this );
desc = "source RA";
} else if( !strncmp( "RefDec", a, len ) ) {
set = astTestRefDec( this );
desc = "source Dec";
} else if( !strncmp( "RestFreq", a, len ) ) {
set = astTestRestFreq( this );
desc = "rest frequency";
} else if( !strncmp( "SourceVel", a, len ) ) {
set = astTestSourceVel( this );
desc = "source velocity";
} else if( !strncmp( "StdOfRest", a, len ) ) {
set = astTestStdOfRest( this );
desc = "spectral standard of rest";
} else if( !strncmp( "Epoch", a, len ) ) {
set = astTestEpoch( this );
desc = "epoch of observation";
} else {
astError( AST__INTER, "VerifyAttrs(SpecFrame): "
"Unknown attribute name \"%.*s\" supplied (AST "
"internal programming error).", status, len, a );
}
/* If the attribute does not have a set value, report an error. */
if( !set && astOK ) {
astError( AST__NOVAL, "%s(%s): Cannot %s.", status, method,
astGetClass( this ), purp );
astError( AST__NOVAL, "No value has been set for "
"the AST \"%.*s\" attribute (%s).", status, len, a,
desc );
}
/* Continue the word search algorithm. */
}
len = 0;
state = 0;
} else {
len++;
}
}
if( !*(p++) ) break;
}
}
}
/* Functions which access class attributes. */
/* ---------------------------------------- */
/*
*att++
* Name:
* AlignSpecOffset
* Purpose:
* Align SpecFrames using the offset coordinate system?
* Type:
* Public attribute.
* Synopsis:
* Integer (boolean).
* Description:
* This attribute is a boolean value which controls how a SpecFrame
* behaves when it is used (by
c astFindFrame or astConvert) as a template to match another (target)
f AST_FINDFRAME or AST_CONVERT) as a template to match another (target)
* SpecFrame. It determines whether alignment occurs between the offset
* values defined by the current value of the SpecOffset attribute, or
* between the corresponding absolute spectral values.
*
* The default value of zero results in the two SpecFrames being aligned
* so that a given absolute spectral value in one is mapped to the same
* absolute value in the other. A non-zero value results in the SpecFrames
* being aligned so that a given offset value in one is mapped to the same
* offset value in the other.
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
astMAKE_CLEAR(SpecFrame,AlignSpecOffset,alignspecoffset,-INT_MAX)
astMAKE_GET(SpecFrame,AlignSpecOffset,int,0,( ( this->alignspecoffset != -INT_MAX ) ?
this->alignspecoffset : 0 ))
astMAKE_SET(SpecFrame,AlignSpecOffset,int,alignspecoffset,( value != 0 ))
astMAKE_TEST(SpecFrame,AlignSpecOffset,( this->alignspecoffset != -INT_MAX ))
/*
*att++
* Name:
* AlignStdOfRest
* Purpose:
* Standard of rest to use when aligning SpecFrames.
* Type:
* Public attribute.
* Synopsis:
* String.
* Description:
* This attribute controls how a SpecFrame behaves when it is used (by
c astFindFrame or astConvert) as a template to match another (target)
f AST_FINDFRAME or AST_CONVERT) as a template to match another (target)
* SpecFrame. It identifies the standard of rest in which alignment is
* to occur. See the StdOfRest attribute for a desription of the values
* which may be assigned to this attribute. The default AlignStdOfRest
* value is "Helio" (heliographic).
*
c When astFindFrame or astConvert is used on two SpecFrames (potentially
f When AST_FindFrame or AST_CONVERT is used on two SpecFrames (potentially
* describing different spectral coordinate systems), it returns a Mapping
* which can be used to transform a position in one SpecFrame into the
* corresponding position in the other. The Mapping is made up of the
* following steps in the indicated order:
*
* - Map values from the system used by the target (wavelength,
* apparent radial velocity, etc) to the system specified by the
* AlignSystem attribute, using the target's rest frequency if necessary.
*
* - Map these values from the target's standard of rest to the standard of
* rest specified by the AlignStdOfRest attribute, using the Epoch, ObsLat,
* ObsLon, ObsAlt, RefDec and RefRA attributes of the target to define the
* two standards of rest.
*
* - Map these values from the standard of rest specified by the
* AlignStdOfRest attribute, to the template's standard of rest, using the
* Epoch, ObsLat, ObsLon, ObsAlt, RefDec and RefRA attributes of the
* template to define the two standards of rest.
*
* - Map these values from the system specified by the AlignSystem
* attribute, to the system used by the template, using the template's
* rest frequency if necessary.
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
/* The AlignStdOfRest value has a value of AST__BADSOR when not set yielding
a default of AST__HLSOR. */
astMAKE_TEST(SpecFrame,AlignStdOfRest,( this->alignstdofrest != AST__BADSOR ))
astMAKE_CLEAR(SpecFrame,AlignStdOfRest,alignstdofrest,AST__BADSOR)
astMAKE_GET(SpecFrame,AlignStdOfRest,AstStdOfRestType,AST__BADSOR,(
( this->alignstdofrest == AST__BADSOR ) ? AST__HLSOR : this->alignstdofrest ) )
/* Validate the AlignStdOfRest value being set and report an error if necessary. */
astMAKE_SET(SpecFrame,AlignStdOfRest,AstStdOfRestType,alignstdofrest,(
( ( value >= FIRST_SOR ) && ( value <= LAST_SOR ) ) ?
value :
( astError( AST__ATTIN, "%s(%s): Bad value (%d) "
"given for AlignStdOfRest attribute.", status,
"astSetAlignStdOfRest", astGetClass( this ), (int) value ),
/* Leave the value unchanged on error. */
this->alignstdofrest ) ) )
/*
*att++
* Name:
* RefDec
* Purpose:
* The declination of the reference point
* Type:
* Public attribute.
* Synopsis:
* String.
* Description:
* This attribute specifies the FK5 J2000.0 declination of a reference
* point on the sky. See the description of attribute RefRA for details.
* The default RefDec is "0:0:0".
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
/* The reference declination (FK5 J2000, radians). Clear the RefDec value by
setting it to AST__BAD, which results in a default value of zero. Any
value is acceptable. */
astMAKE_CLEAR(SpecFrame,RefDec,refdec,AST__BAD)
astMAKE_GET(SpecFrame,RefDec,double,0.0,((this->refdec!=AST__BAD)?this->refdec:0.0))
astMAKE_SET(SpecFrame,RefDec,double,refdec,value)
astMAKE_TEST(SpecFrame,RefDec,( this->refdec != AST__BAD ))
/*
*att++
* Name:
* RefRA
* Purpose:
* The right ascension of the reference point
* Type:
* Public attribute.
* Synopsis:
* String.
* Description:
* This attribute, together with the RefDec attribute, specifies the FK5
* J2000.0 coordinates of a reference point on the sky. For 1-dimensional
* spectra, this should normally be the position of the source. For
* spectral data with spatial coverage (spectral cubes, etc), this should
* be close to centre of the spatial coverage. It is used to define the
* correction for Doppler shift to be applied when using the
c astFindFrame or astConvert
f AST_FINDFRAME or AST_CONVERT
* method to convert between different standards of rest.
*
* The SpecFrame class assumes this velocity correction is spatially
* invariant. If a single SpecFrame is used (for instance, as a
* component of a CmpFrame) to describe spectral values at different
* points on the sky, then it is assumes that the doppler shift at any
* spatial position is the same as at the reference position. The
* maximum velocity error introduced by this assumption is of the order
* of V*SIN(FOV), where FOV is the angular field of view, and V is the
* relative velocity of the two standards of rest. As an example, when
* correcting from the observers rest frame (i.e. the topocentric rest
* frame) to the kinematic local standard of rest the maximum value of V
* is about 20 km/s, so for 5 arc-minute field of view the maximum velocity
* error introduced by the correction will be about 0.03 km/s. As another
* example, the maximum error when correcting from the observers rest frame
* to the local group is about 5 km/s over a 1 degree field of view.
*
* The RefRA and RefDec attributes are stored internally in radians, but
* are converted to and from a string for access. The format "hh:mm:ss.ss"
* is used for RefRA, and "dd:mm:ss.s" is used for RefDec. The methods
c astSetRefPos and astGetRefPos may be used to access the values of
f AST_SETREFPOS and AST_GETREFPOS may be used to access the value of
* these attributes directly as unformatted values in radians.
*
* The default for RefRA is "0:0:0".
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
/* The reference right ascension (FK5 J2000, radians). Clear the RefRA value
by setting it to AST__BAD, which gives a default value of 0.0. Any
value is acceptable. */
astMAKE_CLEAR(SpecFrame,RefRA,refra,AST__BAD)
astMAKE_GET(SpecFrame,RefRA,double,0.0,((this->refra!=AST__BAD)?this->refra:0.0))
astMAKE_SET(SpecFrame,RefRA,double,refra,value)
astMAKE_TEST(SpecFrame,RefRA,( this->refra != AST__BAD ))
/*
*att++
* Name:
* RestFreq
* Purpose:
* The rest frequency.
* Type:
* Public attribute.
* Synopsis:
* Floating point.
* Description:
* This attribute specifies the frequency corresponding to zero
* velocity. It is used when converting between between velocity-based
* coordinate systems and and other coordinate systems (such as frequency,
* wavelength, energy, etc). The default value is 1.0E5 GHz.
*
* When setting a new value for this attribute, the new value can be
* supplied either directly as a frequency, or indirectly as a wavelength
* or energy, in which case the supplied value is converted to a frequency
* before being stored. The nature of the supplied value is indicated by
* appending text to the end of the numerical value indicating the units in
* which the value is supplied. If the units are not specified, then the
* supplied value is assumed to be a frequency in units of GHz. If the
* supplied unit is a unit of frequency, the supplied value is assumed to
* be a frequency in the given units. If the supplied unit is a unit of
* length, the supplied value is assumed to be a (vacuum) wavelength. If
* the supplied unit is a unit of energy, the supplied value is assumed to
* be an energy. For instance, the following strings all result in
* a rest frequency of around 1.4E14 Hz being used: "1.4E5", "1.4E14 Hz",
* "1.4E14 s**-1", "1.4E5 GHz", "2.14E-6 m", "21400 Angstrom", "9.28E-20 J",
* "9.28E-13 erg", "0.58 eV", etc.
*
* When getting the value of this attribute, the returned value is
* always a frequency in units of GHz.
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
/* The rest frequency (Hz). Clear the RestFreq value by setting it to AST__BAD,
which gives 1.0E14 as the default value. Any value is acceptable. */
astMAKE_CLEAR(SpecFrame,RestFreq,restfreq,AST__BAD)
astMAKE_GET(SpecFrame,RestFreq,double,1.0E14,((this->restfreq!=AST__BAD)?this->restfreq:1.0E14))
astMAKE_SET(SpecFrame,RestFreq,double,restfreq,value)
astMAKE_TEST(SpecFrame,RestFreq,( this->restfreq != AST__BAD ))
/*
*att++
* Name:
* SourceVel
* Purpose:
* The source velocity.
* Type:
* Public attribute.
* Synopsis:
* Floating point.
* Description:
* This attribute (together with SourceSys, SourceVRF, RefRA and RefDec)
* defines the "Source" standard of rest (see attribute StdOfRest). This is
* a rest frame which is moving towards the position given by RefRA and
* RefDec at a velocity given by SourceVel. A positive value means
* the source is moving away from the observer. When a new value is
* assigned to this attribute, the supplied value is assumed to refer
* to the spectral system specified by the SourceSys attribute. For
* instance, the SourceVel value may be supplied as a radio velocity, a
* redshift, a beta factor, etc. Similarly, when the current value of
* the SourceVel attribute is obtained, the returned value will refer
* to the spectral system specified by the SourceSys value. If the
* SourceSys value is changed, any value previously stored for the SourceVel
* attribute will be changed automatically from the old spectral system
* to the new spectral system.
*
* When setting a value for SourceVel, the value should be supplied in the
* rest frame specified by the SourceVRF attribute. Likewise, when getting
* the value of SourceVel, it will be returned in the rest frame specified
* by the SourceVRF attribute.
*
* The default SourceVel value is zero.
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
* Notes:
* - It is important to set an appropriate value for SourceVRF and
* SourceSys before setting a value for SourceVel. If a new value is later
* set for SourceVRF or SourceSys, the value stored for SourceVel will
* simultaneously be changed to the new standard of rest or spectral
* system.
*att--
*/
/* The source velocity (velocities are stored internally in m/s). Clear it
by setting it to AST__BAD, which returns a default value of zero. Any
value is acceptable. */
astMAKE_CLEAR(SpecFrame,SourceVel,sourcevel,AST__BAD)
astMAKE_SET(SpecFrame,SourceVel,double,sourcevel,value)
astMAKE_TEST(SpecFrame,SourceVel,( this->sourcevel != AST__BAD ))
astMAKE_GET(SpecFrame,SourceVel,double,0.0,((this->sourcevel!=AST__BAD)?this->sourcevel:0.0))
/*
*att++
* Name:
* SourceVRF
* Purpose:
* Rest frame in which the source velocity is stored.
* Type:
* Public attribute.
* Synopsis:
* String.
* Description:
* This attribute identifies the rest frame in which the source
* velocity or redshift is stored (the source velocity or redshift is
* accessed using attribute SourceVel). When setting a new value for the
* SourceVel attribute, the source velocity or redshift should be supplied
* in the rest frame indicated by this attribute. Likewise, when getting
* the value of the SourceVel attribute, the velocity or redshift will be
* returned in this rest frame.
*
* If the value of SourceVRF is changed, the value stored for SourceVel
* will be converted from the old to the new rest frame.
*
* The values which can be supplied are the same as for the StdOfRest
* attribute (except that SourceVRF cannot be set to "Source"). The
* default value is "Helio".
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
/* The SourceVRF value has a value of AST__BADSOR when not set yielding
a default of AST__HLSOR. */
astMAKE_TEST(SpecFrame,SourceVRF,( this->sourcevrf != AST__BADSOR ))
astMAKE_GET(SpecFrame,SourceVRF,AstStdOfRestType,AST__BADSOR,(
( this->sourcevrf == AST__BADSOR ) ? AST__HLSOR : this->sourcevrf ) )
/* When clearing SourceVRF, convert the SourceVel value to heliocentric
(but only if set)*/
astMAKE_CLEAR(SpecFrame,SourceVRF,sourcevrf,((astTestSourceVel( this )?
(void)(astSetSourceVel( this, ConvertSourceVel( this, AST__HLSOR,
astGetSourceSys( this ), status ) ),NULL):
NULL),AST__BADSOR))
/* Validate the SourceVRF value being set and report an error if necessary.
If OK, convert the stored SourceVel value into the new rest frame (but
only if set)*/
astMAKE_SET(SpecFrame,SourceVRF,AstStdOfRestType,sourcevrf,(
( ( value >= FIRST_SOR ) && ( value <= LAST_SOR ) && value != AST__SCSOR ) ?
(astTestSourceVel( this )?
(void)(astSetSourceVel( this,ConvertSourceVel(this,value,astGetSourceSys( this ), status )),NULL):
NULL), value:( astError( AST__ATTIN, "%s(%s): Bad value (%d) "
"given for SourceVRF attribute.", status,
"astSetSourceVRF", astGetClass( this ), (int) value ),
/* Leave the value unchanged on error. */
this->sourcevrf ) ) )
/*
*att++
* Name:
* SourceSys
* Purpose:
* Spectral system in which the source velocity is stored.
* Type:
* Public attribute.
* Synopsis:
* String.
* Description:
* This attribute identifies the spectral system in which the
* SourceVel attribute value (the source velocity) is supplied and
* returned. It can be one of the following:
*
* - "VRAD" or "VRADIO": Radio velocity (km/s)
* - "VOPT" or "VOPTICAL": Optical velocity (km/s)
* - "ZOPT" or "REDSHIFT": Redshift (dimensionless)
* - "BETA": Beta factor (dimensionless)
* - "VELO" or "VREL": Apparent radial ("relativistic") velocity (km/s)
*
* When setting a new value for the SourceVel attribute, the source
* velocity should be supplied in the spectral system indicated
* by this attribute. Likewise, when getting the value of the SourceVel
* attribute, the velocity will be returned in this spectral system.
*
* If the value of SourceSys is changed, the value stored for SourceVel
* will be converted from the old to the new spectral systems.
*
* The default value is "VELO" (apparent radial velocity).
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
/* The SourceSys value has a value of AST__BADSYS when not set yielding
a default of AST__VREL. */
astMAKE_TEST(SpecFrame,SourceSys,( this->sourcesys != AST__BADSYSTEM ))
astMAKE_GET(SpecFrame,SourceSys,AstSystemType,AST__BADSYSTEM,(
( this->sourcesys == AST__BADSYSTEM ) ? AST__VREL : this->sourcesys ) )
/* When clearing SourceSys, convert the SourceVel value to relativistic
velocity (but only if set) */
astMAKE_CLEAR(SpecFrame,SourceSys,sourcesys,((astTestSourceVel( this )?
(void)(astSetSourceVel( this, ConvertSourceVel( this, astGetSourceVRF( this ),
AST__VREL, status ) ),NULL):NULL),AST__BADSYSTEM))
/* Validate the SourceSys value being set and report an error if necessary.
If OK, convert the stored SourceVel value into the new rest frame (but
only if set)*/
astMAKE_SET(SpecFrame,SourceSys,AstSystemType,sourcesys,(
( ( value == AST__VREL ) || ( value == AST__BETA ) ||
( value == AST__VRADIO ) || ( value == AST__REDSHIFT ) ||
( value == AST__VOPTICAL ) ) ?
(astTestSourceVel( this )?
(void)(astSetSourceVel( this, ConvertSourceVel( this, astGetSourceVRF( this ),
value, status )),NULL):NULL),
value:
( astError( AST__ATTIN, "%s(%s): Bad value (%d) "
"given for SourceSys attribute.", status,
"astSetSourceSys", astGetClass( this ), (int) value ),
/* Leave the value unchanged on error. */
this->sourcesys ) ) )
/*
*att++
* Name:
* StdOfRest
* Purpose:
* Standard of rest.
* Type:
* Public attribute.
* Synopsis:
* String.
* Description:
* This attribute identifies the standard of rest to which the spectral
* axis values of a SpecFrame refer, and may take any of the values
* listed in the "Standards of Rest" section (below).
*
* The default StdOfRest value is "Helio".
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
* Standards of Rest:
* The SpecFrame class supports the following StdOfRest values (all are
* case-insensitive):
*
* - "Topocentric", "Topocent" or "Topo": The observers rest-frame (assumed
* to be on the surface of the earth). Spectra recorded in this standard of
* rest suffer a Doppler shift which varies over the course of a day
* because of the rotation of the observer around the axis of the earth.
* This standard of rest must be qualified using the ObsLat, ObsLon,
* ObsAlt, Epoch, RefRA and RefDec attributes.
*
* - "Geocentric", "Geocentr" or "Geo": The rest-frame of the earth centre.
* Spectra recorded in this standard of rest suffer a Doppler shift which
* varies over the course of a year because of the rotation of the earth
* around the Sun. This standard of rest must be qualified using the Epoch,
* RefRA and RefDec attributes.
*
* - "Barycentric", "Barycent" or "Bary": The rest-frame of the solar-system
* barycentre. Spectra recorded in this standard of rest suffer a Doppler
* shift which depends both on the velocity of the Sun through the Local
* Standard of Rest, and on the movement of the planets through the solar
* system. This standard of rest must be qualified using the Epoch, RefRA
* and RefDec attributes.
*
* - "Heliocentric", "Heliocen" or "Helio": The rest-frame of the Sun.
* Spectra recorded in this standard of rest suffer a Doppler shift which
* depends on the velocity of the Sun through the Local Standard of Rest.
* This standard of rest must be qualified using the RefRA and RefDec
* attributes.
*
* - "LSRK", "LSR": The rest-frame of the kinematical Local Standard of
* Rest. Spectra recorded in this standard of rest suffer a Doppler shift
* which depends on the velocity of the kinematical Local Standard of Rest
* through the galaxy. This standard of rest must be qualified using the
* RefRA and RefDec attributes.
*
* - "LSRD": The rest-frame of the dynamical Local Standard of Rest. Spectra
* recorded in this standard of rest suffer a Doppler shift which depends
* on the velocity of the dynamical Local Standard of Rest through the
* galaxy. This standard of rest must be qualified using the RefRA and
* RefDec attributes.
*
* - "Galactic", "Galactoc" or "Gal": The rest-frame of the galactic centre.
* Spectra recorded in this standard of rest suffer a Doppler shift which
* depends on the velocity of the galactic centre through the local group.
* This standard of rest must be qualified using the RefRA and RefDec
* attributes.
*
* - "Local_group", "Localgrp" or "LG": The rest-frame of the local group.
* This standard of rest must be qualified using the RefRA and RefDec
* attributes.
*
* - "Source", or "src": The rest-frame of the source. This standard of
* rest must be qualified using the RefRA, RefDec and SourceVel attributes.
*
* Where more than one alternative System value is shown above, the
* first of these will be returned when an enquiry is made.
*att--
*/
/* The StdOfRest value has a value of AST__BADSOR when not set yielding
a default of AST__HLSOR. */
astMAKE_TEST(SpecFrame,StdOfRest,( this->stdofrest != AST__BADSOR ))
astMAKE_GET(SpecFrame,StdOfRest,AstStdOfRestType,AST__BADSOR,(
( this->stdofrest == AST__BADSOR ) ? AST__HLSOR : this->stdofrest ) )
/*
*att++
* Name:
* SpecOrigin
* Purpose:
* The zero point for SpecFrame axis values
* Type:
* Public attribute.
* Synopsis:
* Floating point.
* Description:
* This specifies the origin from which all spectral values are measured.
* The default value (zero) results in the SpecFrame describing
* absolute spectral values in the system given by the System attribute
* (e.g. frequency, velocity, etc). If a SpecFrame is to be used to
* describe offset from some origin, the SpecOrigin attribute
* should be set to hold the required origin value. The SpecOrigin value
* stored inside the SpecFrame structure is modified whenever SpecFrame
* attribute values are changed so that it refers to the original spectral
* position.
*
* When setting a new value for this attribute, the supplied value is assumed
* to be in the system, units and standard of rest described by the SpecFrame.
* Likewise, when getting the value of this attribute, the value is returned
* in the system, units and standard of rest described by the SpecFrame. If
* any of these attributes are changed, then any previously stored SpecOrigin
* value will also be changed so that refers to the new system, units or
* standard of rest.
* Applicability:
* SpecFrame
* All SpecFrames have this attribute.
*att--
*/
/* The spec origin, stored internally in the default units associated
with the current System value. Clear the SpecOrigin value by setting it
to AST__BAD, which gives 0.0 as the default value. Any value is acceptable. */
astMAKE_CLEAR(SpecFrame,SpecOrigin,specorigin,AST__BAD)
astMAKE_GET(SpecFrame,SpecOrigin,double,0.0,((this->specorigin!=AST__BAD)?this->specorigin:0.0))
astMAKE_SET(SpecFrame,SpecOrigin,double,specorigin,value)
astMAKE_TEST(SpecFrame,SpecOrigin,( this->specorigin != AST__BAD ))
/* Copy constructor. */
/* ----------------- */
static void Copy( const AstObject *objin, AstObject *objout, int *status ) {
/*
* Name:
* Copy
* Purpose:
* Copy constructor for SpecFrame objects.
* Type:
* Private function.
* Synopsis:
* void Copy( const AstObject *objin, AstObject *objout, int *status )
* Description:
* This function implements the copy constructor for SpecFrame objects.
* Parameters:
* objin
* Pointer to the object to be copied.
* objout
* Pointer to the object being constructed.
* status
* Pointer to the inherited status variable.
* Notes:
* - This constructor makes a deep copy.
*/
/* Local Variables: */
AstSpecFrame *in; /* Pointer to input SpecFrame */
AstSpecFrame *out; /* Pointer to output SpecFrame */
char *usedunit; /* Pointer to an element of usedunits array */
int i; /* Loop count */
int nused; /* Size of "usedunits" array */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain pointers to the input and output SpecFrames. */
in = (AstSpecFrame *) objin;
out = (AstSpecFrame *) objout;
/* Nullify the pointers stored in the output object since these will
currently be pointing at the input data (since the output is a simple
byte-for-byte copy of the input). Otherwise, the input data could be
freed by accidient if the output object is deleted due to an error
occuring in this function. */
out->usedunits = NULL;
/* Store the last used units in the output SpecMap. */
if( in && in->usedunits ) {
nused = in->nuunits;
out->usedunits = astMalloc( nused*sizeof( char * ) );
if( out->usedunits ) {
for( i = 0; i < nused; i++ ) {
usedunit = in->usedunits[ i ];
if( usedunit ) {
out->usedunits[ i ] = astStore( NULL, usedunit,
strlen( usedunit ) + 1 );
} else {
out->usedunits[ i ] = NULL;
}
}
}
}
/* If an error has occurred, free the output resources. */
if( !astOK ) Delete( (AstObject *) out, status );
}
/* Destructor. */
/* ----------- */
static void Delete( AstObject *obj, int *status ) {
/*
* Name:
* Delete
* Purpose:
* Destructor for SpecFrame objects.
* Type:
* Private function.
* Synopsis:
* void Delete( AstObject *obj, int *status )
* Description:
* This function implements the destructor for SpecFrame objects.
* Parameters:
* obj
* Pointer to the object to be deleted.
* status
* Pointer to the inherited status variable.
* Notes:
* This function attempts to execute even if the global error status is
* set.
*/
/* Local Variables: */
AstSpecFrame *this;
int i;
/* Release the memory referred to in the SpecFrame structure. */
this = (AstSpecFrame *) obj;
if( this && this->usedunits ) {
for( i = 0; i < this->nuunits; i++ ) {
this->usedunits[ i ] = astFree( this->usedunits[ i ] );
}
this->usedunits = astFree( this->usedunits );
}
}
/* Dump function. */
/* -------------- */
static void Dump( AstObject *this_object, AstChannel *channel, int *status ) {
/*
* Name:
* Dump
* Purpose:
* Dump function for SpecFrame objects.
* Type:
* Private function.
* Synopsis:
* void Dump( AstObject *this, AstChannel *channel, int *status )
* Description:
* This function implements the Dump function which writes out data
* for the SpecFrame class to an output Channel.
* Parameters:
* this
* Pointer to the SpecFrame whose data are being written.
* channel
* Pointer to the Channel to which the data are being written.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstSpecFrame *this; /* Pointer to the SpecFrame structure */
AstStdOfRestType sor; /* StdOfRest attribute value */
AstSystemType sys; /* Spectral system value */
char buff[ 20 ]; /* Buffer for item name */
char comm[ 50 ]; /* Buffer for comment */
const char *sval; /* Pointer to string value */
double dval; /* Double value */
int i; /* Loop count */
int ival; /* int value */
int j; /* Loop count */
int set; /* Attribute value set? */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the SpecFrame structure. */
this = (AstSpecFrame *) this_object;
/* Write out values representing the instance variables for the
SpecFrame class. Accompany these with appropriate comment strings,
possibly depending on the values being written.*/
/* In the case of attributes, we first use the appropriate (private)
Test... member function to see if they are set. If so, we then use
the (private) Get... function to obtain the value to be written
out.
For attributes which are not set, we use the astGet... method to
obtain the value instead. This will supply a default value
(possibly provided by a derived class which over-rides this method)
which is more useful to a human reader as it corresponds to the
actual default attribute value. Since "set" will be zero, these
values are for information only and will not be read back. */
/* StdOfRest. */
/* ---------- */
set = TestStdOfRest( this, status );
sor = set ? GetStdOfRest( this, status ) : astGetStdOfRest( this );
/* If set, convert explicitly to a string for the external
representation. */
sval = "";
if ( set ) {
if ( astOK ) {
sval = StdOfRestString( sor, status );
/* Report an error if the StdOfRest value was not recognised. */
if ( !sval ) {
astError( AST__SCSIN,
"%s(%s): Corrupt %s contains invalid standard of rest "
"identification code (%d).", status, "astWrite",
astGetClass( channel ), astGetClass( this ), (int) sor );
}
}
/* If not set, use astGetAttrib which returns a string value using
(possibly over-ridden) methods. */
} else {
sval = astGetAttrib( this_object, "stdofrest" );
}
/* Write out the value. */
astWriteString( channel, "SoR", set, 1, sval, "Standard of rest" );
/* AlignStdOfRest. */
/* --------------- */
set = TestAlignStdOfRest( this, status );
sor = set ? GetAlignStdOfRest( this, status ) : astGetAlignStdOfRest( this );
/* If set, convert explicitly to a string for the external representation. */
if ( set ) {
if ( astOK ) {
sval = StdOfRestString( sor, status );
/* Report an error if the StdOfRest value was not recognised. */
if ( !sval ) {
astError( AST__SCSIN,
"%s(%s): Corrupt %s contains invalid alignment standard "
"of rest identification code (%d).", status, "astWrite",
astGetClass( channel ), astGetClass( this ), (int) sor );
}
}
/* If not set, use astGetAttrib which returns a string value using
(possibly over-ridden) methods. */
} else {
sval = astGetAttrib( this_object, "alignstdofrest" );
}
/* Write out the value. */
astWriteString( channel, "AlSoR", set, 0, sval, "Alignment standard of rest" );
/* RefRA. */
/* ------ */
set = TestRefRA( this, status );
dval = set ? GetRefRA( this, status ) : astGetRefRA( this );
astWriteDouble( channel, "RefRA", set, 0, dval, "Reference RA (rads, FK5 J2000)" );
/* RefDec. */
/* ------- */
set = TestRefDec( this, status );
dval = set ? GetRefDec( this, status ) : astGetRefDec( this );
astWriteDouble( channel, "RefDec", set, 0, dval, "Reference Dec (rads, FK5 J2000)" );
/* RestFreq. */
/* --------- */
set = TestRestFreq( this, status );
dval = set ? GetRestFreq( this, status ) : astGetRestFreq( this );
astWriteDouble( channel, "RstFrq", set, 0, dval, "Rest frequency (Hz)" );
/* SourceVel. */
/* ---------- */
set = TestSourceVel( this, status );
dval = set ? GetSourceVel( this, status ) : astGetSourceVel( this );
astWriteDouble( channel, "SrcVel", set, 0, dval, "Source velocity (m/s)" );
/* SourceVRF. */
/* ---------- */
set = TestSourceVRF( this, status );
sor = set ? GetSourceVRF( this, status ) : astGetSourceVRF( this );
/* If set, convert explicitly to a string for the external representation. */
if ( set ) {
if ( astOK ) {
sval = StdOfRestString( sor, status );
/* Report an error if the value was not recognised. */
if ( !sval ) {
astError( AST__SCSIN,
"%s(%s): Corrupt %s contains invalid source velocity "
"rest frame identification code (%d).", status, "astWrite",
astGetClass( channel ), astGetClass( this ), (int) sor );
}
}
/* If not set, use astGetAttrib which returns a string value using
(possibly over-ridden) methods. */
} else {
sval = astGetAttrib( this_object, "sourcevrf" );
}
/* Write out the value. */
astWriteString( channel, "SrcVRF", set, 0, sval, "Source velocity rest frame" );
/* SourceSys. */
/* ---------- */
set = TestSourceSys( this, status );
sys = set ? GetSourceSys( this, status ) : astGetSourceSys( this );
/* If set, convert explicitly to a string for the external representation. */
if ( set ) {
if ( astOK ) {
sval = SystemString( (AstFrame *) this, sys, status );
/* Report an error if the value was not recognised. */
if ( !sval ) {
astError( AST__SCSIN,
"%s(%s): Corrupt %s contains invalid source velocity "
"spectral system identification code (%d).", status, "astWrite",
astGetClass( channel ), astGetClass( this ), (int) sys );
}
}
/* If not set, use astGetAttrib which returns a string value using
(possibly over-ridden) methods. */
} else {
sval = astGetAttrib( this_object, "sourcesys" );
}
/* Write out the value. */
astWriteString( channel, "SrcSys", set, 0, sval, "Source velocity spectral system" );
/* AlignSpecOffset. */
/* ---------------- */
set = TestAlignSpecOffset( this, status );
ival = set ? GetAlignSpecOffset( this, status ) : astGetAlignSpecOffset( this );
astWriteInt( channel, "AlSpOf", set, 0, ival,
ival ? "Align in offset coords" :
"Align in system coords" );
/* UsedUnits */
/* --------- */
if( this->usedunits ) {
for( i = 0; i < this->nuunits; i++ ) {
if( this->usedunits[ i ] ) {
sprintf( buff, "U%s", astSystemString( this, (AstSystemType) i ));
for( j = 2; j < strlen( buff ); j++ ) buff[ j ] = tolower( buff[ j ] );
sprintf( comm, "Preferred units for %s", SystemLabel( (AstSystemType) i, status ) );
astWriteString( channel, buff, 1, 0, this->usedunits[ i ], comm );
}
}
}
/* SpecOrigin. */
/* ----------- */
set = TestSpecOrigin( this, status );
dval = set ? GetSpecOrigin( this, status ) : astGetSpecOrigin( this );
if( dval != AST__BAD ) {
astWriteDouble( channel, "SpOrg", set, 0, dval, "Spec offset" );
}
}
/* Standard class functions. */
/* ========================= */
/* Implement the astIsASpecFrame and astCheckSpecFrame functions using the
macros defined for this purpose in the "object.h" header file. */
astMAKE_ISA(SpecFrame,Frame)
astMAKE_CHECK(SpecFrame)
AstSpecFrame *astSpecFrame_( const char *options, int *status, ...) {
/*
*+
* Name:
* astSpecFrame
* Purpose:
* Create a SpecFrame.
* Type:
* Protected function.
* Synopsis:
* #include "specframe.h"
* AstSpecFrame *astSpecFrame( const char *options, int *status, ... )
* Class Membership:
* SpecFrame constructor.
* Description:
* This function creates a new SpecFrame and optionally initialises its
* attributes.
* Parameters:
* options
* Pointer to a null terminated string containing an optional
* comma-separated list of attribute assignments to be used for
* initialising the new SpecFrame. The syntax used is the same as for the
* astSet method and may include "printf" format specifiers identified
* by "%" symbols in the normal way.
* status
* Pointer to the inherited status variable.
* ...
* If the "options" string contains "%" format specifiers, then an
* optional list of arguments may follow it in order to supply values to
* be substituted for these specifiers. The rules for supplying these
* are identical to those for the astSet method (and for the C "printf"
* function).
* Returned Value:
* A pointer to the new SpecFrame.
* Notes:
* - A NULL pointer will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
*-
* Implementation Notes:
* - This function implements the basic SpecFrame constructor which
* is available via the protected interface to the SpecFrame class.
* A public interface is provided by the astSpecFrameId_ function.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Pointer to thread-specific global data */
AstMapping *um; /* Mapping from default to actual units */
AstSpecFrame *new; /* Pointer to new SpecFrame */
AstSystemType s; /* System */
const char *u; /* Units string */
va_list args; /* Variable argument list */
/* Get a pointer to the thread specific global data structure. */
astGET_GLOBALS(NULL);
/* Check the global status. */
if ( !astOK ) return NULL;
/* Initialise the SpecFrame, allocating memory and initialising the virtual
function table as well if necessary. */
new = astInitSpecFrame( NULL, sizeof( AstSpecFrame ), !class_init,
&class_vtab, "SpecFrame" );
/* If successful, note that the virtual function table has been initialised. */
if ( astOK ) {
class_init = 1;
/* Obtain the variable argument list and pass it along with the options string
to the astVSet method to initialise the new SpecFrame's attributes. */
va_start( args, status );
astVSet( new, options, NULL, args );
va_end( args );
/* Check the Units are appropriate for the System. */
u = astGetUnit( new, 0 );
s = astGetSystem( new );
um = astUnitMapper( DefUnit( s, "astSpecFrame", "SpecFrame", status ),
u, NULL, NULL );
if( um ) {
um = astAnnul( um );
} else {
astError( AST__BADUN, "astSpecFrame: Inappropriate units (%s) "
"specified for a %s axis.", status, u, SystemLabel( s, status ) );
}
/* If an error occurred, clean up by deleting the new object. */
if ( !astOK ) new = astDelete( new );
}
/* Return a pointer to the new SpecFrame. */
return new;
}
AstSpecFrame *astInitSpecFrame_( void *mem, size_t size, int init,
AstSpecFrameVtab *vtab, const char *name, int *status ) {
/*
*+
* Name:
* astInitSpecFrame
* Purpose:
* Initialise a SpecFrame.
* Type:
* Protected function.
* Synopsis:
* #include "specframe.h"
* AstSpecFrame *astInitSpecFrame( void *mem, size_t size, int init,
* AstFrameVtab *vtab, const char *name )
* Class Membership:
* SpecFrame initialiser.
* Description:
* This function is provided for use by class implementations to
* initialise a new SpecFrame object. It allocates memory (if
* necessary) to accommodate the SpecFrame plus any additional data
* associated with the derived class. It then initialises a
* SpecFrame structure at the start of this memory. If the "init"
* flag is set, it also initialises the contents of a virtual function
* table for a SpecFrame at the start of the memory passed via the
* "vtab" parameter.
* Parameters:
* mem
* A pointer to the memory in which the SpecFrame is to be
* created. This must be of sufficient size to accommodate the
* SpecFrame data (sizeof(SpecFrame)) plus any data used by
* the derived class. If a value of NULL is given, this function
* will allocate the memory itself using the "size" parameter to
* determine its size.
* size
* The amount of memory used by the SpecFrame (plus derived
* class data). This will be used to allocate memory if a value of
* NULL is given for the "mem" parameter. This value is also stored
* in the SpecFrame structure, so a valid value must be supplied
* even if not required for allocating memory.
* init
* A logical flag indicating if the SpecFrame's virtual function
* table is to be initialised. If this value is non-zero, the
* virtual function table will be initialised by this function.
* vtab
* Pointer to the start of the virtual function table to be
* associated with the new SpecFrame.
* name
* Pointer to a constant null-terminated character string which
* contains the name of the class to which the new object belongs
* (it is this pointer value that will subsequently be returned by
* the astGetClass method).
* Returned Value:
* A pointer to the new SpecFrame.
* Notes:
* - A null pointer will be returned if this function is invoked with the
* global error status set, or if it should fail for any reason.
*-
*/
/* Local Variables: */
AstSpecFrame *new; /* Pointer to the new SpecFrame */
/* Check the global status. */
if ( !astOK ) return NULL;
/* If necessary, initialise the virtual function table. */
if ( init ) astInitSpecFrameVtab( vtab, name );
/* Initialise a 1D Frame structure (the parent class) as the first component
within the SpecFrame structure, allocating memory if necessary. */
new = (AstSpecFrame *) astInitFrame( mem, size, 0,
(AstFrameVtab *) vtab, name, 1 );
if ( astOK ) {
/* Initialise the SpecFrame data. */
/* ----------------------------- */
/* Initialise all attributes to their "undefined" values. */
new->alignstdofrest = AST__BADSOR;
new->refdec = AST__BAD;
new->refra = AST__BAD;
new->restfreq = AST__BAD;
new->sourcevel = AST__BAD;
new->sourcevrf = AST__BADSOR;
new->sourcesys = AST__BADSYSTEM;
new->stdofrest = AST__BADSOR;
new->nuunits = 0;
new->usedunits = NULL;
new->specorigin = AST__BAD;
new->alignspecoffset = -INT_MAX;
/* If an error occurred, clean up by deleting the new object. */
if ( !astOK ) new = astDelete( new );
}
/* Return a pointer to the new object. */
return new;
}
AstSpecFrame *astLoadSpecFrame_( void *mem, size_t size,
AstSpecFrameVtab *vtab,
const char *name, AstChannel *channel, int *status ) {
/*
*+
* Name:
* astLoadSpecFrame
* Purpose:
* Load a SpecFrame.
* Type:
* Protected function.
* Synopsis:
* #include "specframe.h"
* AstSpecFrame *astLoadSpecFrame( void *mem, size_t size,
* AstSpecFrameVtab *vtab,
* const char *name, AstChannel *channel )
* Class Membership:
* SpecFrame loader.
* Description:
* This function is provided to load a new SpecFrame using data read
* from a Channel. It first loads the data used by the parent class
* (which allocates memory if necessary) and then initialises a
* SpecFrame structure in this memory, using data read from the
* input Channel.
* Parameters:
* mem
* A pointer to the memory into which the SpecFrame is to be
* loaded. This must be of sufficient size to accommodate the
* SpecFrame data (sizeof(SpecFrame)) plus any data used by
* derived classes. If a value of NULL is given, this function
* will allocate the memory itself using the "size" parameter to
* determine its size.
* size
* The amount of memory used by the SpecFrame (plus derived class
* data). This will be used to allocate memory if a value of
* NULL is given for the "mem" parameter. This value is also
* stored in the SpecFrame structure, so a valid value must be
* supplied even if not required for allocating memory.
*
* If the "vtab" parameter is NULL, the "size" value is ignored
* and sizeof(AstSpecFrame) is used instead.
* vtab
* Pointer to the start of the virtual function table to be
* associated with the new SpecFrame. If this is NULL, a pointer
* to the (static) virtual function table for the SpecFrame class
* is used instead.
* name
* Pointer to a constant null-terminated character string which
* contains the name of the class to which the new object
* belongs (it is this pointer value that will subsequently be
* returned by the astGetClass method).
*
* If the "vtab" parameter is NULL, the "name" value is ignored
* and a pointer to the string "SpecFrame" is used instead.
* Returned Value:
* A pointer to the new SpecFrame.
* Notes:
* - A null pointer will be returned if this function is invoked
* with the global error status set, or if it should fail for any
* reason.
*-
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Pointer to thread-specific global data */
AstSpecFrame *new; /* Pointer to the new SpecFrame */
char buff[ 20 ]; /* Buffer for item name */
char *sval; /* Pointer to string value */
double obslat; /* Value for ObsLat attribute */
double obslon; /* Get a pointer to the thread specific global data structure. */
/* Value for ObsLon attribute */
int i; /* Loop count */
int j; /* Loop count */
int nc; /* String length */
int sys; /* System value */
astGET_GLOBALS(channel);
/* Initialise. */
new = NULL;
/* Check the global error status. */
if ( !astOK ) return new;
/* If a NULL virtual function table has been supplied, then this is
the first loader to be invoked for this SpecFrame. In this case the
SpecFrame belongs to this class, so supply appropriate values to be
passed to the parent class loader (and its parent, etc.). */
if ( !vtab ) {
size = sizeof( AstSpecFrame );
vtab = &class_vtab;
name = "SpecFrame";
/* If required, initialise the virtual function table for this class. */
if ( !class_init ) {
astInitSpecFrameVtab( vtab, name );
class_init = 1;
}
}
/* Invoke the parent class loader to load data for all the ancestral
classes of the current one, returning a pointer to the resulting
partly-built SpecFrame. */
new = astLoadFrame( mem, size, (AstFrameVtab *) vtab, name,
channel );
if ( astOK ) {
/* Read input data. */
/* ================ */
/* Request the input Channel to read all the input data appropriate to
this class into the internal "values list". */
astReadClassData( channel, "SpecFrame" );
/* Now read each individual data item from this list and use it to
initialise the appropriate instance variable(s) for this class. */
/* In the case of attributes, we first read the "raw" input value,
supplying the "unset" value as the default. If a "set" value is
obtained, we then use the appropriate (private) Set... member
function to validate and set the value properly. */
/* StdOfRest. */
/* ---------- */
/* Set the default and read the external representation as a string. */
new->stdofrest = AST__BADSOR;
sval = astReadString( channel, "sor", NULL );
/* If a value was read, convert from a string to a StdOfRest code. */
if ( sval ) {
if ( astOK ) {
new->stdofrest = StdOfRestCode( sval, status );
/* Report an error if the value wasn't recognised. */
if ( new->stdofrest == AST__BADSOR ) {
astError( AST__ATTIN,
"astRead(%s): Invalid standard of rest description "
"\"%s\".", status, astGetClass( channel ), sval );
}
}
/* Free the string value. */
sval = astFree( sval );
}
/* AlignStdOfRest. */
/* --------------- */
/* Set the default and read the external representation as a string. */
new->alignstdofrest = AST__BADSOR;
sval = astReadString( channel, "alsor", NULL );
/* If a value was read, convert from a string to a StdOfRest code. */
if ( sval ) {
if ( astOK ) {
new->alignstdofrest = StdOfRestCode( sval, status );
/* Report an error if the value wasn't recognised. */
if ( new->alignstdofrest == AST__BADSOR ) {
astError( AST__ATTIN,
"astRead(%s): Invalid alignment standard of rest "
"description \"%s\".", status, astGetClass( channel ), sval );
}
}
/* Free the string value. */
sval = astFree( sval );
}
/* GeoLat. */
/* ------- */
/* Retained for backward compatibility with older versions of AST in
which SpecFrame had a GeoLat attribute (now ObsLat is used instead). */
if( !astTestObsLat( new ) ) {
obslat = astReadDouble( channel, "geolat", AST__BAD );
if ( obslat != AST__BAD ) astSetObsLat( new, obslat );
}
/* GeoLon. */
/* ------- */
/* Retained for backward compatibility with older versions of AST in
which SpecFrame had a GeoLon attribute (now ObsLon is used instead). */
if( !astTestObsLon( new ) ) {
obslon = astReadDouble( channel, "geolon", AST__BAD );
if ( obslon != AST__BAD ) astSetObsLon( new, obslon );
}
/* RefRA. */
/* ------ */
new->refra = astReadDouble( channel, "refra", AST__BAD );
if ( TestRefRA( new, status ) ) SetRefRA( new, new->refra, status );
/* RefDec. */
/* ------- */
new->refdec = astReadDouble( channel, "refdec", AST__BAD );
if ( TestRefDec( new, status ) ) SetRefDec( new, new->refdec, status );
/* RestFreq. */
/* --------- */
new->restfreq = astReadDouble( channel, "rstfrq", AST__BAD );
if ( TestRestFreq( new, status ) ) SetRestFreq( new, new->restfreq, status );
/* AlignSpecOffset */
/* --------------- */
new->alignspecoffset = astReadInt( channel, "alspof", -INT_MAX );
if ( TestAlignSpecOffset( new, status ) ) SetAlignSpecOffset( new, new->alignspecoffset, status );
/* SourceVel. */
/* ---------- */
new->sourcevel = astReadDouble( channel, "srcvel", AST__BAD );
if ( TestSourceVel( new, status ) ) SetSourceVel( new, new->sourcevel, status );
/* SourceVRF */
/* --------- */
/* Set the default and read the external representation as a string. */
new->sourcevrf = AST__BADSOR;
sval = astReadString( channel, "srcvrf", NULL );
/* If a value was read, convert from a string to a StdOfRest code. */
if ( sval ) {
if ( astOK ) {
new->sourcevrf = StdOfRestCode( sval, status );
/* Report an error if the value wasn't recognised. */
if ( new->sourcevrf == AST__BADSOR ) {
astError( AST__ATTIN,
"astRead(%s): Invalid source velocity rest frame "
"description \"%s\".", status, astGetClass( channel ), sval );
}
}
/* Free the string value. */
sval = astFree( sval );
}
/* SourceSys */
/* --------- */
/* Set the default and read the external representation as a string. */
new->sourcesys = AST__BADSYSTEM;
sval = astReadString( channel, "srcsys", NULL );
/* If a value was read, convert from a string to a System code. */
if ( sval ) {
if ( astOK ) {
new->sourcesys = SystemCode( (AstFrame *) new, sval, status );
/* Report an error if the value wasn't recognised. */
if ( new->sourcesys == AST__BADSYSTEM ) {
astError( AST__ATTIN,
"astRead(%s): Invalid source velocity spectral system "
"description \"%s\".", status, astGetClass( channel ), sval );
}
}
/* Free the string value. */
sval = astFree( sval );
}
/* UsedUnits */
/* --------- */
new->nuunits = 0;
new->usedunits = NULL;
for( sys = FIRST_SYSTEM; sys <= LAST_SYSTEM; sys++ ) {
nc = sprintf( buff, "u%s", astSystemString( new, (AstSystemType) sys ));
for( j = 0; j < nc; j++ ) buff[ j ] = tolower( buff[ j ] );
sval = astReadString( channel, buff, NULL );
if( sval ) {
if( (int) sys >= new->nuunits ) {
new->usedunits = astGrow( new->usedunits, sys + 1,
sizeof(char *) );
if( astOK ) {
for( i = new->nuunits; i < sys + 1; i++ ) new->usedunits[ i ] = NULL;
new->nuunits = sys + 1;
}
} else {
new->usedunits[ sys ] = astFree( new->usedunits[ sys ] );
}
if( astOK ) {
new->usedunits[ sys ] = astStore( new->usedunits[ sys ],
sval, strlen( sval ) + 1 );
}
sval = astFree( sval);
}
}
/* SpecOrigin. */
/* --------- */
new->specorigin = astReadDouble( channel, "sporg", AST__BAD );
if ( TestSpecOrigin( new, status ) ) SetSpecOrigin( new, new->specorigin, status );
/* If an error occurred, clean up by deleting the new SpecFrame. */
if ( !astOK ) new = astDelete( new );
}
/* Return the new SpecFrame pointer. */
return new;
}
/* Virtual function interfaces. */
/* ============================ */
/* These provide the external interface to the virtual functions defined by
this class. Each simply checks the global error status and then locates and
executes the appropriate member function, using the function pointer stored
in the object's virtual function table (this pointer is located using the
astMEMBER macro defined in "object.h").
Note that the member function may not be the one defined here, as it may
have been over-ridden by a derived class. However, it should still have the
same interface. */
void astGetRefPos_( AstSpecFrame *this, AstSkyFrame *frm, double *lon,
double *lat, int *status ){
if ( !astOK ) return;
(**astMEMBER(this,SpecFrame,GetRefPos))(this,frm,lon,lat, status );
}
void astSetRefPos_( AstSpecFrame *this, AstSkyFrame *frm, double lon,
double lat, int *status ){
if ( !astOK ) return;
(**astMEMBER(this,SpecFrame,SetRefPos))(this,frm,lon,lat, status );
}
void astSetStdOfRest_( AstSpecFrame *this, AstStdOfRestType value, int *status ){
if ( !astOK ) return;
(**astMEMBER(this,SpecFrame,SetStdOfRest))(this,value, status );
}
void astClearStdOfRest_( AstSpecFrame *this, int *status ){
if ( !astOK ) return;
(**astMEMBER(this,SpecFrame,ClearStdOfRest))(this, status );
}
/* Special public interface functions. */
/* =================================== */
/* These provide the public interface to certain special functions
whose public interface cannot be handled using macros (such as
astINVOKE) alone. In general, they are named after the
corresponding protected version of the function, but with "Id"
appended to the name. */
/* Public Interface Function Prototypes. */
/* ------------------------------------- */
/* The following functions have public prototypes only (i.e. no
protected prototypes), so we must provide local prototypes for use
within this module. */
AstSpecFrame *astSpecFrameId_( const char *, ... );
/* Special interface function implementations. */
/* ------------------------------------------- */
AstSpecFrame *astSpecFrameId_( const char *options, ... ) {
/*
*++
* Name:
c astSpecFrame
f AST_SPECFRAME
* Purpose:
* Create a SpecFrame.
* Type:
* Public function.
* Synopsis:
c #include "specframe.h"
c AstSpecFrame *astSpecFrame( const char *options, ... )
f RESULT = AST_SPECFRAME( OPTIONS, STATUS )
* Class Membership:
* SpecFrame constructor.
* Description:
* This function creates a new SpecFrame and optionally initialises
* its attributes.
*
* A SpecFrame is a specialised form of one-dimensional Frame which
* represents various coordinate systems used to describe positions within
* an electro-magnetic spectrum. The particular coordinate system to be
* used is specified by setting the SpecFrame's System attribute (the
* default is wavelength) qualified, as necessary, by other attributes
* such as the rest frequency, the standard of rest, the epoch of
* observation, etc (see the description of the System attribute for
* details).
*
* By setting a value for thr SpecOrigin attribute, a SpecFrame can be made
* to represent offsets from a given spectral position, rather than absolute
* Parameters:
c options
f OPTIONS = CHARACTER * ( * ) (Given)
c Pointer to a null-terminated string containing an optional
c comma-separated list of attribute assignments to be used for
c initialising the new SpecFrame. The syntax used is identical to
c that for the astSet function and may include "printf" format
c specifiers identified by "%" symbols in the normal way.
c If no initialisation is required, a zero-length string may be
c supplied.
f A character string containing an optional comma-separated
f list of attribute assignments to be used for initialising the
f new SpecFrame. The syntax used is identical to that for the
f AST_SET routine. If no initialisation is required, a blank
f value may be supplied.
c ...
c If the "options" string contains "%" format specifiers, then
c an optional list of additional arguments may follow it in
c order to supply values to be substituted for these
c specifiers. The rules for supplying these are identical to
c those for the astSet function (and for the C "printf"
c function).
f STATUS = INTEGER (Given and Returned)
f The global status.
* Returned Value:
c astSpecFrame()
f AST_SPECFRAME = INTEGER
* A pointer to the new SpecFrame.
* Examples:
c frame = astSpecFrame( "" );
f FRAME = AST_SPECFRAME( ' ', STATUS )
* Creates a SpecFrame to describe the default wavelength spectral
* coordinate system. The RestFreq attribute (rest frequency) is
* unspecified, so it will not be possible to align this SpecFrame
* with another SpecFrame on the basis of a velocity-based system. The
* standard of rest is also unspecified. This means that alignment
* will be possible with other SpecFrames, but no correction will be
* made for Doppler shift caused by change of rest frame during the
* alignment.
c frame = astSpecFrame( "System=VELO, RestFreq=1.0E15, StdOfRest=LSRK" );
f FRAME = AST_SPECFRAME( 'System=VELO, RestFreq=1.0E15, StdOfRest=LSRK', STATUS )
* Creates a SpecFrame describing a apparent radial velocity ("VELO") axis
* with rest frequency 1.0E15 Hz (about 3000 Angstroms), measured
* in the kinematic Local Standard of Rest ("LSRK"). Since the
* source position has not been specified (using attributes RefRA and
* RefDec), it will only be possible to align this SpecFrame with
* other SpecFrames which are also measured in the LSRK standard of
* rest.
* Notes:
* - When conversion between two SpecFrames is requested (as when
c supplying SpecFrames to astConvert),
f supplying SpecFrames AST_CONVERT),
* account will be taken of the nature of the spectral coordinate systems
* they represent, together with any qualifying rest frequency, standard
* of rest, epoch values, etc. The AlignSystem and AlignStdOfRest
* attributes will also be taken into account. The results will therefore
* fully reflect the relationship between positions measured in the two
* systems. In addition, any difference in the Unit attributes of the two
* systems will also be taken into account.
* - A null Object pointer (AST__NULL) will be returned if this
c function is invoked with the AST error status set, or if it
f function is invoked with STATUS set to an error value, or if it
* should fail for any reason.
*--
* Implementation Notes:
* - This function implements the external (public) interface to
* the astSpecFrame constructor function. It returns an ID value
* (instead of a true C pointer) to external users, and must be
* provided because astSpecFrame_ has a variable argument list which
* cannot be encapsulated in a macro (where this conversion would
* otherwise occur).
* - The variable argument list also prevents this function from
* invoking astSpecFrame_ directly, so it must be a
* re-implementation of it in all respects, except for the final
* conversion of the result to an ID value.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Pointer to thread-specific global data */
AstMapping *um; /* Mapping from default to actual units */
AstSpecFrame *new; /* Pointer to new SpecFrame */
AstSystemType s; /* System */
const char *u; /* Units string */
va_list args; /* Variable argument list */
int *status; /* Pointer to inherited status value */
astGET_GLOBALS(NULL); /* Get a pointer to the thread specific global data structure. */
/* Get a pointer to the inherited status value. */
status = astGetStatusPtr;
/* Check the global status. */
if ( !astOK ) return NULL;
/* Initialise the SpecFrame, allocating memory and initialising the virtual
function table as well if necessary. */
new = astInitSpecFrame( NULL, sizeof( AstSpecFrame ), !class_init,
&class_vtab, "SpecFrame" );
/* If successful, note that the virtual function table has been initialised. */
if ( astOK ) {
class_init = 1;
/* Obtain the variable argument list and pass it along with the options string
to the astVSet method to initialise the new SpecFrame's attributes. */
va_start( args, options );
astVSet( new, options, NULL, args );
va_end( args );
/* Check the Units are appropriate for the System. */
u = astGetUnit( new, 0 );
s = astGetSystem( new );
um = astUnitMapper( DefUnit( s, "astSpecFrame", "SpecFrame", status ),
u, NULL, NULL );
if( um ) {
um = astAnnul( um );
} else {
astError( AST__BADUN, "astSpecFrame: Inappropriate units (%s) "
"specified for a %s axis.", status, u, SystemLabel( s, status ) );
}
/* If an error occurred, clean up by deleting the new object. */
if ( !astOK ) new = astDelete( new );
}
/* Return an ID value for the new SpecFrame. */
return astMakeId( new );
}
|