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
|
/*
*class++
* Name:
* CmpRegion
* Purpose:
* A combination of two regions within a single Frame
* Constructor Function:
c astCmpRegion
f AST_CMPREGION
* Description:
* A CmpRegion is a Region which allows two component
* Regions (of any class) to be combined to form a more complex
* Region. This combination may be performed a boolean AND, OR
* or XOR (exclusive OR) operator. If the AND operator is
* used, then a position is inside the CmpRegion only if it is
* inside both of its two component Regions. If the OR operator is
* used, then a position is inside the CmpRegion if it is inside
* either (or both) of its two component Regions. If the XOR operator
* is used, then a position is inside the CmpRegion if it is inside
* one but not both of its two component Regions. Other operators can
* be formed by negating one or both component Regions before using
* them to construct a new CmpRegion.
*
* The two component Region need not refer to the same coordinate
* Frame, but it must be possible for the
c astConvert
f AST_CONVERT
* function to determine a Mapping between them (an error will be
* reported otherwise when the CmpRegion is created). For instance,
* a CmpRegion may combine a Region defined within an ICRS SkyFrame
* with a Region defined within a Galactic SkyFrame. This is
* acceptable because the SkyFrame class knows how to convert between
* these two systems, and consequently the
c astConvert
f AST_CONVERT
* function will also be able to convert between them. In such cases,
* the second component Region will be mapped into the coordinate Frame
* of the first component Region, and the Frame represented by the
* CmpRegion as a whole will be the Frame of the first component Region.
*
* Since a CmpRegion is itself a Region, it can be used as a
* component in forming further CmpRegions. Regions of arbitrary
* complexity may be built from simple individual Regions in this
* way.
* Inheritance:
* The CmpRegion class inherits from the Region class.
* Attributes:
* The CmpRegion class does not define any new attributes beyond those
* which are applicable to all Regions.
* Functions:
c The CmpRegion class does not define any new functions beyond those
f The CmpRegion class does not define any new routines beyond those
* which are applicable to all Regions.
* Copyright:
* Copyright (C) 1997-2006 Council for the Central Laboratory of the
* Research Councils
* Copyright (C) 2009 Science & Technology Facilities Council.
* All Rights Reserved.
* 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:
* 7-OCT-2004 (DSB):
* Original version.
* 28-MAY-2007 (DSB):
* - Corrected RegBaseMesh.
* - In RegBaseBox, if the CmpRegion is bounded find the box by
* finding the extreme position sin a mesh covering the boundary.
* 20-JAN-2009 (DSB):
* Over-ride astRegBasePick.
* 19-MAR-2009 (DSB):
* Over-ride the astDecompose method.
* 8-SEP-2009 (DSB):
* Fix logic in RegTrace.
* 9-SEP-2009 (DSB):
* - Added astCmpRegionList
* - Added support for XOR
* - Override astGetObjSize.
* 27-APR-2012 (DSB):
* - Cache the bounded property.
* - Speed up plotting of CmpRegions by using the cached negation
* of a Region instead of setting the Regions's Negated flag (which
* causes the Region's cache to be cleared).
* 30-APR-2012 (DSB):
* Use geodesic distance to measure distances around the two component
* Regions when tracing the border. Previously, a distance normalised
* from zero to one was used for both component Regions, but this gives
* greater priority to Regions higher in the CmpRegion nesting order,
* resulting in a high chance that lower Regions will not be seen.
* 7-JUN-2012 (DSB):
* Override astRegSplit method.
* 21-NOV-2012 (DSB):
* Map the regions returned by RegSplit into the current Frame of the
* CmpRegion.
*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 CmpRegion
/* Include files. */
/* ============== */
/* Interface definitions. */
/* ---------------------- */
#include "globals.h" /* Thread-safe global data access */
#include "error.h" /* Error reporting facilities */
#include "memory.h" /* Memory allocation facilities */
#include "object.h" /* Base Object class */
#include "pointset.h" /* Sets of points/coordinates */
#include "region.h" /* Regions (parent class) */
#include "channel.h" /* I/O channels */
#include "nullregion.h" /* Boundless Regions */
#include "cmpregion.h" /* Interface definition for this class */
#include "unitmap.h" /* Unit Mapings */
/* Error code definitions. */
/* ----------------------- */
#include "ast_err.h" /* AST error codes */
/* C header files. */
/* --------------- */
#include <stdarg.h>
#include <stddef.h>
#include <string.h>
#include <stdio.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 extended by this class. */
static AstPointSet *(* parent_transform)( AstMapping *, AstPointSet *, int, AstPointSet *, int * );
static AstRegion *(* parent_getdefunc)( AstRegion *, int * );
static void (* parent_setregfs)( AstRegion *, AstFrame *, int * );
static AstMapping *(* parent_simplify)( AstMapping *, int * );
static int (* parent_equal)( AstObject *, AstObject *, int * );
static void (* parent_setclosed)( AstRegion *, int, int * );
static void (* parent_setmeshsize)( AstRegion *, int, int * );
static void (* parent_clearclosed)( AstRegion *, int * );
static void (* parent_clearmeshsize)( AstRegion *, int * );
static double (*parent_getfillfactor)( AstRegion *, int * );
static void (*parent_regsetattrib)( AstRegion *, const char *, char **, int * );
static void (*parent_regclearattrib)( AstRegion *, const char *, char **, int * );
static void (* parent_resetcache)( AstRegion *, int * );
static int (* parent_getobjsize)( AstObject *, int * );
#if defined(THREAD_SAFE)
static int (* parent_managelock)( AstObject *, int, int, AstObject **, int * );
#endif
#ifdef THREAD_SAFE
/* Define how to initialise thread-specific globals. */
#define GLOBAL_inits \
globals->Class_Init = 0;
/* Create the function that initialises global data for this module. */
astMAKE_INITGLOBALS(CmpRegion)
/* Define macros for accessing each item of thread specific global data. */
#define class_init astGLOBAL(CmpRegion,Class_Init)
#define class_vtab astGLOBAL(CmpRegion,Class_Vtab)
#include <pthread.h>
#else
/* Define the class virtual function table and its initialisation flag
as static variables. */
static AstCmpRegionVtab class_vtab; /* Virtual function table */
static int class_init = 0; /* Virtual function table initialised? */
#endif
/* External 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. */
AstCmpRegion *astCmpRegionId_( void *, void *, int, const char *, ... );
/* Prototypes for Private Member Functions. */
/* ======================================== */
static AstMapping *Simplify( AstMapping *, int * );
static AstPointSet *RegBaseMesh( AstRegion *, int * );
static AstPointSet *Transform( AstMapping *, AstPointSet *, int, AstPointSet *, int * );
static AstRegion *GetDefUnc( AstRegion *, int * );
static AstRegion *MatchRegion( AstRegion *, int, AstRegion *, const char *, int * );
static AstRegion *RegBasePick( AstRegion *this, int, const int *, int * );
static AstRegion **RegSplit( AstRegion *, int *, int * );
static double GetFillFactor( AstRegion *, int * );
static int CmpRegionList( AstCmpRegion *, int *, AstRegion ***, int * );
static int Equal( AstObject *, AstObject *, int * );
static int GetBounded( AstRegion *, int * );
static int GetObjSize( AstObject *, int * );
static int RegPins( AstRegion *, AstPointSet *, AstRegion *, int **, int * );
static int RegTrace( AstRegion *, int, double *, double **, int * );
static void ClearClosed( AstRegion *, int * );
static void ClearMeshSize( AstRegion *, int * );
static void Copy( const AstObject *, AstObject *, int * );
static void Decompose( AstMapping *, AstMapping **, AstMapping **, int *, int *, int *, int * );
static void Delete( AstObject *, int * );
static void Dump( AstObject *, AstChannel *, int * );
static void GetRegions( AstCmpRegion *, AstRegion **, AstRegion **, int *, int *, int *, int * );
static void RegBaseBox( AstRegion *, double *, double *, int * );
static void RegBaseBox2( AstRegion *, double *, double *, int * );
static void RegClearAttrib( AstRegion *, const char *, char **, int * );
static void RegSetAttrib( AstRegion *, const char *, char **, int * );
static void ResetCache( AstRegion *this, int * );
static void SetBreakInfo( AstCmpRegion *, int, int * );
static void SetClosed( AstRegion *, int, int * );
static void SetMeshSize( AstRegion *, int, int * );
static void SetRegFS( AstRegion *, AstFrame *, int * );
static void XORCheck( AstCmpRegion *, int * );
#if defined(THREAD_SAFE)
static int ManageLock( AstObject *, int, int, AstObject **, int * );
#endif
/* Member functions. */
/* ================= */
int CmpRegionList( AstCmpRegion *this, int *nreg, AstRegion ***reg_list,
int *status ) {
/*
*+
* Name:
* astCmpRegionList
* Purpose:
* Decompose a CmpRegion into a sequence of simpler Regions.
* Type:
* Protected virtual function.
* Synopsis:
* #include "cmpregion.h"
* int astCmpRegionList( AstCmpRegion *this, int *nreg,
* AstRegion ***reg_list, int *status )
* Class Membership:
* CmpRegion method.
* Description:
* This function decomposes a CmpRegion into a sequence of simpler
* Regions which may be applied in sequence to achieve the same
* effect.
* Parameters:
* this
* Pointer to the CmpRegion to be decomposed (the CmpRegion is not
* actually modified by this function).
* nreg
* The address of an int which holds a count of the number of
* individual Regions in the decomposition. On entry, this
* should count the number of Regions already in the
* "*reg_list" array (below). On exit, it is updated to include
* any new Regions appended by this function.
* reg_list
* Address of a pointer to an array of Region pointers. On
* entry, this array pointer should either be NULL (if no
* Regions have yet been obtained) or should point at a
* dynamically allocated array containing Region pointers
* ("*nreg" in number) which have been obtained from a previous
* invocation of this function.
*
* On exit, the dynamic array will be enlarged to contain any
* new Region pointers that result from the decomposition
* requested. These pointers will be appended to any previously
* present, and the array pointer will be updated as necessary
* to refer to the enlarged array (any space released by the
* original array will be freed automatically).
*
* The new Region pointers returned will identify a sequence of
* Region which, when applied in order, will represent an area
* equivalent to that of the original Region.
*
* All the Region pointers returned by this function should be
* annulled by the caller, using astAnnul, when no longer
* required. The dynamic array holding these pointers should
* also be freed, using astFree.
* Returned Value:
* An integer identifying the boolean operation that should be used to
* combine the Regions returned in "reg_list". This will be AST__AND
* or AST__OR.
*-
*/
/* Local Variables: */
AstCmpRegion *cmpreg;
int add;
int result;
/* Check the global error status. */
if ( !astOK ) return AST__AND;
/* Check if this CmpRegion has an equivalent XOR representation. Is so,
store details of the XOR representation in the CmpRegion. */
XORCheck( this, status );
/* The CmpRegion class only has full support for AND and OR operators.
However, it can also represent XOR operators, but it does this by
an equivalent set of AND and OR operators. When an XOR CmpRegion is
created, the original supplied argument regions are stored in
"this->xor1" and "this->xor2", and the component Regions placed in the
new CmpRegion are actually CmpRegions that implement the equivalent
of an XOR operation, using AND and OR operators. We want to hide this
to the outside world, so if the supplied CmpRegion represents an XOR
operation, add the XOR regions to the returned list, and return an
XOR operator. */
if( this->xor1 ) {
*reg_list = astGrow( *reg_list, *nreg + 2, sizeof( AstRegion * ) );
if( astOK ) {
( *reg_list )[ (*nreg)++ ] = astClone( this->xor1 );
( *reg_list )[ (*nreg)++ ] = astClone( this->xor2 );
}
result = AST__XOR;
/* For AND and OR operators, we deal with the component Regions directly. */
} else {
/* If the first component of the supplied CmpRegion is itself a CmpRegion
that uses the same boolean operator as "this", call this function
recursively to add its component Regions to the returned list. */
add = 1;
if( astIsACmpRegion( this->region1 ) ) {
cmpreg = (AstCmpRegion *) this->region1;
if( cmpreg->oper == this->oper ) {
(void) CmpRegionList( cmpreg, nreg, reg_list, status );
add = 0;
}
}
/* Otherwise, add the component Region directly into the returned list of
Regions. */
if( add ) {
*reg_list = astGrow( *reg_list, *nreg + 1, sizeof( AstRegion * ) );
if( astOK ) {
( *reg_list )[ *nreg ] = astClone( this->region1 );
( *nreg )++;
}
}
/* Do the same for the second component region */
add = 1;
if( astIsACmpRegion( this->region2 ) ) {
cmpreg = (AstCmpRegion *) this->region2;
if( cmpreg->oper == this->oper ) {
(void) CmpRegionList( cmpreg, nreg, reg_list, status );
add = 0;
}
}
if( add ) {
*reg_list = astGrow( *reg_list, *nreg + 1, sizeof( AstRegion * ) );
if( astOK ) {
( *reg_list )[ *nreg ] = astClone( this->region2 );
( *nreg )++;
}
}
result = this->oper;
}
/* Return the boolean operator used to combine the regions in the
returned array. */
return result;
}
static void Decompose( AstMapping *this_mapping, AstMapping **map1,
AstMapping **map2, int *series, int *invert1,
int *invert2, int *status ) {
/*
*
* Name:
* Decompose
* Purpose:
* Decompose a CmpRegion into two component Regions.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void Decompose( AstMapping *this, AstMapping **map1,
* AstMapping **map2, int *series,
* int *invert1, int *invert2, int *status )
* Class Membership:
* CmpRegion member function (over-rides the protected astDecompose
* method inherited from the Mapping class).
* Description:
* This function returns pointers to two Mappings which, when applied
* either in series or parallel, are equivalent to the supplied Mapping.
*
* Since the Frame class inherits from the Mapping class, Frames can
* be considered as special types of Mappings and so this method can
* be used to decompose either CmpMaps, CmpFrames, CmpRegions or Prisms.
* Parameters:
* this
* Pointer to the Mapping.
* map1
* Address of a location to receive a pointer to first component
* Mapping.
* map2
* Address of a location to receive a pointer to second component
* Mapping.
* series
* Address of a location to receive a value indicating if the
* component Mappings are applied in series or parallel. A non-zero
* value means that the supplied Mapping is equivalent to applying map1
* followed by map2 in series. A zero value means that the supplied
* Mapping is equivalent to applying map1 to the lower numbered axes
* and map2 to the higher numbered axes, in parallel.
* invert1
* The value of the Invert attribute to be used with map1.
* invert2
* The value of the Invert attribute to be used with map2.
* status
* Pointer to the inherited status variable.
* Notes:
* - Any changes made to the component rames using the returned
* pointers will be reflected in the supplied CmpFrame.
*-
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the CmpMap structure. */
this = (AstCmpRegion *) this_mapping;
/* The components Frames of a CmpRegion are considered to be series
Mappings. */
if( series ) *series = 1;
/* The Frames are returned in their original order whether or not the
CmpRegion has been inverted. */
if( map1 ) *map1 = astClone( this->region1 );
if( map2 ) *map2 = astClone( this->region2 );
/* The invert flags dont mean anything for a Region, but we return them
anyway. If the CmpRegion has been inverted, return inverted Invert flags. */
if( astGetInvert( this ) ) {
if( invert1 ) *invert1 = astGetInvert( this->region1 ) ? 0 : 1;
if( invert2 ) *invert2 = astGetInvert( this->region2 ) ? 0 : 1;
/* If the CmpRegion has not been inverted, return the current Invert flags. */
} else {
if( invert1 ) *invert1 = astGetInvert( this->region1 );
if( invert2 ) *invert2 = astGetInvert( this->region2 );
}
}
static int Equal( AstObject *this_object, AstObject *that_object, int *status ) {
/*
* Name:
* Equal
* Purpose:
* Test if two Objects are equivalent.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* int Equal( AstObject *this_object, AstObject *that_object, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astEqual protected
* method inherited from the Region class).
* Description:
* This function returns a boolean result (0 or 1) to indicate whether
* two CmpRegions are equivalent.
* Parameters:
* this
* Pointer to the first CmpRegion.
* that
* Pointer to the second CmpRegion.
* status
* Pointer to the inherited status variable.
* Returned Value:
* One if the CmpRegions are equivalent, zero otherwise.
* Notes:
* - The CmpRegions are equivalent if their component Regions are
* equivalent and if they have the same boolean operation, negation
* and closed flags.
* - 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: */
AstCmpRegion *that;
AstCmpRegion *this;
int result;
/* Initialise. */
result = 0;
/* Check the global error status. */
if ( !astOK ) return result;
/* Invoke the Equal method inherited from the parent Region class. This checks
that the Objects are both of the same class, and have the same Negated
and Closed flags (amongst other things). */
if( (*parent_equal)( this_object, that_object, status ) ) {
/* Obtain pointers to the two CmpRegion structures. */
this = (AstCmpRegion *) this_object;
that = (AstCmpRegion *) that_object;
/* Test their first component Regions for equality. */
if( astEqual( this->region1, that->region1 ) ) {
/* Test their second component Regions for equality. */
if( astEqual( this->region2, that->region2 ) ) {
/* Test their boolean operator for equality. */
if( this->oper == that->oper ) result = 1;
}
}
}
/* If an error occurred, clear the result value. */
if ( !astOK ) result = 0;
/* Return the result, */
return result;
}
/*
* Name:
* MAKE_SET
* Purpose:
* Define a function to set an attribute value for a CmpRegion.
* Type:
* Private macro.
* Synopsis:
* #include "cmpregion.h"
* MAKE_SET(attribute,lattribute,type)
* Class Membership:
* Defined by the CmpRegion class.
* Description:
* This macro expands to an implementation of a private member function
* of the form:
*
* static void Set<Attribute>( AstRegion *this, <Type> value )
*
* that sets the value of a specified Region attribute in the parent
* Region structure and also in the component Regions.
* Parameters:
* attribute
* Name of the attribute, as it appears in the function name.
* lattribute
* Name of the attribute, all in lower case.
* type
* The C type of the attribute.
*/
/* Define the macro. */
#define MAKE_SET(attribute,lattribute,type) \
static void Set##attribute( AstRegion *this_region, type value, int *status ) { \
\
/* Local Variables: */ \
AstCmpRegion *this; /* Pointer to the CmpRegion structure */ \
\
/* Check the global error status. */ \
if ( !astOK ) return; \
\
/* Use the parent method to set the value in the parent Region structure. */ \
(*parent_set##lattribute)( this_region, value, status ); \
\
/* Also set the value in the two component Regions. */ \
this = (AstCmpRegion *) this_region; \
astSet##attribute( this->region1, value ); \
astSet##attribute( this->region2, value ); \
}
/* Use the above macro to create accessors for the MeshSize and Closed attributes. */
MAKE_SET(MeshSize,meshsize,int)
MAKE_SET(Closed,closed,int)
/* Undefine the macro. */
#undef MAKE_SET
/*
* Name:
* MAKE_CLEAR
* Purpose:
* Define a function to clear an attribute value for a CmpRegion.
* Type:
* Private macro.
* Synopsis:
* #include "cmpregion.h"
* MAKE_CLEAR(attribute,lattribute)
* Class Membership:
* Defined by the CmpRegion class.
* Description:
* This macro expands to an implementation of a private member function
* of the form:
*
* static void Clear<Attribute>( AstRegion *this )
*
* that sets the value of a specified Region attribute in the parent
* Region structure and also in the component Regions.
* Parameters:
* attribute
* Name of the attribute, as it appears in the function name.
* lattribute
* Name of the attribute, all in lower case.
*/
/* Define the macro. */
#define MAKE_CLEAR(attribute,lattribute) \
static void Clear##attribute( AstRegion *this_region, int *status ) { \
\
/* Local Variables: */ \
AstCmpRegion *this; /* Pointer to the CmpRegion structure */ \
\
/* Check the global error status. */ \
if ( !astOK ) return; \
\
/* Use the parent method to clear the value in the parent Region structure. */ \
(*parent_clear##lattribute)( this_region, status ); \
\
/* Also clear the value in the two component Regions. */ \
this = (AstCmpRegion *) this_region; \
astClear##attribute( this->region1 ); \
astClear##attribute( this->region2 ); \
}
/* Use the above macro to create accessors for the MeshSize and Closed attributes. */
MAKE_CLEAR(MeshSize,meshsize)
MAKE_CLEAR(Closed,closed)
/* Undefine the macro. */
#undef MAKE_CLEAR
static int GetBounded( AstRegion *this_region, int *status ) {
/*
* Name:
* GetBounded
* Purpose:
* Is the Region bounded?
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* int GetBounded( AstRegion *this, int *status )
* Class Membership:
* CmpRegion method (over-rides the astGetBounded method inherited from
* the Region class).
* Description:
* This function returns a flag indicating if the Region is bounded.
* The implementation provided by the base Region class is suitable
* for Region sub-classes representing the inside of a single closed
* curve (e.g. Circle, Ellipse, Box, etc). Other sub-classes (such as
* CmpRegion, PointList, etc ) may need to provide their own
* implementations.
* Parameters:
* this
* Pointer to the Region.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Non-zero if the Region is bounded. Zero otherwise.
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
AstRegion *reg1; /* Pointer to first component Region */
AstRegion *reg2; /* Pointer to second component Region */
int neg1; /* Negated flag to use with first component */
int neg2; /* Negated flag to use with second component */
int oper; /* Combination operator */
int overlap; /* Nature of overlap between components */
int reg1b; /* Is the first component Region bounded?*/
int reg2b; /* Is the second component Region bounded?*/
int result; /* Returned result */
/* Initialise */
result = 0;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* Only calculated a new value if there is no cached value in the Region. */
if( this->bounded == -INT_MAX ) {
/* Get the component Regions, how they should be combined, and the
Negated values which should be used with them. The returned values
take account of whether the supplied CmpRegion has itself been Negated
or not. The returned Regions represent regions within the base Frame
of the FrameSet encapsulated by the parent Region structure. */
GetRegions( this, ®1, ®2, &oper, &neg1, &neg2, status );
/* If the first component Region does not have the required value for
its "Negated" attribute, use the negation of "reg1" in place of "reg1"
itself. */
if( neg1 != astGetNegated( reg1 ) ) {
AstRegion *tmp = astGetNegation( reg1 );
(void) astAnnul( reg1 );
reg1 = tmp;
}
/* If the second component Region does not have the required value for
its "Negated" attribute, use the negation of "reg2" in place of "reg2"
itself. */
if( neg2 != astGetNegated( reg2 ) ) {
AstRegion *tmp = astGetNegation( reg2 );
(void) astAnnul( reg2 );
reg2 = tmp;
}
/* See if either of the component Regions is bounded. */
reg1b = astGetBounded( reg1 );
reg2b = astGetBounded( reg2 );
/* If the regions are ANDed... */
if( oper == AST__AND ) {
/* If either one of the two components are bounded, then the AND region is
bounded. */
if( reg1b || reg2b ) {
result = 1;
/* If neither of the two components is bounded, then the AND region is
unbounded if there is partial or no overlap between them and is bounded
otherwise. */
} else {
overlap = astOverlap( reg1, reg2 );
if( overlap == 1 || overlap == 4 || overlap == 6 ) {
result = 0;
} else {
result = 1;
}
}
/* If the regions are ORed... */
} else {
/* If either one of the two components is unbounded, then the OR region is
unbounded. */
if( !reg1b || !reg2b ) {
result = 0;
/* If both of the two components are bounded, then the OR region is also
bounded. */
} else {
result = 1;
}
}
/* Free resources. */
reg1 = astAnnul( reg1 );
reg2 = astAnnul( reg2 );
/* Cache the value in the CmpRegion. */
this->bounded = astOK ? result : -INT_MAX;
}
/* Return zero if an error occurred. Otherwise, return the cached value. */
if( astOK ) {
result = ( this->bounded == -INT_MAX ) ? 0 : this->bounded;
} else {
result = 0;
}
/* Return the required pointer. */
return result;
}
static double GetFillFactor( AstRegion *this_region, int *status ) {
/*
* Name:
* GetFillFactor
* Purpose:
* Obtain the value of the FillFactor attribute for a CmpRegion.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* double GetFillFactor( AstRegion *this, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astGetFillFactor method inherited
* from the Region class).
* Description:
* This function returns the value of the FillFactor attribute for a
* CmpRegion. A suitable default value is returned if no value has
* previously been set.
* Parameters:
* this
* Pointer to the CmpRegion.
* status
* Pointer to the inherited status variable.
* Returned Value:
* The FillFactor value to use.
*/
/* Local Variables: */
AstCmpRegion *this;
double result;
/* Check the global error status. */
if ( !astOK ) return AST__BAD;
/* Initialise. */
result = AST__BAD;
/* Obtain a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* See if a FillFactor value has been set. If so, use the parent
astGetFillFactor method to obtain it. */
if ( astTestFillFactor( this ) ) {
result = (*parent_getfillfactor)( this_region, status );
/* Otherwise, we will generate a default value equal to the FillFactor values
of the first component Region. */
} else {
result = astGetFillFactor( this->region1 );
}
/* If an error occurred, clear the returned value. */
if ( !astOK ) result = AST__BAD;
/* 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 "cmpregion.h"
* int GetObjSize( AstObject *this, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astGetObjSize protected
* method inherited from the parent class).
* Description:
* This function returns the in-memory size of the supplied CmpRegion,
* in bytes.
* Parameters:
* this
* Pointer to the CmpRegion.
* 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: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
int result; /* Result value to return */
/* Initialise. */
result = 0;
/* Check the global error status. */
if ( !astOK ) return result;
/* Obtain a pointers to the CmpRegion structure. */
this = (AstCmpRegion *) this_object;
/* Invoke the GetObjSize method inherited from the parent class, and then
add on any components of the class structure defined by this class
which are stored in dynamically allocated memory. */
result = (*parent_getobjsize)( this_object, status );
result += astGetObjSize( this->region1 );
result += astGetObjSize( this->region2 );
if( this->xor1 ) result += astGetObjSize( this->xor1 );
if( this->xor2 ) result += astGetObjSize( this->xor2 );
/* If an error occurred, clear the result value. */
if ( !astOK ) result = 0;
/* Return the result, */
return result;
}
static void GetRegions( AstCmpRegion *this, AstRegion **reg1, AstRegion **reg2,
int *oper, int *neg1, int *neg2, int *status ) {
/*
*
* Name:
* GetRegions
* Purpose:
* Get the component Regions of a CmpRegion.
* Type:
* Private function.
* Synopsis:
* #include "region.h"
* void GetRegions( AstCmpRegion *this, AstRegion **reg1, AstRegion **reg2,
* int *oper, int *neg1, int *neg2, int *status )
* Class Membership:
* CmpRegion member function
* Description:
* This function returns pointers to two Regions which, when applied
* using the returned boolean operator, are equivalent to the supplied
* Region. If the CmpRegion has been negated, then the returned operator
* and "negated" flags will be set such that they represent the
* negated CmpRegion.
*
* The current Frames in both the returned component Regions will be
* equivalent to the base Frame in the FrameSet encapsulated by the
* parent Region structure.
* Parameters:
* this
* Pointer to the CmpRegion.
* reg1
* Address of a location to receive a pointer to first component
* Region. The current Frame in this region will be equivalent to
* the base Frame in the FrameSet
* reg2
* Address of a location to receive a pointer to second component
* Region.
* oper
* Address of a location to receive a value indicating how the
* component Regions are combined together. This will be one of
* AST__AND or AST__OR
* neg1
* The value of the Negated attribute to be used with reg1.
* neg2
* The value of the Negated attribute to be used with reg2.
* status
* Pointer to the inherited status variable.
* Notes:
* - Any changes made to the component Regions using the returned
* pointers will be reflected in the supplied CmpRegion.
*-
*/
/* Initialise */
if( reg1 ) *reg1 = NULL;
if( reg2 ) *reg2 = NULL;
/* Check the global error status. */
if ( !astOK ) return;
/* Return the component Region pointers. */
if( reg1 ) *reg1 = astClone( this->region1 );
if( reg2 ) *reg2 = astClone( this->region2 );
/* Initialise the other returned items. Note, the CmpRegion initialiser
stored a deep copy of the supplied component Regions, and so we do not
need to worry about attributes of the components having been changed
after the creation of the CmpRegion. This is different to the CmpMap
class which merely clones its supplied component pointers and so has
to save copies of the original Invert settings within the CmpMap
structure. */
if( oper ) *oper = this->oper;
if( neg1 ) *neg1 = astGetNegated( this->region1 );
if( neg2 ) *neg2 = astGetNegated( this->region2 );
/* If the CmpRegion has been inverted, we modify the boolean operator and
negation flags so that they reflect the inverted CmpRegion. */
if( astGetNegated( this ) ) {
/* If the component Regions are combined using AND, then the negated
CmpRegion combines its negated components using OR. */
if( this->oper == AST__AND ){
if( oper ) *oper = AST__OR;
if( neg1 ) *neg1 = *neg1 ? 0 : 1;
if( neg2 ) *neg2 = *neg2 ? 0 : 1;
/* If the component Regions are combined using OR, then the negated CmpRegion
combines its negated components using AND. */
} else if( this->oper == AST__OR ){
if( oper ) *oper = AST__AND;
if( neg1 ) *neg1 = *neg1 ? 0 : 1;
if( neg2 ) *neg2 = *neg2 ? 0 : 1;
} else if( astOK ) {
astError( AST__INTER, "GetRegions(%s): The %s refers to an unknown "
"boolean operator with identifier %d (internal AST "
"programming error).", status, astGetClass( this ),
astGetClass( this ), this->oper );
}
}
}
static AstRegion *GetDefUnc( AstRegion *this_region, int *status ) {
/*
* Name:
* GetDefUnc
* Purpose:
* Obtain a pointer to the default uncertainty Region for a given Region.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* AstRegion *GetDefUnc( AstRegion *this )
* Class Membership:
* CmpRegion method (over-rides the astGetDefUnc method inherited from
* the Region class).
* This function returns a pointer to a Region which represents the
* default uncertainty associated with a position on the boundary of the
* given Region. The returned Region refers to the base Frame within the
* FrameSet encapsulated by the supplied Region.
* Parameters:
* this
* Pointer to the Region.
* Returned Value:
* A pointer to the Region. This should be annulled (using astAnnul)
* when no longer needed.
* 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: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
AstRegion *result; /* Returned pointer */
/* Initialise */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* If the first component region has non-default uncertainty, use it as
the default uncertainty for the CmpRegion. Note, the current Frame of
an uncertainty Region is assumed to be the same as the base Frame in the
CmpRegion. */
if( astTestUnc( this->region1 ) ) {
result = astGetUncFrm( this->region1, AST__CURRENT );
/* Otherwise, if the second component region has non-default uncertainty,
use it as the default uncertainty for the CmpRegion. */
} else if( astTestUnc( this->region2 ) ) {
result = astGetUncFrm( this->region2, AST__CURRENT );
/* Otherwise, use the parent method to determine the default uncertainty. */
} else {
result = (* parent_getdefunc)( this_region, status );
}
/* Return NULL if an error occurred. */
if( !astOK ) result = astAnnul( result );
/* Return the required pointer. */
return result;
}
void astInitCmpRegionVtab_( AstCmpRegionVtab *vtab, const char *name, int *status ) {
/*
*+
* Name:
* astInitCmpRegionVtab
* Purpose:
* Initialise a virtual function table for a CmpRegion.
* Type:
* Protected function.
* Synopsis:
* #include "cmpregion.h"
* void astInitCmpRegionVtab( AstCmpRegionVtab *vtab, const char *name )
* Class Membership:
* CmpRegion vtab initialiser.
* Description:
* This function initialises the component of a virtual function
* table which is used by the CmpRegion 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 */
AstMappingVtab *mapping; /* Pointer to Mapping component of Vtab */
AstObjectVtab *object; /* Pointer to Object component of Vtab */
AstRegionVtab *region; /* Pointer to Region 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. */
astInitRegionVtab( (AstRegionVtab *) vtab, name );
/* Store a unique "magic" value in the virtual function table. This
will be used (by astIsACmpRegion) 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 = &(((AstRegionVtab *) vtab)->id);
/* Initialise member function pointers. */
/* ------------------------------------ */
/* Store pointers to the member functions (implemented here) that
provide virtual methods for this class. */
vtab->CmpRegionList = CmpRegionList;
/* Save the inherited pointers to methods that will be extended, and
replace them with pointers to the new member functions. */
object = (AstObjectVtab *) vtab;
mapping = (AstMappingVtab *) vtab;
region = (AstRegionVtab *) vtab;
parent_transform = mapping->Transform;
mapping->Transform = Transform;
parent_simplify = mapping->Simplify;
mapping->Simplify = Simplify;
parent_getdefunc = region->GetDefUnc;
region->GetDefUnc = GetDefUnc;
parent_setregfs = region->SetRegFS;
region->SetRegFS = SetRegFS;
parent_resetcache = region->ResetCache;
region->ResetCache = ResetCache;
parent_equal = object->Equal;
object->Equal = Equal;
parent_getobjsize = object->GetObjSize;
object->GetObjSize = GetObjSize;
#if defined(THREAD_SAFE)
parent_managelock = object->ManageLock;
object->ManageLock = ManageLock;
#endif
parent_clearclosed = region->ClearClosed;
region->ClearClosed = ClearClosed;
parent_clearmeshsize = region->ClearMeshSize;
region->ClearMeshSize = ClearMeshSize;
parent_setclosed = region->SetClosed;
region->SetClosed = SetClosed;
parent_setmeshsize = region->SetMeshSize;
region->SetMeshSize = SetMeshSize;
parent_getfillfactor = region->GetFillFactor;
region->GetFillFactor = GetFillFactor;
parent_regsetattrib = region->RegSetAttrib;
region->RegSetAttrib = RegSetAttrib;
parent_regclearattrib = region->RegClearAttrib;
region->RegClearAttrib = RegClearAttrib;
/* Store replacement pointers for methods which will be over-ridden by
new member functions implemented here. */
mapping->Decompose = Decompose;
region->RegBaseBox = RegBaseBox;
region->RegBaseBox2 = RegBaseBox2;
region->RegBaseMesh = RegBaseMesh;
region->RegSplit = RegSplit;
region->RegPins = RegPins;
region->RegTrace = RegTrace;
region->GetBounded = GetBounded;
region->RegBasePick = RegBasePick;
/* Declare the copy constructor, destructor and class dump function. */
astSetCopy( vtab, Copy );
astSetDelete( vtab, Delete );
astSetDump( vtab, Dump, "CmpRegion", "Combination of two Regions" );
/* 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) );
}
}
#if defined(THREAD_SAFE)
static int ManageLock( AstObject *this_object, int mode, int extra,
AstObject **fail, int *status ) {
/*
* Name:
* ManageLock
* Purpose:
* Manage the thread lock on an Object.
* Type:
* Private function.
* Synopsis:
* #include "object.h"
* AstObject *ManageLock( AstObject *this, int mode, int extra,
* AstObject **fail, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astManageLock protected
* method inherited from the parent class).
* Description:
* This function manages the thread lock on the supplied Object. The
* lock can be locked, unlocked or checked by this function as
* deteremined by parameter "mode". See astLock for details of the way
* these locks are used.
* Parameters:
* this
* Pointer to the Object.
* mode
* An integer flag indicating what the function should do:
*
* AST__LOCK: Lock the Object for exclusive use by the calling
* thread. The "extra" value indicates what should be done if the
* Object is already locked (wait or report an error - see astLock).
*
* AST__UNLOCK: Unlock the Object for use by other threads.
*
* AST__CHECKLOCK: Check that the object is locked for use by the
* calling thread (report an error if not).
* extra
* Extra mode-specific information.
* fail
* If a non-zero function value is returned, a pointer to the
* Object that caused the failure is returned at "*fail". This may
* be "this" or it may be an Object contained within "this". Note,
* the Object's reference count is not incremented, and so the
* returned pointer should not be annulled. A NULL pointer is
* returned if this function returns a value of zero.
* status
* Pointer to the inherited status variable.
* Returned Value:
* A local status value:
* 0 - Success
* 1 - Could not lock or unlock the object because it was already
* locked by another thread.
* 2 - Failed to lock a POSIX mutex
* 3 - Failed to unlock a POSIX mutex
* 4 - Bad "mode" value supplied.
* Notes:
* - This function attempts to execute even if an error has already
* occurred.
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
int result; /* Returned status value */
/* Initialise */
result = 0;
/* Check the supplied pointer is not NULL. */
if( !this_object ) return result;
/* Obtain a pointers to the CmpRegion structure. */
this = (AstCmpRegion *) this_object;
/* Invoke the ManageLock method inherited from the parent class. */
if( !result ) result = (*parent_managelock)( this_object, mode, extra,
fail, status );
/* Invoke the astManageLock method on any Objects contained within
the supplied Object. */
if( !result ) result = astManageLock( this->region1, mode, extra, fail );
if( !result ) result = astManageLock( this->region2, mode, extra, fail );
return result;
}
#endif
static AstRegion *MatchRegion( AstRegion *this, int ifrm, AstRegion *that,
const char *method, int *status ) {
/*
* Name:
* MatchRegion
* Purpose:
* Map a Region into the Frame of another Region.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* AstRegion *MatchRegion( AstRegion *this, int ifrm, AstRegion *that,
* const char *method, int *status )
* Class Membership:
* CmpRegion method.
* Description:
* This function returns a pointer to a new Region which is a copy of
* "that" mapped into either the base or current Frame of "this".
* Parameters:
* this
* Pointer to a Region defining the Frame of the returned Region.
* ifrm
* The index of a Frame within the FrameSet encapsulated by "this".
* The returned Region will refer to the requested Frame. It should
* be either AST__CURRENT or AST__BASE.
* that
* Pointer to a Region defining the shape and extent of the
* returned Region.
* method
* Pointer to a string holding the calling method.This is only used
* in error messages.
* status
* Pointer to the inherited status variable.
* Returned Value:
* A pointer to a new Region. This should be annulled (using astAnnul)
* when no longer needed.
* 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: */
AstFrame *frm; /* Current Frame from "fs" */
AstFrameSet *fs; /* FrameSet connecting that to this */
AstMapping *map; /* Base->Current Mapping from "fs" */
AstRegion *result; /* Returned pointer */
/* Initialise */
result = NULL;
/* Check the global error status. Also return NULL if no Regions were
supplied. */
if ( !astOK || !this || !that ) return result;
/* Temporarily invert "this" if we are matching its base Frame (since the
astConvert method matches current Frames). */
if( ifrm == AST__BASE ) astInvert( this );
/* Find a FrameSet connecting the current Frames of the two Regions */
fs = astConvert( that, this, "" );
/* Re-instate the original Frame indices in "this" if required. */
if( ifrm == AST__BASE ) astInvert( this );
/* Check a conversion path was found. */
if( fs ) {
/* Get the Frame and Mapping form the FrameSet. */
frm = astGetFrame( fs, AST__CURRENT );
map = astGetMapping( fs, AST__BASE, AST__CURRENT );
/* Re-map the Region. */
result = astMapRegion( that, map, frm );
/* Free resources. */
frm = astAnnul( frm );
map = astAnnul( map );
fs = astAnnul( fs );
/* Report an error if there is no conversion between the two Frames. */
} else {
astError( AST__INTER, "%s(%s): MatchRegion cannot convert between "
"the two supplied coordinate Frames (internal AST "
"programming error).", status, method, astGetClass( this ) );
}
/* Annul the returned pointer if an error has occurred. */
if( !astOK ) result = astAnnul( result );
/* Return the result. */
return result;
}
static void RegBaseBox( AstRegion *this_region, double *lbnd, double *ubnd, int *status ){
/*
* Name:
* RegBaseBox
* Purpose:
* Returns the bounding box of an un-negated Region in the base Frame of
* the encapsulated FrameSet.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void RegBaseBox( AstRegion *this, double *lbnd, double *ubnd, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astRegBaseBox protected
* method inherited from the Region class).
* Description:
* This function returns the upper and lower axis bounds of a Region in
* the base Frame of the encapsulated FrameSet, assuming the Region
* has not been negated. That is, the value of the Negated attribute
* is ignored.
* Parameters:
* this
* Pointer to the Region.
* lbnd
* Pointer to an array in which to return the lower axis bounds
* covered by the Region in the base Frame of the encapsulated
* FrameSet. It should have at least as many elements as there are
* axes in the base Frame.
* ubnd
* Pointer to an array in which to return the upper axis bounds
* covered by the Region in the base Frame of the encapsulated
* FrameSet. It should have at least as many elements as there are
* axes in the base Frame.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
AstPointSet *ps; /* Mesh pointset */
AstRegion *reg1; /* Pointer to first component Region */
AstRegion *reg2; /* Pointer to second component Region */
double **ptr; /* Pointer to mesh data */
double *clbnd1; /* Point to 1st comp lower bounds array */
double *clbnd2; /* Point to 2nd comp lower bounds array */
double *cubnd1; /* Point to 1st comp upper bounds array */
double *cubnd2; /* Point to 2nd comp upper bounds array */
double *p; /* Pointer to next coordinate value */
double lb; /* Lower limit */
double ub; /* Upper limit */
int i; /* Axis index */
int icoord; /* Coordinate index */
int inc1; /* First component interval is included? */
int inc2; /* Second component interval is included? */
int ipoint; /* Point index */
int nax; /* Number of axes in Frame */
int ncoord; /* Number of coords */
int neg1; /* First component negated? */
int neg2; /* Second component negated? */
int npoint; /* Number of points */
/* Check the global error status. */
if ( !astOK ) return;
/* Get a pointer to the CmpRegion structure */
this = (AstCmpRegion *) this_region;
/* If the CmpRegion is bounded, we find the bounding box using a mesh of
points spread evenly over the boundary of the CmpRegion. */
if( astGetBounded( this ) ) {
ps = astRegBaseMesh( this_region );
ptr = astGetPoints( ps );
ncoord = astGetNcoord( ps );
npoint = astGetNpoint( ps );
if( astOK ) {
for( icoord = 0; icoord < ncoord; icoord++ ) {
lbnd[ icoord ] = DBL_MAX;
ubnd[ icoord ] = -DBL_MAX;
p = ptr[ icoord ];
for( ipoint = 0; ipoint < npoint; ipoint++, p++ ) {
if( *p != AST__BAD ) {
if( *p < lbnd[ icoord ] ) lbnd[ icoord ] = *p;
if( *p > ubnd[ icoord ] ) ubnd[ icoord ] = *p;
}
}
}
}
ps = astAnnul( ps );
/* If the CmpRegion is not bounded we look at each axis individually. */
} else {
/* Get pointers to the component Regions. */
reg1 = this->region1;
reg2 = this->region2;
/* Get their negated flags */
neg1 = astGetNegated( reg1 );
neg2 = astGetNegated( reg2 );
/* The base Frame of the parent Region structure is the current Frame of
the component Regions. Get the no. of axes in this Frame. */
nax = astGetNaxes( reg1 );
/* Get the bounding boxes of the component Regions in this Frame. */
clbnd1 = astMalloc( sizeof( double )*(size_t) nax );
cubnd1 = astMalloc( sizeof( double )*(size_t) nax );
clbnd2 = astMalloc( sizeof( double )*(size_t) nax );
cubnd2 = astMalloc( sizeof( double )*(size_t) nax );
if( astOK ) {
astGetRegionBounds( reg1, clbnd1, cubnd1 );
astGetRegionBounds( reg2, clbnd2, cubnd2 );
/* Loop round every axis. */
for( i = 0; i < nax; i++ ) {
/* If the first component Region has been negated, the lower and upper
bounds from the first component are the bounds of an *excluded* axis
interval, not an included interval. If either of the bounds are
infinite, we can swap it to an included interval. If both bounds are
finite, we cannot convert to an included interval. In this case, we
assume that the gap will be filled at some point on another axis, if
there is more than 1 axis, and convert it to an unbouded included
interval. */
inc1 = 1;
if( neg1 ) {
lb = clbnd1[ i ];
ub = cubnd1[ i ];
if( lb == -DBL_MAX ) clbnd1[ i ] = ub;
if( ub == DBL_MAX ) cubnd1[ i ] = lb;
if( lb != -DBL_MAX && ub != DBL_MAX ) {
if( nax == 1 ) {
inc1 = 0;
} else {
clbnd1[ i ] = -DBL_MAX;
cubnd1[ i ] = DBL_MAX;
}
}
}
/* Likewise attempt to convert an excluded interval into an included
interval for the second component Region. */
inc2 = 1;
if( neg2 ) {
lb = clbnd2[ i ];
ub = cubnd2[ i ];
if( lb == -DBL_MAX ) clbnd2[ i ] = ub;
if( ub == DBL_MAX ) cubnd2[ i ] = lb;
if( lb != -DBL_MAX && ub != DBL_MAX ) {
if( nax == 1 ) {
inc2 = 0;
} else {
clbnd2[ i ] = -DBL_MAX;
cubnd2[ i ] = DBL_MAX;
}
}
}
/* If the component Regions are combined using AND, find the overlap of
the axis intervals. This depends on whether the intervals are included
or excluded. */
if( this->oper == AST__AND ) {
if( inc1 ) {
if( inc2 ) {
lbnd[ i ] = astMAX( clbnd1[ i ], clbnd2[ i ] );
ubnd[ i ] = astMIN( cubnd1[ i ], cubnd2[ i ] );
} else {
lbnd[ i ] = clbnd1[ i ] < clbnd2[ i ] ? clbnd1[ i ] : cubnd2[ i ];
ubnd[ i ] = cubnd1[ i ] > cubnd2[ i ] ? cubnd1[ i ] : clbnd2[ i ];
}
} else {
if( inc2 ) {
lbnd[ i ] = clbnd2[ i ] < clbnd1[ i ] ? clbnd2[ i ] : cubnd1[ i ];
ubnd[ i ] = cubnd2[ i ] > cubnd1[ i ] ? cubnd2[ i ] : clbnd1[ i ];
} else {
lbnd[ i ] = clbnd1[ i ] < clbnd2[ i ] ? clbnd1[ i ] : cubnd2[ i ];
ubnd[ i ] = cubnd1[ i ] > cubnd2[ i ] ? cubnd1[ i ] : clbnd2[ i ];
}
}
/* If the component Regions are not combined using AND, find the union of
the axis intervals. */
} else {
if( inc1 && inc2 ) {
lbnd[ i ] = astMIN( clbnd1[ i ], clbnd2[ i ] );
ubnd[ i ] = astMAX( cubnd1[ i ], cubnd2[ i ] );
} else {
lbnd[ i ] = -DBL_MAX;
ubnd[ i ] = DBL_MAX;
}
}
}
}
/* Free resources. */
clbnd1 = astFree( clbnd1 );
cubnd1 = astFree( cubnd1 );
clbnd2 = astFree( clbnd2 );
cubnd2 = astFree( cubnd2 );
}
}
static void RegBaseBox2( AstRegion *this_region, double *lbnd, double *ubnd, int *status ){
/*
* Name:
* RegBaseBox2
* Purpose:
* Returns the bounding box of an un-negated Region in the base Frame of
* the encapsulated FrameSet.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void RegBaseBox2( AstRegion *this, double *lbnd, double *ubnd, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astRegBaseBox2 protected
* method inherited from the Region class).
* Description:
* This function is similar to astRegBaseBox in that it returns the
* upper and lower axis bounds of a Region in the base Frame of the
* encapsulated FrameSet. But, in addition to assuming that the
* supplied Region has not been negated, it also assumes that any
* component Regions contained within the supplied Region have not been
* negated.
* Parameters:
* this
* Pointer to the Region.
* lbnd
* Pointer to an array in which to return the lower axis bounds
* covered by the Region in the base Frame of the encapsulated
* FrameSet. It should have at least as many elements as there are
* axes in the base Frame.
* ubnd
* Pointer to an array in which to return the upper axis bounds
* covered by the Region in the base Frame of the encapsulated
* FrameSet. It should have at least as many elements as there are
* axes in the base Frame.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
AstRegion *reg1; /* Pointer to first component Region */
AstRegion *reg2; /* Pointer to second component Region */
double *clbnd1; /* Point to 1st comp lower bounds array */
double *clbnd2; /* Point to 2nd comp lower bounds array */
double *cubnd1; /* Point to 1st comp upper bounds array */
double *cubnd2; /* Point to 2nd comp upper bounds array */
int i; /* Axis index */
int nax; /* Number of axes in Frame */
/* Check the global error status. */
if ( !astOK ) return;
/* Get a pointer to the CmpRegion structure */
this = (AstCmpRegion *) this_region;
/* Get pointers to the component Regions. */
reg1 = this->region1;
reg2 = this->region2;
/* The base Frame of the parent Region structure is the current Frame of
the component Regions. Get the no. of axes in this Frame. */
nax = astGetNaxes( reg1 );
/* Get the bounding boxes of the component Regions in this Frame. */
clbnd1 = astMalloc( sizeof( double )*(size_t) nax );
cubnd1 = astMalloc( sizeof( double )*(size_t) nax );
clbnd2 = astMalloc( sizeof( double )*(size_t) nax );
cubnd2 = astMalloc( sizeof( double )*(size_t) nax );
if( astOK ) {
astGetRegionBounds2( reg1, clbnd1, cubnd1 );
astGetRegionBounds2( reg2, clbnd2, cubnd2 );
/* How we combine the two bounding boxes depends on the boolean operator
associated with this CmpRegion. For AND find the overlap of the two
bounding boxes. For other operators find the union. */
if( this->oper == AST__AND ) {
for( i = 0; i < nax; i++ ) {
lbnd[ i ]= astMAX( clbnd1[ i ], clbnd2[ i ] );
ubnd[ i ]= astMIN( cubnd1[ i ], cubnd2[ i ] );
}
} else {
for( i = 0; i < nax; i++ ) {
lbnd[ i ]= astMIN( clbnd1[ i ], clbnd2[ i ] );
ubnd[ i ]= astMAX( cubnd1[ i ], cubnd2[ i ] );
}
}
}
/* Free resources. */
clbnd1 = astFree( clbnd1 );
cubnd1 = astFree( cubnd1 );
clbnd2 = astFree( clbnd2 );
cubnd2 = astFree( cubnd2 );
}
static AstPointSet *RegBaseMesh( AstRegion *this_region, int *status ){
/*
* Name:
* RegBaseMesh
* Purpose:
* Return a PointSet containing a mesh of points on the boundary of a
* Region in its base Frame.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* AstPointSet *astRegBaseMesh( AstRegion *this, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astRegBaseMesh protected
* method inherited from the Region class).
* Description:
* This function returns a PointSet containing a mesh of points on the
* boundary of the Region. The points refer to the base Frame of
* the encapsulated FrameSet.
* Parameters:
* this
* Pointer to the Region.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to the PointSet. Annul the pointer using astAnnul when it
* is no longer needed.
* Notes:
* - A NULL pointer is returned if an error has already occurred, or if
* this function should fail for any reason.
*/
/* Local Variables: */
AstCmpRegion *this; /* The CmpRegion structure */
AstPointSet *mesh1; /* PointSet holding mesh for 1st component */
AstPointSet *mesh1b; /* Mesh for 1st component mapped by 2nd comp. */
AstPointSet *mesh2; /* PointSet holding mesh for 2nd component */
AstPointSet *mesh2b; /* Mesh for 2nd component mapped by 1st comp. */
AstPointSet *result; /* Returned pointer */
AstRegion *reg1; /* Pointer to first component Region */
AstRegion *reg2; /* Pointer to second component Region */
double **ptr1; /* Pointer to array of mesh1b axis value pointers */
double **ptr2; /* Pointer to array of mesh2b axis value pointers */
double **ptr; /* Pointer to array of total axis value pointers */
double *lbnd; /* Pointer to array of bounding box lower bounds */
double *ubnd; /* Pointer to array of bounding box upper bounds */
double v; /* Axis value */
int hasMesh1; /* Does 1st component Region have a mesh? */
int hasMesh2; /* Does 2nd component Region have a mesh? */
int ic; /* Axis index */
int ip; /* Input point index */
int jp; /* Output point index */
int nc; /* No. of axis values per point */
int np1; /* No. of points in mesh1b */
int np2; /* No. of points in mesh2b */
int np; /* No. of points in returned PointSet */
int ok; /* Were all axis values good at this point? */
/* Initialise */
result= NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* If the Region structure contains a pointer to a PointSet holding
a previously created mesh, return it. */
if( this_region->basemesh ) {
result = astClone( this_region->basemesh );
/* Otherwise, create a new mesh. */
} else {
/* Get pointers to the component regions. */
reg1 = this->region1;
reg2 = this->region2;
/* A mesh can only be produced for a Region if it is bounded when either
negated or un-negated. See if meshes can be produced for the component
Regions. */
hasMesh1 = astGetBounded( reg1 );
if( !hasMesh1 ){
astNegate( reg1 );
hasMesh1 = astGetBounded( reg1 );
astNegate( reg1 );
}
hasMesh2 = astGetBounded( reg2 );
if( !hasMesh2 ){
astNegate( reg2 );
hasMesh2 = astGetBounded( reg2 );
astNegate( reg2 );
}
/* If neither Region has a mesh we cannot produce a mesh. */
if( !hasMesh1 && !hasMesh2 && astOK ) {
astError( AST__INTER, "astRegBaseMesh(%s): No mesh can be "
"produced for the %s bacause neither of its component "
"Regions has a mesh (internal AST programming error).", status,
astGetClass( this ), astGetClass( this ) );
/* If only one Region has a mesh, we can produce a mesh so long as the
boolean operator is not OR. */
} else if( ( !hasMesh1 || !hasMesh2 ) && this->oper == AST__OR && astOK ) {
astError( AST__INTER, "astRegBaseMesh(%s): No mesh can be produced "
"for the %s bacause one its component Regions has no "
"mesh and the union of the Regions is required (internal "
"AST programming error).", status, astGetClass( this ), astGetClass( this ) );
}
/* Allocate memory to hold a bounding box in the base Frame of the CmpRegion. */
nc = astGetNin( this_region->frameset );
lbnd = astMalloc( sizeof( double )*(size_t) nc );
ubnd = astMalloc( sizeof( double )*(size_t) nc );
/* Get current Frame meshes covering the two component Regions (the current
Frame of the component Regions is the same as the base Frame of the parent
Region). We now know that at least one Region has a mesh. If the other
one does not have a mesh we may be able to create a mesh by taking the
intersection of the Region with the bounding box of the bounded Region. */
if( hasMesh1 ) {
mesh1 = astRegMesh( reg1 );
if( hasMesh2 ) {
mesh2 = astRegMesh( reg2 );
} else {
astGetRegionBounds( reg1, lbnd, ubnd );
mesh2 = astBndMesh( reg2, lbnd, ubnd );
}
} else {
mesh2 = astRegMesh( reg2 );
astGetRegionBounds( reg2, lbnd, ubnd );
mesh1 = astBndMesh( reg1, lbnd, ubnd );
}
/* If the CmpRegion represents the intersection of the two component Regions
(AND operator), the total mesh is the sum of the component mesh points
which are inside the other component region. If the CmpRegion represents
the union of the two component Regions (OR operator), the total mesh is
the sum of the component mesh points which are outside the other component
region. So temporarily negate the component Regions if they are
combined using OR. */
if( this->oper == AST__OR ) {
astNegate( reg1 );
astNegate( reg2 );
}
/* Transform the mesh for the first component using the second component
as a Mapping. Mesh points outside (or inside if "oper" is OR) the bounds
of the second component will be set bad. */
mesh1b = astTransform( reg2, mesh1, 1, NULL );
/* Transform the mesh for the second component using the first component
as a Mapping. Mesh points outside (or inside if "oper" is OR) the bounds
of the first component will be set bad. */
mesh2b = astTransform( reg1, mesh2, 1, NULL );
/* If required, negate them again to bring them back to their original state.*/
if( this->oper == AST__OR ) {
astNegate( reg1 );
astNegate( reg2 );
}
/* The required mesh contains all the good points form both mesh1b and
mesh2b (i.e. all boundary points which are inside -or inside if "oper"
is OR- the other component Region). Create a PointSet assuming that all
points are good. First allocate an array to hold pointers to the arrays
holding coordinate values for each axis. */
nc = astGetNcoord( mesh1b );
np1 = astGetNpoint( mesh1b );
np2 = astGetNpoint( mesh2b );
np = np1 + np2;
result = astPointSet( np, nc, "", status );
ptr = astGetPoints( result );
/* Get points to the axis values of the mapped meshes. */
ptr1 = astGetPoints( mesh1b );
ptr2 = astGetPoints( mesh2b );
/* Check pointers can be used safely. */
if( astOK ) {
/* Initialise the index of the next point in the total mesh. */
jp = 0;
/* Loop round all the points in the transformed mesh for the first
component. */
for( ip = 0; ip < np1; ip++ ) {
/* Assume this point has good axis values */
ok = 1;
/* Copy the axis values into the total mesh. Break if a bad axis value is
found. */
for( ic = 0; ic < nc; ic++ ) {
v = ptr1[ ic ][ ip ];
if( v != AST__BAD ) {
ptr[ ic ][ jp ] = v;
} else {
ok = 0;
break;
}
}
/* If no bad axis values were found, increment the index of the next
point in the total mesh. */
if( ok ) jp++;
}
/* Now similarly copy the good values from the second transformed mesh onto
the end of the total mesh array. */
for( ip = 0; ip < np2; ip++ ) {
ok = 1;
for( ic = 0; ic < nc; ic++ ) {
v = ptr2[ ic ][ ip ];
if( v != AST__BAD ) {
ptr[ ic ][ jp ] = v;
} else {
ok = 0;
break;
}
}
if( ok ) jp++;
}
/* If the total mesh contains no good points, we will create a PointSet
holding a single bad position. */
if( jp == 0 ) {
np = 1;
for( ic = 0; ic < nc; ic++ ) ptr[ ic ][ 0 ] = AST__BAD;
} else {
np = jp;
}
/* Adjust the size of the returned PointSet to exclude the extra space
caused by any axis values being bad in the transformed meshes. */
astSetNpoint( result, np );
}
/* Free resources. */
mesh1 = astAnnul( mesh1 );
mesh2 = astAnnul( mesh2 );
mesh1b = astAnnul( mesh1b );
mesh2b = astAnnul( mesh2b );
lbnd = astFree( lbnd );
ubnd = astFree( ubnd );
/* Save the returned pointer in the Region structure so that it does not
need to be created again next time this function is called. */
if( astOK && result ) this_region->basemesh = astClone( result );
}
/* Annul the result if an error has occurred. */
if( !astOK ) result = astAnnul( result );
/* Return a pointer to the output PointSet. */
return result;
}
static AstRegion *RegBasePick( AstRegion *this_region, int naxes,
const int *axes, int *status ){
/*
* Name:
* RegBasePick
* Purpose:
* Return a Region formed by picking selected base Frame axes from the
* supplied Region.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* AstRegion *RegBasePick( AstRegion *this, int naxes, const int *axes,
* int *status )
* Class Membership:
* CmpRegion member function (over-rides the astRegBasePick protected
* method inherited from the Region class).
* Description:
* This function attempts to return a Region that is spanned by selected
* axes from the base Frame of the encapsulated FrameSet of the supplied
* Region. This may or may not be possible, depending on the class of
* Region. If it is not possible a NULL pointer is returned.
* Parameters:
* this
* Pointer to the Region.
* naxes
* The number of base Frame axes to select.
* axes
* An array holding the zero-based indices of the base Frame axes
* that are to be selected.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to the Region, or NULL if no region can be formed.
* Notes:
* - A NULL pointer is returned if an error has already occurred, or if
* this function should fail for any reason.
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to CmpRegion structure */
AstFrame *frm1; /* Axes picked from the 1st encapsulated Region */
AstFrame *frm2; /* Axes picked from the 2nd encapsulated Region */
AstRegion *result; /* Returned Region */
/* Initialise */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get a pointer to the CmpRegion information. */
this = (AstCmpRegion *) this_region;
/* Both encapsulated regions refer to the same Frame (the base Frame of
the parent Region), so attempt to pick the requested axs from them.
If the resulting Frames are not Regions, we cannot pick the requested
axes so return the NULL Frame pointer initialised above. */
frm1 = astPickAxes( this->region1, naxes, axes, NULL );
if( astIsARegion( frm1 ) ) {
frm2 = astPickAxes( this->region2, naxes, axes, NULL );
if( astIsARegion( frm2 ) ) {
/* Create the new CmpRegion. */
result = (AstRegion *) astCmpRegion( (AstRegion *) frm1,
(AstRegion *) frm2,
this->oper, "", status );
}
/* Free resources */
frm2 = astAnnul( frm2 );
}
frm1 = astAnnul( frm1 );
/* Return a NULL pointer if an error has occurred. */
if( !astOK ) result = astAnnul( result );
/* Return the result. */
return result;
}
static int RegPins( AstRegion *this_region, AstPointSet *pset, AstRegion *unc,
int **mask, int *status ){
/*
* Name:
* RegPins
* Purpose:
* Check if a set of points fall on the boundary of a given CmpRegion.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* int RegPins( AstRegion *this, AstPointSet *pset, AstRegion *unc,
* int **mask, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astRegPins protected
* method inherited from the Region class).
* Description:
* This function returns a flag indicating if the supplied set of
* points all fall on the boundary of the given CmpRegion.
*
* Some tolerance is allowed, as specified by the uncertainty Region
* stored in the supplied CmpRegion "this", and the supplied uncertainty
* Region "unc" which describes the uncertainty of the supplied points.
* Parameters:
* this
* Pointer to the CmpRegion.
* pset
* Pointer to the PointSet. The points are assumed to refer to the
* base Frame of the FrameSet encapsulated by "this".
* unc
* Pointer to a Region representing the uncertainties in the points
* given by "pset". The Region is assumed to represent the base Frame
* of the FrameSet encapsulated by "this". Zero uncertainity is assumed
* if NULL is supplied.
* mask
* Pointer to location at which to return a pointer to a newly
* allocated dynamic array of ints. The number of elements in this
* array is equal to the value of the Npoint attribute of "pset".
* Each element in the returned array is set to 1 if the
* corresponding position in "pset" is on the boundary of the Region
* and is set to zero otherwise. A NULL value may be supplied
* in which case no array is created. If created, the array should
* be freed using astFree when no longer needed.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Non-zero if the points all fall on the boundary of the given
* Region, to within the tolerance specified. Zero otherwise.
*/
/* Local variables: */
AstCmpRegion *this; /* Pointer to the CmpRegion structure. */
AstPointSet *pset1; /* Points masked by 1st component Region */
AstPointSet *pset2; /* Points masked by 2nd component Region */
AstPointSet *psetb1; /* Points in base Frame of 1st component Region */
AstPointSet *psetb2; /* Points in base Frame of 2nd component Region */
AstRegion *reg1; /* Pointer to first component Region */
AstRegion *reg2; /* Pointer to second component Region */
AstRegion *unc1; /* Base Frame uncertainty in 1st component Region */
AstRegion *unc2; /* Base Frame uncertainty in 2nd component Region */
double **ptr1; /* Pointer to axis values in "pset1" */
double **ptr2; /* Pointer to axis values in "pset2" */
double *p1; /* Pointer to next axis zero value for pset1 */
double *p2; /* Pointer to next axis zero value for pset2 */
int *mask1; /* Mask for first component boundary */
int *mask2; /* Mask for second component boundary */
int ip; /* Point index */
int np; /* Number of points */
int result; /* Returned flag */
/* Initialise */
result = 0;
if( mask ) *mask = NULL;
/* Check the inherited status. */
if( !astOK ) return result;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* Get pointers to the two component Regions. */
reg1 = this->region1;
reg2 = this->region2;
/* Get a mask which indicates if each supplied point is on or off the
boundary of the first component Region. astRegPins expects its "pset"
argument to contain positions in the base Frame of the Region, so
we must first transform the supplied points into the base Frame of
"reg1". We must also map the uncertainty into the base Frame of the
component Region. */
psetb1 = astRegTransform( reg1, pset, 0, NULL, NULL );
unc1 = MatchRegion( reg1, AST__BASE, unc, "astRegPins", status );
astRegPins( reg1, psetb1, unc1, &mask1 );
/* Likewise, get a mask which indicates if each supplied point is on or off
the boundary of the second component Region. */
psetb2 = astRegTransform( reg2, pset, 0, NULL, NULL );
unc2 = MatchRegion( reg2, AST__BASE, unc, "astRegPins", status );
astRegPins( reg2, psetb2, unc2, &mask2 );
/* The criteria for a point to be on the boundary of the CmpRegion depend
on the boolean operator being used. If component regions A and B are
ANDed together, then a point is on the boundary of the CmpRegion if
either 1) it is on the boundary of A and inside B, or 2) it is on the
boundary of B and inside A. If the component regions are ORed together,
then a point is on the boundary of the CmpRegion if either 1) it is on
the boundary of A and outside B, or 2) it is on the boundary of B and
outside A. Either we need to transform the supplied PointSet using each
component Region as a Mapping. But if using OR we temporarily negate
the Regions. */
if( this->oper == AST__OR ) {
astNegate( reg1 );
astNegate( reg2 );
}
pset1 = astTransform( reg1, pset, 1, NULL );
pset2 = astTransform( reg2, pset, 1, NULL );
if( this->oper == AST__OR ) {
astNegate( reg1 );
astNegate( reg2 );
}
/* Get pointers to the axis values in these PointSets */
ptr1 = astGetPoints( pset1 );
ptr2 = astGetPoints( pset2 );
/* If required, create an output mask array */
np = astGetNpoint( pset );
if( mask ) *mask = astMalloc( sizeof(int)*(size_t) np );
/* Check pointers can be used safely. */
if( astOK ) {
/* We can use the values for the first axis to indicate if a point is
inside or outside a Region. So store pointers to the first axis arrays. */
p1 = ptr1[ 0 ];
p2 = ptr2[ 0 ];
/* Assume all points are on the boundary of the CmpRegion. */
result = 1;
/* If we are creating an output mask, we must check every point. Otherwise
we can stop checking when we find the first point which is not on the
boundary of the CmpRegion. */
if( mask ) {
for( ip = 0; ip < np; ip++ ) {
if( ( mask1[ ip ] && p2[ ip ] != AST__BAD ) ||
( mask2[ ip ] && p1[ ip ] != AST__BAD ) ){
(*mask)[ ip ] = 1;
} else {
(*mask)[ ip ] = 0;
result = 0;
}
}
} else {
for( ip = 0; ip < np; ip++ ) {
if( ( !mask1[ ip ] || p2[ ip ] == AST__BAD ) &&
( !mask2[ ip ] || p1[ ip ] == AST__BAD ) ){
result = 0;
break;
}
}
}
}
/* Free resources */
mask1 = astFree( mask1 );
mask2 = astFree( mask2 );
pset1 = astAnnul( pset1 );
pset2 = astAnnul( pset2 );
psetb1 = astAnnul( psetb1 );
psetb2 = astAnnul( psetb2 );
if( unc1 ) unc1 = astAnnul( unc1 );
if( unc2 ) unc2 = astAnnul( unc2 );
/* If an error has occurred, return zero. */
if( !astOK ) {
result = 0;
if( mask ) *mask = astFree( *mask );
}
/* Return the result. */
return result;
}
static void RegSetAttrib( AstRegion *this_region, const char *setting,
char **base_setting, int *status ) {
/*
* Name:
* RegSetAttrib
* Purpose:
* Set an attribute value for a Region.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void RegSetAttrib( AstRegion *this, const char *setting,
* char **base_setting, int *status )
* Class Membership:
* CmpRegion method (over-rides the astRegSetAttrib method inherited from
* the Region class).
* Description:
* This function assigns an attribute value to both the base and
* current Frame in the FrameSet encapsulated within a Region, without
* remapping either Frame.
*
* No error is reported if the attribute is not recognised by the base
* Frame.
* Parameters:
* this
* Pointer to the Region.
* setting
* Pointer to a null terminated attribute setting string. NOTE, IT
* SHOULD BE ENTIRELY LOWER CASE. The supplied string will be
* interpreted using the public interpretation implemented by
* astSetAttrib. This can be different to the interpretation of the
* protected accessor functions. For instance, the public
* interpretation of an unqualified floating point value for the
* Epoch attribute is to interpet the value as a gregorian year,
* but the protected interpretation is to interpret the value as an
* MJD.
* base_setting
* Address of a location at which to return a pointer to the null
* terminated attribute setting string which was applied to the
* base Frame of the encapsulated FrameSet. This may differ from
* the supplied setting if the supplied setting contains an axis
* index and the current->base Mapping in the FrameSet produces an
* axis permutation. The returned pointer should be freed using
* astFree when no longer needed. A NULL pointer may be supplied in
* which case no pointer is returned.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstCmpRegion *this;
char *bset;
int rep;
/* Check the global error status. */
if ( !astOK ) return;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* Use the RegSetAttrib method inherited from the parent class to apply the
setting to the current and base Frames in the FrameSet encapsulated by the
parent Region structure. */
(*parent_regsetattrib)( this_region, setting, &bset, status );
/* Now apply the base Frame setting to the component Regions (the current
Frame within the component Regions is equivalent to the base Frame in the
parent Region structure). Annul any "attribute unknown" error that results
from attempting to do this. */
if( astOK ) {
rep = astReporting( 0 );
astRegSetAttrib( this->region1, bset, NULL );
astRegSetAttrib( this->region2, bset, NULL );
if( astStatus == AST__BADAT ) astClearStatus;
astReporting( rep );
}
/* If required, return the base Frame setting string, otherwise free it. */
if( base_setting ) {
*base_setting = bset;
} else {
bset = astFree( bset );
}
}
static AstRegion **RegSplit( AstRegion *this_region, int *nlist, int *status ){
/*
*+
* Name:
* RegSplit
* Purpose:
* Split a Region into a list of disjoint component Regions.
* Type:
* Private function.
* Synopsis:
* #include "region.h"
* AstRegion **astRegSplit( AstRegion *this, int *nlist )
* Class Membership:
* CmpRegion member function (overrides the astRegSplit method
* inherited from the parent Region class).
* Description:
* This function splits the supplied Region into a set of disjoint
* component Regions. If the Region cannot be split, then the returned
* array contains only one pointer - a clone of the supplied Region
* pointer.
* Parameters:
* this
* Pointer to the Region.
* nlist
* Pointer to an int in which to return the number of elements in
* the returned array.
* Returned Value:
* Pointer to dynamically alloctaed memory holding an array of Region
* pointers. The length of this array is given by the value returned
* in "*nlist". The pointers in the returned array should be annulled
* using astAnnul when no longer needed, and the memory used to hold
* the array should be freed using astFree.
* Notes:
* - A NULL pointer is returned if an error has already occurred, or if
* this function should fail for any reason.
*-
*/
/* Local Variables; */
AstCmpRegion *new;
AstCmpRegion *this;
AstFrame *frm;
AstFrameSet *fs;
AstMapping *map;
AstRegion **cmplist;
AstRegion **result;
AstRegion *cmpreg;
AstRegion *new_reg;
int icomp;
int ifirst;
int ilist;
int iw;
int jcomp;
int ncomp;
int nn;
int unbounded;
/* Initialise. */
result = NULL;
*nlist = 0;
/* Check the local error status. */
if ( !astOK ) return result;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* Indicate we have not yet found any unbounded component regions. */
unbounded = 0;
/* Can only split non-inverted CmpRegions that combine their components
using the OR operator. */
if( this->oper == AST__OR && !astGetNegated( this->region1 ) &&
!astGetNegated( this->region2 ) ) {
/* Process each of the two component Regions in turn. */
for( icomp = 0; icomp < 2 && !unbounded; icomp++ ) {
cmpreg = icomp ? this->region2 : this->region1;
/* Create a set of disjoint Regions that are equivalent to the current
component Region, and loop round them. */
cmplist = astRegSplit( cmpreg, &ncomp );
for( jcomp = 0; jcomp < ncomp; jcomp++ ) {
/* If any of the components are unbounds, we cannot split the supplied
Region. */
unbounded = unbounded || !astGetBounded( cmplist[ jcomp ] );
if( ! unbounded ) {
/* Initialise the index within the returned list of the first Region that
overlaps the current disjoint component Region. */
ifirst = -1;
/* Loop round all the Regions currently in the returned list. */
for( ilist = 0; ilist < *nlist; ilist++ ) {
if( result[ ilist ] ) {
/* See if the current disjoint component overlaps the current entry in
the returned list. */
if( astOverlap( cmplist[ jcomp ], result[ ilist ] ) > 1 ) {
/* If this is the first overlap found for the current disjoint component,
form a CmpRegion that combines the two overlapping Regions, and use it
to replace the current entry in the returned list. */
if( ifirst == -1 ) {
new = astCmpRegion( cmplist[ jcomp ], result[ ilist ],
AST__OR, " ", status );
(void) astAnnul( result[ ilist ] );
result[ ilist ] = (AstRegion *) new;
/* Note the index within the returned list of the first Region that overlaps
the current disjoint component Region. */
ifirst = ilist;
/* If this is the second or later overlap, add the overlapping returned Region
into the CmpRegion that it is stored at index "ifirsT" in the returned
list. */
} else {
new = astCmpRegion( result[ ilist ], result[ ifirst ],
AST__OR, " ", status );
result[ ilist ] = astAnnul( result[ ilist ] );
(void) astAnnul( result[ ifirst ] );
result[ ifirst ] = (AstRegion *) new;
}
}
}
}
/* If the current disjoint component does not overlap any of the Regions
already in the returned list, append the current disjoint component to
the end of the returned list. */
if( ifirst == -1 ) {
ilist = (*nlist)++;
result = astGrow( result, *nlist, sizeof( *result ) );
if( astOK ) result[ ilist ] = astClone( cmplist[ jcomp ] );
}
}
/* Annul the pointer to the disjoint component Region. */
cmplist[ jcomp ] = astAnnul( cmplist[ jcomp ] );
}
/* Free the mnemory holding the list of disjoint components. */
cmplist = astFree( cmplist );
}
}
/* If any unbounded components were found, ensure the returned list is
empty. */
if( unbounded && result ) {
for( ilist = 0; ilist < *nlist; ilist++ ) {
if( result[ ilist ] ) result[ ilist ] = astAnnul( result[ ilist ] );
}
result = astFree( result );
*nlist = 0;
/* Otherwise, shuffle later entries down to fill any NULL slots in the returned
list. */
} else if( result ){
nn = *nlist;
iw = 0;
for( ilist = 0; ilist < nn; ilist++ ) {
if( result[ ilist ] ) result[ iw++ ] = result[ ilist ];
}
*nlist = iw;
}
/* If this CmpRegion cannot be split, the returned list just holds a
clone of the Region pointer. */
if( !result ) {
result = astMalloc( sizeof( *result ) );
if( astOK ) {
result[ 0 ] = astClone( this );
*nlist = 1;
}
}
/* Remap any returned Regions so that they are defined within the same
coordinate system as the supplied Region. */
if( result && *nlist > 0 ) {
fs = this_region->frameset;
map = astGetMapping( fs, AST__BASE, AST__CURRENT );
frm = astGetFrame( fs, AST__CURRENT );
for( ilist = 0; ilist < *nlist; ilist++ ) {
new_reg = astMapRegion( result[ ilist ], map, frm );
(void) astAnnul( result[ ilist ] );
result[ ilist ] = new_reg;
}
map = astAnnul( map );
frm = astAnnul( frm );
}
/* Free all returned pointers if an error has occurred. */
if( !astOK && result ) {
for( ilist = 0; ilist < *nlist; ilist++ ) {
result[ ilist ] = astAnnul( result[ ilist ] );
}
result = astFree( result );
*nlist = 0;
}
/* Return the result. */
return result;
}
static int RegTrace( AstRegion *this_region, int n, double *dist, double **ptr,
int *status ){
/*
*+
* Name:
* RegTrace
* Purpose:
* Return requested positions on the boundary of a 2D Region.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* int astRegTrace( AstRegion *this, int n, double *dist, double **ptr );
* Class Membership:
* CmpRegion member function (overrides the astRegTrace method
* inherited from the parent Region class).
* Description:
* This function returns positions on the boundary of the supplied
* Region, if possible. The required positions are indicated by a
* supplied list of scalar parameter values in the range zero to one.
* Zero corresponds to some arbitrary starting point on the boundary,
* and one corresponds to the end (which for a closed region will be
* the same place as the start).
* Parameters:
* this
* Pointer to the Region.
* n
* The number of positions to return. If this is zero, the function
* returns without action (but the returned function value still
* indicates if the method is supported or not).
* dist
* Pointer to an array of "n" scalar parameter values in the range
* 0 to 1.0.
* ptr
* A pointer to an array of pointers. The number of elements in
* this array should equal tthe number of axes in the Frame spanned
* by the Region. Each element of the array should be a pointer to
* an array of "n" doubles, in which to return the "n" values for
* the corresponding axis. The contents of the arrays are unchanged
* if the supplied Region belongs to a class that does not
* implement this method.
* Returned Value:
* Non-zero if the astRegTrace method is implemented by the class
* of Region supplied, and zero if not.
* Notes:
* - The current algorithm results in the boundary of the CmpRegion
* being dis-contiguous - supplied distance values from zero up to some
* mid-value correspond to positions on the first component Region, and
* higher distance (up to 1.0) correspond to points on the second
* component Region.
*-
*/
/* Local Variables; */
AstCmpRegion *this;
AstFrame *frm;
AstMapping *map;
AstPointSet *bpset;
AstPointSet *cpset;
AstRegion *ureg1;
AstRegion *ureg2;
double **bptr;
int i;
int j;
int ncur;
int result;
double *rval;
double *off;
double *r1d;
double *r2d;
double *r1ptr[ 2 ];
double *r2ptr[ 2 ];
double **r1ptrb;
double **r2ptrb;
double dbreak;
double dtot;
double x;
double x0;
int r1n;
int r2n;
AstPointSet *r1pset;
AstPointSet *r2pset;
AstPointSet *r1psetb;
AstPointSet *r2psetb;
/* Initialise */
result = 0;
/* Check inherited status. */
if( ! astOK ) return result;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* Get a pointer to the base Frame in the encapsulated FrameSet. */
frm = astGetFrame( this_region->frameset, AST__BASE );
/* Check it is 2-dimensional. */
result = 1;
if( astGetNaxes( frm ) != 2 ) result = 0;
/* Check the component Regions can be traced. */
if( !astRegTrace( this->region1, 0, NULL, NULL ) ||
!astRegTrace( this->region1, 0, NULL, NULL ) ) result = 0;
/* Check we have some points to find. */
if( result && n > 0 ) {
/* We first determine the required positions in the base Frame of the
Region, and then transform them into the current Frame. Get the
base->current Mapping, and the number of current Frame axes. */
map = astGetMapping( this_region->frameset, AST__BASE, AST__CURRENT );
/* If it's a UnitMap we do not need to do the transformation, so put the
base Frame positions directly into the supplied arrays. */
if( astIsAUnitMap( map ) ) {
bpset = NULL;
bptr = ptr;
ncur = 2;
/* Otherwise, create a PointSet to hold the base Frame positions. */
} else {
bpset = astPointSet( n, 2, " ", status );
bptr = astGetPoints( bpset );
ncur = astGetNout( map );
}
r1d = astMalloc( sizeof( double )*n );
r2d = astMalloc( sizeof( double )*n );
/* Ensure information about the breaks in the boundary of each component
region is available within the CmpRegion structure. These breaks are
the points at which the two boundaries cross. */
SetBreakInfo( this, 0, status );
SetBreakInfo( this, 1, status );
/* Get the constants needed to convert the supplied distances (normalised
so that the border of the entire CmpRegion has a length of 1.0), into
geodesic distances around the border of each component Region. */
dtot = this->d0[ 0 ] + this->d0[ 1 ];
dbreak = this->d0[ 0 ]/dtot;
/* Initialise here to avoid compiler warnings. */
r1n = 0;
r2n = 0;
/* Check the pointers can be used safely. */
if( astOK ) {
/* Loop round all supplied distances, determining if they represent a
position on the first or second component Region. */
for( i = 0; i < n; i++ ) {
/* If the current distance represents a point in the second component
Region... */
if( dist[ i ] > dbreak ) {
/* Find the correspond distance around the used sections of the second
component region (normalised so that the entire border of the
component region has a length of "this->d0[1]"). */
x0 = ( dist[ i ] - dbreak )*dtot;
x = x0;
/* Convert this into the correspond distance around the entire border of
the second component region (normalised so that the entire border of the
component region has unit length). */
rval = this->rvals[ 1 ];
off = this->offs[ 1 ];
for( j = 0; j < this->nbreak[ 1 ]; j++,rval++,off++ ) {
if( *rval >= x0 ) break;
x += *off;
}
/* Store this as the next distance to move around the second component
Region, normalising it to the range 0 to 1 as required by astRegTrace. */
r2d[ r2n++ ] = x/this->dtot[ 1 ];
/* Now we do the same if the current distance corresponds to a position
in the first component Region. */
} else {
x0 = dist[ i ]*dtot;
x = x0;
rval = this->rvals[ 0 ];
off = this->offs[ 0 ];
for( j = 0; j < this->nbreak[ 0 ]; j++,rval++,off++ ) {
if( *rval >= x0 ) break;
x += *off;
}
r1d[ r1n++ ] = x/this->dtot[ 0 ];
}
}
}
/* Allocate memory to hold the axis values at the corresponding positions
in the first component Region. */
r1ptr[ 0 ] = astMalloc( sizeof( double )*r1n );
r1ptr[ 1 ] = astMalloc( sizeof( double )*r1n );
/* Allocate memory to hold the axis values at the corresponding positions
in the second component Region. */
r2ptr[ 0 ] = astMalloc( sizeof( double )*r2n );
r2ptr[ 1 ] = astMalloc( sizeof( double )*r2n );
/* Check the pointers can be used safely. */
if( astOK ) {
/* Find the axis values at each of the required positions that fall in
the first component Region. Negate it first if needed to ensure the
Region is bounded (not guaranteed, but likely). */
if( astGetBounded( this->region1 ) ) {
(void) astRegTrace( this->region1, r1n, r1d, r1ptr );
} else {
AstRegion *negation = astGetNegation( this->region1 );
(void) astRegTrace( negation, r1n, r1d, r1ptr );
negation = astAnnul( negation );
}
/* Do the same for the second component Region. */
if( astGetBounded( this->region2 ) ) {
(void) astRegTrace( this->region2, r2n, r2d, r2ptr );
} else {
AstRegion *negation = astGetNegation( this->region2 );
(void) astRegTrace( negation, r2n, r2d, r2ptr );
negation = astAnnul( negation );
}
/* The arrays of positions returned by the above calls to astRegTrace may
include points that should not be there (e.g. points on the boundary
of one component region that should have been blanked due to being inside
the second component region - if the regions are ORed together). This
is a consequence of the relatively low value of the "NP" local constant
in function SetBreakInfo. So we now refine the positions to exclude
any such unwanted positions.
If the two component Regions are ANDed together, we want to remove the
positions from the boundary of the required component Region that fall
outside the other region. We can do this by simply using the other Region
as a Mapping. If the two component Regions are ORed together, we want to
remove the position that fall within (rather than outside) the other
Region. To do this we need to negate the other region first. */
if( this->oper == AST__OR ) {
ureg1 = astGetNegation( this->region1 );
ureg2 = astGetNegation( this->region2 );
} else {
ureg1 = astClone( this->region1 );
ureg2 = astClone( this->region2 );
}
/* Now transform the points on the boundary of the first Region in order
to set invalid those positions which are not on the boundary of the
supplied CmpRegion. */
if( r1n > 0 ) {
r1pset = astPointSet( r1n, 2, " ", status );
astSetPoints( r1pset, r1ptr );
r1psetb = astTransform( ureg2, r1pset, 1, NULL );
r1ptrb = astGetPoints( r1psetb );
} else {
r1pset = NULL;
r1psetb = NULL;
r1ptrb = NULL;
}
/* Now transform the points on the boundary of the second Region in order
to set invalid those positions which are not on the boundary of the
supplied CmpRegion. */
if( r2n > 0 ) {
r2pset = astPointSet( r2n, 2, " ", status );
astSetPoints( r2pset, r2ptr );
r2psetb = astTransform( ureg1, r2pset, 1, NULL );
r2ptrb = astGetPoints( r2psetb );
} else {
r2pset = NULL;
r2psetb = NULL;
r2ptrb = NULL;
}
/* Free the begation pointers. */
ureg1 = astAnnul( ureg1 );
ureg2 = astAnnul( ureg2 );
/* Check pointer can be used safely. */
if( astOK ) {
/* Copy the boundary positions from each component Region into a single
PointSet. These positions are in the base Frame of the CmpRegion. */
r1n = 0;
r2n = 0;
for( i = 0; i < n; i++ ) {
if( dist[ i ] > dbreak ) {
bptr[ 0 ][ i ] = r2ptrb[ 0 ][ r2n ];
bptr[ 1 ][ i ] = r2ptrb[ 1 ][ r2n++ ];
} else {
bptr[ 0 ][ i ] = r1ptrb[ 0 ][ r1n ];
bptr[ 1 ][ i ] = r1ptrb[ 1 ][ r1n++ ];
}
}
}
/* Free resources. */
if( r1pset ) r1pset = astAnnul( r1pset );
if( r2pset ) r2pset = astAnnul( r2pset );
if( r1psetb ) r1psetb = astAnnul( r1psetb );
if( r2psetb ) r2psetb = astAnnul( r2psetb );
}
/* If required, transform the base frame positions into the current
Frame of the CmpRegion, storing them in the supplied array. Then
free resources. */
if( bpset ) {
cpset = astPointSet( n, ncur, " ", status );
astSetPoints( cpset, ptr );
(void) astTransform( map, bpset, 1, cpset );
cpset = astAnnul( cpset );
bpset = astAnnul( bpset );
}
/* Free remaining resources. */
map = astAnnul( map );
}
frm = astAnnul( frm );
/* Return the result. */
return result;
}
static void RegClearAttrib( AstRegion *this_region, const char *attrib,
char **base_attrib, int *status ) {
/*
* Name:
* RegClearAttrib
* Purpose:
* Clear an attribute value for a Region.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void RegClearAttrib( AstRegion *this, const char *attrib,
* char **base_attrib, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astRegClearAttrib method
* inherited from the Region class).
* Description:
* This function clears the value of a named attribute in both the base
* and current Frame in the FrameSet encapsulated within a Region, without
* remapping either Frame.
*
* No error is reported if the attribute is not recognised by the base
* Frame.
* Parameters:
* this
* Pointer to the Region.
* attrib
* Pointer to a null terminated string holding the attribute name.
* NOTE, IT SHOULD BE ENTIRELY LOWER CASE.
* base_attrib
* Address of a location at which to return a pointer to the null
* terminated string holding the attribute name which was cleared in
* the base Frame of the encapsulated FrameSet. This may differ from
* the supplied attribute if the supplied attribute contains an axis
* index and the current->base Mapping in the FrameSet produces an
* axis permutation. The returned pointer should be freed using
* astFree when no longer needed. A NULL pointer may be supplied in
* which case no pointer is returned.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstCmpRegion *this;
char *batt;
int rep;
/* Check the global error status. */
if ( !astOK ) return;
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* Use the RegClearAttrib method inherited from the parent class to clear the
attribute in the current and base Frames in the FrameSet encapsulated by
the parent Region structure. */
(*parent_regclearattrib)( this_region, attrib, &batt, status );
/* Now clear the base Frame attribute to the component Regions (the current
Frame within the component Regions is equivalent to the base Frame in the
parent Region structure). Annul any "attribute unknown" error that results
from attempting to do this. */
if( astOK ) {
rep = astReporting( 0 );
astRegClearAttrib( this->region1, batt, NULL );
astRegClearAttrib( this->region2, batt, NULL );
if( astStatus == AST__BADAT ) astClearStatus;
astReporting( rep );
}
/* If required, return the base Frame attribute name, otherwise free it. */
if( base_attrib ) {
*base_attrib = batt;
} else {
batt = astFree( batt );
}
}
static void ResetCache( AstRegion *this_region, int *status ){
/*
* Name:
* ResetCache
* Purpose:
* Clear cached information within the supplied Region.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void ResetCache( AstRegion *this, int *status )
* Class Membership:
* Region member function (overrides the astResetCache method
* inherited from the parent Region class).
* Description:
* This function clears cached information from the supplied Region
* structure.
* Parameters:
* this
* Pointer to the Region.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables *: */
AstCmpRegion *this;
int i;
/* Check a Region was supplied. */
if( this_region ) {
/* Get a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_region;
/* Clear information cached in the CmpRegion structure. */
for( i = 0; i < 2; i++ ) {
this->rvals[ i ] = astFree( this->rvals[ i ] );
this->offs[ i ] = astFree( this->offs[ i ] );
this->nbreak[ i ] = 0;
this->d0[ i ] = AST__BAD;
this->dtot[ i ] = AST__BAD;
}
this->bounded = -INT_MAX;
/* Clear information cached in the component regions. */
if( this->region1 ) astResetCache( this->region1 );
if( this->region2 ) astResetCache( this->region2 );
/* Clear information cached in the parent Region structure. */
(*parent_resetcache)( this_region, status );
}
}
static void SetBreakInfo( AstCmpRegion *this, int comp, int *status ){
/*
* Name:
* SetBreakInfo
* Purpose:
* Ensure that a CmpRegion has information about the breaks in the
* boundaries of one of the two component Regions.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void SetBreakInfo( AstCmpRegion *this, int comp, int *status )
* Class Membership:
* CmpRegion method.
* Description:
* This function returns without action if the supplied CmpRegion
* already contains break information for the specified component Region.
* Otherwise, it creates the required information and stores it in the
* CmpRegion.
*
* Each component Region in the CmpRegion has a boundary. But in
* general only part of the boundary of a component Region will also
* be included in the CmpRegion boundary. Thus the component Region
* boundary can be broken up into sections; sections that form part
* of the CmpRegion boundary, and sections that do not. This function
* stores information about the breaks between these sections.
*
* The complete boundary of a component Region is parameterised by a
* geodesic distance that goes from 0.0 to the value found by this
* function and stored in this->dtot (the total geodesic distance
* around the border). This function find the ranges of this parameter
* that correspond to the sections of the boundary that are also on the
* CmpRegion boundary, and thus finds the total length that the component
* boundary contributes to the CmpRegion boundary. This length is stored
* in "this->d0" (a two element array, one for each component Region).
*
* It also find two arrays "this->rvals" and "this->offs" that allow a
* distance value in the range 0.0 to "this->d0" (i.e. a distance
* measured by skipping over the parts of the component boundary that
* are not on the CmpRegion boundary), to be converted into the
* corresponding distance value in the range 0.0 to "this->dtot" (i.e. a
* distance measured round the complete component boundary, including the
* parts not on the CmpRegion boundary).
* Parameters:
* this
* Pointer to a CmpRegion.
* comp
* Zero or one, indicating which component Region is to be checked.
* status
* Pointer to the inherited status variable.
*/
/* The number of points to be spread evenly over the entire boundary of the
component Region. */
#define NP 101
/* Local Variables: */
AstFrame *frm;
AstPointSet *pset1;
AstPointSet *pset2;
AstRegion *other;
AstRegion *reg;
AstRegion *uother;
double **ptr2;
double **ptr1;
double *d;
double *offs;
double *p0;
double *p1;
double *p;
double *q;
double *rvals;
double delta;
double dist;
double pnt1[ 2 ];
double pnt2[ 2 ];
double rbad;
double rval;
double totdist;
int i;
int j;
int nn;
int prevgood;
/* Check inherited status */
if( !astOK ) return;
/* If the information describing breaks in the component boundary has not
yet been set up, do so now. */
if( this->d0[ comp ] == AST__BAD ) {
/* Get a pointer to the component Region for which break information is
required. */
reg = comp ? this->region2 : this->region1;
/* Check the component class implements the astRegTrace method. */
if( astRegTrace( reg, 0, NULL, NULL ) ) {
/* Create a pointSet to hold axis values at evenly spaced positions along
the entire boundary of the selected component region. */
pset1 = astPointSet( NP, 2, " ", status );
ptr1 = astGetPoints( pset1 );
/* Allocate memory to hold an array of corresponding scalar distances around
the boundary. */
d = astMalloc( NP*sizeof( double ) );
/* Check pointers can be used safely. */
if( astOK ) {
/* Get the distance increment between points (at this point the distances
are normalised so that the entire boundary has unit length, as
required by astRegTrace). */
delta = 1.0/( NP - 1 );
/* Set up the array of evenly spaced distances around the boundary of the
component region. */
for( i = 0; i < NP; i++ ) d[ i ] = i*delta;
/* Get the corresponding Frame positions. If the Region is unbounded
(e.g. a negated circle, etc), then negate it first in the hope that
this may produced a bounded Region. */
if( astGetBounded( reg ) ) {
(void) astRegTrace( reg, NP, d, ptr1 );
} else {
AstRegion *negation = astGetNegation( reg );
(void) astRegTrace( negation, NP, d, ptr1 );
negation = astAnnul( negation );
}
/* Get a pointer to the other component Region. */
other = comp ? this->region1 : this->region2;
/* If the two component Regions are ANDed together, we want to remove the
positions from the boundary of the required component Region that fall
outside the other region. We can do this by simply using the other Region
as a Mapping. If the two component Regions are ORed together, we want to
remove the position that fall within (rather than outside) the other
Region. To do this we need to negate the other region first. */
if( this->oper == AST__OR ) {
uother = astGetNegation( other );
} else {
uother = astClone( other );
}
/* Now transform the points on the boundary of the selected Region in
order to set invalid those positions which are not on the boundary of
the supplied CmpRegion. */
pset2 = astTransform( uother, pset1, 1, NULL );
/* Annul the negation pointer */
uother = astAnnul( uother );
/* Modify the distance array by setting invalid each element that is not
on the boundary of the CmpRegion. */
ptr2 = astGetPoints( pset2 );
if( astOK ) {
p = ptr2[ 0 ];
q = ptr2[ 1 ];
for( i = 0; i < NP; i++,p++,q++ ) {
if( *p == AST__BAD || *q == AST__BAD ) d[ i ] = AST__BAD;
}
/* At each good/bad junction in this list, extend the good section by one
point. This ensures that the good sections of the curve do in fact
touch each other (they may in fact overlap a little but that does not
matter). */
prevgood = ( d[ 0 ] != AST__BAD );
for( i = 1; i < NP; i++,p++,q++ ) {
if( d[ i ] == AST__BAD ) {
if( prevgood ) d[ i ] = i*delta;
prevgood = 0;
} else {
if( !prevgood ) d[ i - 1 ] = ( i - 1 )*delta;
prevgood = 1;
}
}
/* Find the total geodesic distance around the border. This is only an
approximation but it is only used to give a relative weight to this
component within the CmpFrame, and so does not need to be very accurate. */
frm = astGetFrame( reg->frameset, AST__CURRENT );
p0 = ptr1[ 0 ];
p1 = ptr1[ 1 ];
totdist = 0;
pnt1[ 0 ] = *(p0++);
pnt1[ 1 ] = *(p1++);
for( i = 1; i < NP; i++ ) {
pnt2[ 0 ] = *(p0++);
pnt2[ 1 ] = *(p1++);
dist = astDistance( frm, pnt1, pnt2 );
if( dist != AST__BAD ) totdist += dist;
pnt1[ 0 ] = pnt2[ 0 ];
pnt1[ 1 ] = pnt2[ 1 ];
}
/* Change delta so that it represents a geodesic distance, rather than a
normalised distance in the range zero to one. Working in geodesic distance
(e.g. Radians on a SkyFrame) prevents Regions higher up in a complex nested
CmpRegion being given higher priority than a lower Region. */
delta *= totdist;
/* Now create two arrays - "rvals" holds the distance travelled around
the used parts of the border at which breaks occur, "offs" holds the jump
in distance around the complete border at each break. The distance
around the complete border is normalised to the range [0.0,1.0].
Therefore the total distance around the used parts of the border will in
general be less than 1.0 */
if( d[ 0 ] == AST__BAD ) {
nn = 1;
j = 0;
rvals = astMalloc( sizeof( double ) );
offs = astMalloc( sizeof( double ) );
if( astOK ) rvals[ 0 ] = -0.5*delta;
rbad = 0.5;
prevgood = 0;
rval = -0.5*delta;
} else {
nn = 0;
rvals = NULL;
offs = NULL;
prevgood = 1;
rbad = 0.0;
rval = 0.0;
}
for( i = 1; i < NP; i++,p++,q++ ) {
if( d[ i ] == AST__BAD ) {
if( prevgood ) {
j = nn++;
rvals = astGrow( rvals, nn, sizeof( double ) );
offs = astGrow( offs, nn, sizeof( double ) );
if( astOK ) {
rvals[ j ] = rval + 0.5*delta;
rbad = 0.0;
} else {
break;
}
prevgood = 0;
}
rbad += 1.0;
} else {
if( !prevgood ) {
offs[ j ] = rbad*delta;
prevgood = 1;
}
rval += delta;
}
}
if( !prevgood ) {
rval += 0.5*delta;
offs[ j ] = rbad*delta;
}
/* Record the information in the CmpRegion structure. */
this->rvals[ comp ] = rvals;
this->offs[ comp ] = offs;
this->nbreak[ comp ] = nn;
this->d0[ comp ] = rval;
this->dtot[ comp ] = totdist;
}
/* Free resources. */
pset2 = astAnnul( pset2 );
}
pset1 = astAnnul( pset1 );
d = astFree( d );
}
}
}
#undef NP
static void SetRegFS( AstRegion *this_region, AstFrame *frm, int *status ) {
/*
* Name:
* SetRegFS
* Purpose:
* Stores a new FrameSet in a Region
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void SetRegFS( AstRegion *this_region, AstFrame *frm, int *status )
* Class Membership:
* CmpRegion method (over-rides the astSetRegFS method inherited from
* the Region class).
* Description:
* This function creates a new FrameSet and stores it in the supplied
* Region. The new FrameSet contains two copies of the supplied
* Frame, connected by a UnitMap.
* Parameters:
* this
* Pointer to the Region.
* frm
* The Frame to use.
* status
* Pointer to the inherited status variable.
*/
/* Local Variables: */
AstRegion *creg; /* Pointer to component Region structure */
/* Check the global error status. */
if ( !astOK ) return;
/* Invoke the parent method to store the FrameSet in the parent Region
structure. */
(* parent_setregfs)( this_region, frm, status );
/* If either component Region has a dummy FrameSet use this method
recursively to give them the same FrameSet. */
creg = ((AstCmpRegion *) this_region )->region1;
if( creg && !astGetRegionFS( creg ) ) astSetRegFS( creg, frm );
creg = ((AstCmpRegion *) this_region )->region2;
if( creg && !astGetRegionFS( creg ) ) astSetRegFS( creg, frm );
}
static AstMapping *Simplify( AstMapping *this_mapping, int *status ) {
/*
* Name:
* Simplify
* Purpose:
* Simplify a Region.
* Type:
* Private function.
* Synopsis:
* #include "region.h"
* AstMapping *Simplify( AstMapping *this, int *status )
* Class Membership:
* CmpRegion method (over-rides the astSimplify method inherited from
* the Region class).
* Description:
* This function simplifies a CmpRegion to eliminate redundant
* computational steps, or to merge separate steps which can be
* performed more efficiently in a single operation.
* Parameters:
* this
* Pointer to the original Region.
* status
* Pointer to the inherited status variable.
* Returned Value:
* A new pointer to the (possibly simplified) Region.
* Notes:
* - A NULL pointer value will be returned if this function is
* invoked with the AST error status set, or if it should fail for
* any reason.
* Deficiencies:
* - Currently, this function does not attempt to map the component
* Regions into the current Frame of the parent Region structure.
* Both components should be mapped into the current Frame, and if the
* resulting base->current Mappings in *both* remapped component Regions are
* UnitMaps, then a new CmpRegion should be created from the re-mapped
* Regions.
*/
/* Local Variables: */
AstCmpRegion *newb; /* New CmpRegion defined in base Frame */
AstCmpRegion *newc; /* New CmpRegion defined in current Frame */
AstFrame *frm; /* Current Frame */
AstMapping *map; /* Base->current Mapping */
AstMapping *result; /* Result pointer to return */
AstRegion *csreg1; /* Copy of simplified first component Region */
AstRegion *csreg2; /* Copy of simplified second component Region */
AstRegion *nullreg; /* Null or infinfite Region */
AstRegion *othereg; /* Non-Null and non-infinfite Region */
AstRegion *reg1; /* First component Region */
AstRegion *reg2; /* Second component Region */
AstRegion *sreg1; /* Simplified first component Region */
AstRegion *sreg2; /* Simplified second component Region */
int neg1; /* Negated flag to use with first component */
int neg2; /* Negated flag to use with second component */
int oper; /* Boolean operator used to combine components */
int overlap; /* Nature of overlap between components */
int simpler; /* Has any simplification taken place? */
/* Initialise. */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Invoke the parent Simplify method inherited from the Region class. This
will simplify the encapsulated FrameSet and uncertainty Region. The
returned pointer identifies a region within the current Frame of the
FrameSet encapsulated by the parent Region structure. Note this by
storing the pointer in the "newc" ("c" for "current") variable. */
newc = (AstCmpRegion *) (*parent_simplify)( this_mapping, status );
/* Note if any simplification took place. This is assumed to be the case
if the pointer returned by the above call is different to the supplied
pointer. */
simpler = ( (AstMapping *) newc != this_mapping );
/* Below we may create a new simplified region which identifies a region
within the base Frame of the FrameSet encapsulated by the parent Region
structure. Such a result will need to be mapped into the current Frame
before being returned. The "newb" variable ("b" for "base") will be
used to store a pointer to such a result. Initialise this variable to
indicate that we do not yet have a base Frame result. */
newb = NULL;
/* Get the component Regions, how they should be combined, and the
Negated values which should be used with them. The returned values
take account of whether the supplied CmpRegion has itself been Negated
or not. The returned Regions represent regions within the base Frame
of the FrameSet encapsulated by the parent Region structure. */
GetRegions( newc, ®1, ®2, &oper, &neg1, &neg2, status );
/* If the first component Region does not have the required value for
its "Negated" attribute, use the negation of "reg1" in place of "reg1"
itself. */
if( neg1 != astGetNegated( reg1 ) ) {
AstRegion *tmp = astGetNegation( reg1 );
(void) astAnnul( reg1 );
reg1 = tmp;
}
/* If the second component Region does not have the required value for
its "Negated" attribute, use the negation of "reg2" in place of "reg2"
itself. */
if( neg2 != astGetNegated( reg2 ) ) {
AstRegion *tmp = astGetNegation( reg2 );
(void) astAnnul( reg2 );
reg2 = tmp;
}
/* Simplify each of the two components. */
sreg1 = astSimplify( reg1 );
sreg2 = astSimplify( reg2 );
/* Note if any simplification took place. */
simpler = simpler || ( sreg1 != reg1 || sreg2 != reg2 );
/* If either component is null or infinite we can exclude it from the
returned Region. */
if( astIsANullRegion( sreg1 ) || astIsANullRegion( sreg2 ) ) {
/* Get a pointer to the non-null Region. The following is still valid
even if both regions are null or infinite. */
if( astIsANullRegion( sreg1 ) ){
nullreg = sreg1;
othereg = sreg2;
} else {
nullreg = sreg2;
othereg = sreg1;
}
/* If null.. */
if( !astGetNegated( nullreg ) ){
if( oper == AST__AND ) {
newb = (AstCmpRegion *) astNullRegion( othereg,
astGetUnc( othereg, 0 ), "", status );
} else if( oper == AST__OR ) {
newb = astCopy( othereg );
} else {
astError( AST__INTER, "astSimplify(%s): The %s refers to an "
"unknown boolean operator with identifier %d (internal "
"AST programming error).", status, astGetClass( newc ),
astGetClass( newc ), oper );
}
/* If infinite.. */
} else {
if( oper == AST__AND ) {
newb = astCopy( othereg );
} else if( oper == AST__OR ) {
newb = (AstCmpRegion *) astNullRegion( othereg,
astGetUnc( othereg, 0 ), "negated=1", status );
} else {
astError( AST__INTER, "astSimplify(%s): The %s refers to an "
"unknown boolean operator with identifier %d (internal "
"AST programming error).", status, astGetClass( newc ),
astGetClass( newc ), oper );
}
}
/* Flag that we have done some simplication.*/
simpler = 1;
/* If neither component is null or infinite, see if it is possible to
remove one or both of the components on the basis of the overlap
between them. */
} else {
overlap = astOverlap( sreg1, sreg2 );
/* If the components have no overlap, and they are combined using AND, then
the CmpRegion is null. */
if( ( overlap == 1 || overlap == 6 ) && oper == AST__AND ) {
newb = (AstCmpRegion *) astNullRegion( sreg1, astGetUnc( sreg1, 0 ),
"", status );
simpler = 1;
/* If one component is the negation of the other component, and they are
combined using OR, then the CmpRegion is infinite. This is represented
by a negated null region.*/
} else if( overlap == 6 && oper == AST__OR ) {
newb = (AstCmpRegion *) astNullRegion( sreg1, astGetUnc( sreg1, 0 ),
"negated=1", status );
simpler = 1;
/* If the two components are identical... */
} else if( overlap == 5 ) {
simpler = 1;
/* If combined with AND or OR, the CmpRegion can be replaced by the first
(or second) component Region. */
if( oper == AST__AND || oper == AST__OR ) {
newb = astCopy( sreg1 );
} else {
astError( AST__INTER, "astSimplify(%s): The %s refers to an "
"unknown boolean operator with identifier %d (internal "
"AST programming error).", status, astGetClass( newc ),
astGetClass( newc ), oper );
}
/* If the first component is entirely contained within the second
component, and they are combined using AND or OR, then the CmpRegion
can be replaced by the first or second component. */
} else if( overlap == 2 && ( oper == AST__AND || oper == AST__OR ) ){
newb = astCopy( ( oper == AST__AND ) ? sreg1 : sreg2 );
simpler = 1;
/* If the second component is entirely contained within the first
component, and they are combined using AND or OR, then the CmpRegion
can be replaced by the second or first component. */
} else if( overlap == 3 && ( oper == AST__AND || oper == AST__OR ) ){
newb = astCopy( ( oper == AST__AND ) ? sreg2 : sreg1 );
simpler = 1;
/* Otherwise, no further simplication is possible, so either create a new
CmpRegion or leave the "newb" pointer NULL (which will cause "newc" to
be used), depending on whether the components were simplified. */
} else if( simpler ){
csreg1 = astCopy( sreg1 );
csreg2 = astCopy( sreg2 );
newb = astCmpRegion( csreg1, csreg2, oper, "", status );
csreg1 = astAnnul( csreg1 );
csreg2 = astAnnul( csreg2 );
}
}
/* If any simplification took place, decide whether to use the "newc" or
"newb" pointer for the returned Mapping. If "newb" is non-NULL we use
it, otherwise we use "newc". If "newb" is used we must first map the
result Region from the base Frame of the FrameSet encapsulated
by the parent Region structure, to the current Frame. */
if( simpler ) {
if( newb ){
frm = astGetFrame( ((AstRegion *) newc)->frameset, AST__CURRENT );
map = astGetMapping( ((AstRegion *) newc)->frameset, AST__BASE, AST__CURRENT );
result = astMapRegion( newb, map, frm );
frm = astAnnul( frm );
map = astAnnul( map );
newb = astAnnul( newb );
} else {
result = astClone( newc );
}
/* If no simplification took place, return a clone of the supplied pointer. */
} else {
result = astClone( this_mapping );
}
/* Free resources. */
reg1 = astAnnul( reg1 );
reg2 = astAnnul( reg2 );
sreg1 = astAnnul( sreg1 );
sreg2 = astAnnul( sreg2 );
newc = astAnnul( newc );
/* If an error occurred, annul the returned Mapping. */
if ( !astOK ) result = astAnnul( result );
/* Return the result. */
return result;
}
static AstPointSet *Transform( AstMapping *this_mapping, AstPointSet *in,
int forward, AstPointSet *out, int *status ) {
/*
* Name:
* Transform
* Purpose:
* Apply a CmpRegion to transform a set of points.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* AstPointSet *Transform( AstMapping *this, AstPointSet *in,
* int forward, AstPointSet *out, int *status )
* Class Membership:
* CmpRegion member function (over-rides the astTransform method inherited
* from the Region class).
* Description:
* This function takes a CmpRegion and a set of points encapsulated in a
* PointSet and transforms the points so as to apply the required Region.
* This implies applying each of the CmpRegion's component Regions in turn,
* either in series or in parallel.
* Parameters:
* this
* Pointer to the CmpRegion.
* in
* Pointer to the PointSet associated with the input coordinate values.
* forward
* A non-zero value indicates that the forward coordinate transformation
* should be applied, while a zero value requests the inverse
* transformation.
* out
* Pointer to a PointSet which will hold the transformed (output)
* coordinate values. A NULL value may also be given, in which case a
* new PointSet will be created by this function.
* status
* Pointer to the inherited status variable.
* Returned Value:
* Pointer to the output (possibly new) PointSet.
* 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.
* - The number of coordinate values per point in the input PointSet must
* match the number of coordinates for the CmpRegion being applied.
* - If an output PointSet is supplied, it must have space for sufficient
* number of points and coordinate values per point to accommodate the
* result. Any excess space will be ignored.
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to the CmpRegion structure */
AstPointSet *ps1; /* Pointer to PointSet for first component */
AstPointSet *ps2; /* Pointer to PointSet for second component */
AstPointSet *pset_tmp; /* Pointer to PointSet holding base Frame positions*/
AstPointSet *result; /* Pointer to output PointSet */
AstRegion *reg1; /* Pointer to first component Region */
AstRegion *reg2; /* Pointer to second component Region */
double **ptr1; /* Pointer to first component axis values */
double **ptr2; /* Pointer to second component axis values */
double **ptr_out; /* Pointer to output coordinate data */
int coord; /* Zero-based index for coordinates */
int good; /* Is the point inside the CmpRegion? */
int ncoord_out; /* No. of coordinates per output point */
int ncoord_tmp; /* No. of coordinates per base Frame point */
int neg1; /* Negated value for first component Region */
int neg2; /* Negated value for second component Region */
int npoint; /* No. of points */
int oper; /* Boolean operator to use */
int point; /* Loop counter for points */
/* Initialise. */
result = NULL;
/* Check the global error status. */
if ( !astOK ) return result;
/* Get a Pointer to the CmpRegion structure */
this = (AstCmpRegion *) this_mapping;
/* Get the component Regions, how they should be combined, and the
Negated values which should be used with them. The returned values
take account of whether the supplied CmpRegion has itself been Negated
or not. The returned Regions represent regions within the base Frame
of the FrameSet encapsulated by the parent Region structure. */
GetRegions( this, ®1, ®2, &oper, &neg1, &neg2, status );
/* If the first component Region does not have the required value for
its "Negated" attribute, use the negation of "reg1" in place of "reg1"
itself. */
if( neg1 != astGetNegated( reg1 ) ) {
AstRegion *tmp = astGetNegation( reg1 );
(void) astAnnul( reg1 );
reg1 = tmp;
}
/* If the second component Region does not have the required value for
its "Negated" attribute, use the negation of "reg2" in place of "reg2"
itself. */
if( neg2 != astGetNegated( reg2 ) ) {
AstRegion *tmp = astGetNegation( reg2 );
(void) astAnnul( reg2 );
reg2 = tmp;
}
/* Apply the parent mapping using the stored pointer to the Transform member
function inherited from the parent Region class. This function validates
all arguments and generates an output PointSet if necessary, containing
a copy of the input PointSet. */
result = (*parent_transform)( this_mapping, in, forward, out, status );
/* We will now extend the parent astTransform method by performing the
calculations needed to generate the output coordinate values. */
/* First use the encapsulated FrameSet in the parent Region structure to
transform the supplied positions from the current Frame in the
encapsulated FrameSet (the Frame represented by the CmpRegion), to the
base Frame (the Frame in which the component Regions are defined). Note,
the returned pointer may be a clone of the "in" pointer, and so we
must be carefull not to modify the contents of the returned PointSet. */
pset_tmp = astRegTransform( this, in, 0, NULL, NULL );
/* Now transform this PointSet using each of the two component Regions in
turn. */
ps1 = astTransform( reg1, pset_tmp, 0, NULL );
ps2 = astTransform( reg2, pset_tmp, 0, NULL );
/* Determine the numbers of points and coordinates per point for these base
Frame PointSets and obtain pointers for accessing the base Frame and output
coordinate values. */
npoint = astGetNpoint( pset_tmp );
ncoord_tmp = astGetNcoord( pset_tmp );
ptr1 = astGetPoints( ps1 );
ptr2 = astGetPoints( ps2 );
ncoord_out = astGetNcoord( result );
ptr_out = astGetPoints( result );
/* Perform coordinate arithmetic. */
/* ------------------------------ */
if ( astOK ) {
/* First deal with ANDed Regions */
if( oper == AST__AND ) {
for ( point = 0; point < npoint; point++ ) {
good = 0;
for ( coord = 0; coord < ncoord_tmp; coord++ ) {
if( ptr1[ coord ][ point ] != AST__BAD &&
ptr2[ coord ][ point ] != AST__BAD ) {
good = 1;
break;
}
}
if( !good ) {
for ( coord = 0; coord < ncoord_out; coord++ ) {
ptr_out[ coord ][ point ] = AST__BAD;
}
}
}
/* Now deal with ORed Regions */
} else if( oper == AST__OR ) {
for ( point = 0; point < npoint; point++ ) {
good = 0;
for ( coord = 0; coord < ncoord_tmp; coord++ ) {
if( ptr1[ coord ][ point ] != AST__BAD ||
ptr2[ coord ][ point ] != AST__BAD ) {
good = 1;
break;
}
}
if( !good ) {
for ( coord = 0; coord < ncoord_out; coord++ ) {
ptr_out[ coord ][ point ] = AST__BAD;
}
}
}
/* Report error for any unknown operator. */
} else if( astOK ) {
astError( AST__INTER, "astTransform(%s): The %s refers to an unknown "
"boolean operator with identifier %d (internal AST "
"programming error).", status, astGetClass( this ),
astGetClass( this ), oper );
}
}
/* Free resources. */
reg1 = astAnnul( reg1 );
reg2 = astAnnul( reg2 );
ps1 = astAnnul( ps1 );
ps2 = astAnnul( ps2 );
pset_tmp = astAnnul( pset_tmp );
/* If an error occurred, clean up by deleting the output PointSet (if
allocated by this function) and setting a NULL result pointer. */
if ( !astOK ) {
if ( !out ) result = astDelete( result );
result = NULL;
}
/* Return a pointer to the output PointSet. */
return result;
}
static void XORCheck( AstCmpRegion *this, int *status ) {
/*
* Name:
* XORCheck
* Purpose:
* Check if the supplied CmpRegion represents an XOR operation.
* Type:
* Private function.
* Synopsis:
* #include "cmpregion.h"
* void XORCheck( AstCmpRegion *this, int *status )
* Class Membership:
* CmpRegion method
* Decription:
* This function analyses the component Regions within the supplied
* CmpRegion to see if the CmpRegion is equivalent to an XOR operation
* on two other Regions. If it is, teh Regions that are XORed are
* stored in the supplied CmpRegion.
* Parameters:
* this
* Pointer to the CmpRegion.
*/
/* Local Variables: */
AstCmpRegion *cmpreg1;
AstCmpRegion *cmpreg2;
int xor;
/* Check the global error status. */
if ( !astOK ) return;
/* If the CmpRegion is already known to be an XOR operation, return
without action. */
if( this->xor1 ) return;
/* To be equivalent to an XOR operation, the supplied CmpRegion must be an
OR operation and each component Region must be a CmpRegion. */
if( this->oper == AST__OR && astIsACmpRegion( this->region1 )
&& astIsACmpRegion( this->region2 ) ) {
cmpreg1 = (AstCmpRegion *) this->region1;
cmpreg2 = (AstCmpRegion *) this->region2;
/* Each component CmpRegion must be an AND operation. */
if( cmpreg1->oper == AST__AND && cmpreg2->oper == AST__AND ) {
/* Temporarily negate the first component of the first CmpRegion. */
astNegate( cmpreg1->region1 );
/* Initially, assume the supplied CmpRegion is not equivalent to an XOR
operation. */
xor = 0;
/* This negated region must be equal to one of the two component Regions
in the second component CmpRegion. Check the first. */
if( astEqual( cmpreg1->region1, cmpreg2->region1 ) ) {
/* We now check that the other two Regions are equal (after negating the
first). If so, set "xor" non-zero. */
astNegate( cmpreg1->region2 );
if( astEqual( cmpreg1->region2, cmpreg2->region2 ) ) xor = 1;
astNegate( cmpreg1->region2 );
/* Do equiovalent checks the other way round. */
} else if( astEqual( cmpreg1->region1, cmpreg2->region2 ) ) {
astNegate( cmpreg1->region2 );
if( astEqual( cmpreg1->region2, cmpreg2->region1 ) ) xor = 1;
astNegate( cmpreg1->region2 );
}
/* Re-instate the original state of the Negated attribute in the first
component of the first CmpRegion. */
astNegate( cmpreg1->region1 );
/* If the supplied CmpRegion is equivalent to an XOR operation, store
copies of the components in the supplied CmpRegion. */
if( xor ) {
this->xor1 = astCopy( cmpreg1->region1 );
this->xor2 = astCopy( cmpreg1->region2 );
/* We need to negate one of these two Region (it doesn't matter which),
and we choose to negate which ever of them is already negated (so that
it becomes un-negated). */
if( astGetNegated( this->xor1 ) ) {
astNegate( this->xor1 );
} else {
astNegate( this->xor2 );
}
}
}
}
}
/* Copy constructor. */
/* ----------------- */
static void Copy( const AstObject *objin, AstObject *objout, int *status ) {
/*
* Name:
* Copy
* Purpose:
* Copy constructor for CmpRegion objects.
* Type:
* Private function.
* Synopsis:
* void Copy( const AstObject *objin, AstObject *objout, int *status )
* Description:
* This function implements the copy constructor for CmpRegion objects.
* Parameters:
* objin
* Pointer to the object to be copied.
* objout
* Pointer to the object being constructed.
* status
* Pointer to the inherited status variable.
* Returned Value:
* void
* Notes:
* - This constructor makes a deep copy, including a copy of the component
* Regions within the CmpRegion.
*/
/* Local Variables: */
AstCmpRegion *in; /* Pointer to input CmpRegion */
AstCmpRegion *out; /* Pointer to output CmpRegion */
int i; /* Loop count */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain pointers to the input and output CmpRegions. */
in = (AstCmpRegion *) objin;
out = (AstCmpRegion *) objout;
/* For safety, start by clearing any memory references in the output
Region that were copied from the input Region. */
out->region1 = NULL;
out->region2 = NULL;
out->xor1 = NULL;
out->xor2 = NULL;
for( i = 0; i < 2; i++ ) {
out->rvals[ i ] = NULL;
out->offs[ i ] = NULL;
}
/* Make copies of these Regions and store pointers to them in the output
CmpRegion structure. */
out->region1 = astCopy( in->region1 );
out->region2 = astCopy( in->region2 );
if( in->xor1 ) out->xor1 = astCopy( in->xor1 );
if( in->xor2 ) out->xor2 = astCopy( in->xor2 );
/* Copy cached arrays. */
for( i = 0; i < 2; i++ ) {
out->rvals[ i ] = astStore( NULL, in->rvals[ i ], in->nbreak[ i ]*sizeof( **in->rvals ) );
out->offs[ i ] = astStore( NULL, in->offs[ i ], in->nbreak[ i ]*sizeof( **in->offs ) );
}
}
/* Destructor. */
/* ----------- */
static void Delete( AstObject *obj, int *status ) {
/*
* Name:
* Delete
* Purpose:
* Destructor for CmpRegion objects.
* Type:
* Private function.
* Synopsis:
* void Delete( AstObject *obj, int *status )
* Description:
* This function implements the destructor for CmpRegion objects.
* Parameters:
* obj
* Pointer to the object to be deleted.
* status
* Pointer to the inherited status variable.
* Returned Value:
* void
* Notes:
* This function attempts to execute even if the global error status is
* set.
*/
/* Local Variables: */
AstCmpRegion *this; /* Pointer to CmpRegion */
int i;
/* Obtain a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) obj;
/* Free arrays holding cached information. */
for( i = 0; i < 2; i++ ) {
this->rvals[ i ] = astFree( this->rvals[ i ] );
this->offs[ i ] = astFree( this->offs[ i ] );
}
/* Annul the pointers to the component Regions. */
this->region1 = astAnnul( this->region1 );
this->region2 = astAnnul( this->region2 );
if( this->xor1 ) this->xor1 = astAnnul( this->xor1 );
if( this->xor2 ) this->xor2 = astAnnul( this->xor2 );
}
/* Dump function. */
/* -------------- */
static void Dump( AstObject *this_object, AstChannel *channel, int *status ) {
/*
* Name:
* Dump
* Purpose:
* Dump function for CmpRegion 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 CmpRegion class to an output Channel.
* Parameters:
* this
* Pointer to the CmpRegion 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: */
AstRegion *reg1; /* First Region to include in dump */
AstRegion *reg2; /* Second Region to include in dump */
AstCmpRegion *this; /* Pointer to the CmpRegion structure */
const char *comment; /* Pointer to comment string */
int ival; /* Integer value */
int oper; /* The operator to include in the dump */
/* Check the global error status. */
if ( !astOK ) return;
/* Obtain a pointer to the CmpRegion structure. */
this = (AstCmpRegion *) this_object;
/* Check if this CmpRegion has an equivalent XOR representation. Is so,
store details of the XOR representation in the CmpRegion. */
XORCheck( this, status );
/* Choose the operator and component regions to include in the dump. If
the CmpRegion originally used an XOR operator, then save the XORed
regions. Otherwise, store the real component Regions. */
if( this->xor1 ) {
oper = AST__XOR;
reg1 = this->xor1;
reg2 = this->xor2;
} else {
oper = this->oper;
reg1 = this->region1;
reg2 = this->region2;
}
/* Write out values representing the instance variables for the CmpRegion
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. */
/* Oper */
/* ------- */
ival = oper;
if( ival == AST__AND ) {
comment = "Regions combined using Boolean AND";
} else if( ival == AST__OR ) {
comment = "Regions combined using Boolean OR";
} else if( ival == AST__XOR ) {
comment = "Regions combined using Boolean XOR";
} else {
comment = "Regions combined using unknown operator";
}
astWriteInt( channel, "Operator", 1, 0, ival, comment );
/* First Region. */
/* -------------- */
astWriteObject( channel, "RegionA", 1, 1, reg1,
"First component Region" );
/* Second Region. */
/* --------------- */
astWriteObject( channel, "RegionB", 1, 1, reg2,
"Second component Region" );
}
/* Standard class functions. */
/* ========================= */
/* Implement the astIsACmpRegion and astCheckCmpRegion functions using the
macros defined for this purpose in the "object.h" header file. */
astMAKE_ISA(CmpRegion,Region)
astMAKE_CHECK(CmpRegion)
AstCmpRegion *astCmpRegion_( void *region1_void, void *region2_void, int oper,
const char *options, int *status, ...) {
/*
*+
* Name:
* astCmpRegion
* Purpose:
* Create a CmpRegion.
* Type:
* Protected function.
* Synopsis:
* #include "cmpregion.h"
* AstCmpRegion *astCmpRegion( AstRegion *region1, AstRegion *region2,
* int oper, const char *options, ..., int *status )
* Class Membership:
* CmpRegion constructor.
* Description:
* This function creates a new CmpRegion and optionally initialises its
* attributes.
* Parameters:
* region1
* Pointer to the first Region.
* region2
* Pointer to the second Region.
* oper
* The boolean operator with which to combine the two Regions. Either
* AST__AND or AST__OR.
* options
* Pointer to a null terminated string containing an optional
* comma-separated list of attribute assignments to be used for
* initialising the new CmpRegion. 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 CmpRegion.
* 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 CmpRegion constructor which is
* available via the protected interface to the CmpRegion class. A
* public interface is provided by the astCmpRegionId_ function.
* - Because this function has a variable argument list, it is
* invoked by a macro that evaluates to a function pointer (not a
* function invocation) and no checking or casting of arguments is
* performed before the function is invoked. Because of this, the
* "region1" and "region2" parameters are of type (void *) and are
* converted and validated within the function itself.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Pointer to thread-specific global data */
AstCmpRegion *new; /* Pointer to new CmpRegion */
AstRegion *region1; /* Pointer to first Region structure */
AstRegion *region2; /* Pointer to second Region structure */
va_list args; /* Variable argument list */
/* Initialise. */
new = NULL;
/* Get a pointer to the thread specific global data structure. */
astGET_GLOBALS(NULL);
/* Check the global status. */
if ( !astOK ) return new;
/* Obtain and validate pointers to the Region structures provided. */
region1 = astCheckRegion( region1_void );
region2 = astCheckRegion( region2_void );
if ( astOK ) {
/* Initialise the CmpRegion, allocating memory and initialising the
virtual function table as well if necessary. */
new = astInitCmpRegion( NULL, sizeof( AstCmpRegion ), !class_init,
&class_vtab, "CmpRegion", region1, region2,
oper );
/* 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 CmpRegion's
attributes. */
va_start( args, status );
astVSet( new, options, NULL, args );
va_end( args );
/* If an error occurred, clean up by deleting the new object. */
if ( !astOK ) new = astDelete( new );
}
}
/* Return a pointer to the new CmpRegion. */
return new;
}
AstCmpRegion *astCmpRegionId_( void *region1_void, void *region2_void,
int oper, const char *options, ... ) {
/*
*++
* Name:
c astCmpRegion
f AST_CMPREGION
* Purpose:
* Create a CmpRegion.
* Type:
* Public function.
* Synopsis:
c #include "cmpregion.h"
c AstCmpRegion *astCmpRegion( AstRegion *region1, AstRegion *region2,
c int oper, const char *options, ... )
f RESULT = AST_CMPREGION( REGION1, REGION2, OPER, OPTIONS, STATUS )
* Class Membership:
* CmpRegion constructor.
* Description:
* This function creates a new CmpRegion and optionally initialises
* its attributes.
*
* A CmpRegion is a Region which allows two component
* Regions (of any class) to be combined to form a more complex
* Region. This combination may be performed a boolean AND, OR
* or XOR (exclusive OR) operator. If the AND operator is
* used, then a position is inside the CmpRegion only if it is
* inside both of its two component Regions. If the OR operator is
* used, then a position is inside the CmpRegion if it is inside
* either (or both) of its two component Regions. If the XOR operator
* is used, then a position is inside the CmpRegion if it is inside
* one but not both of its two component Regions. Other operators can
* be formed by negating one or both component Regions before using
* them to construct a new CmpRegion.
*
* The two component Region need not refer to the same coordinate
* Frame, but it must be possible for the
c astConvert
f AST_CONVERT
* function to determine a Mapping between them (an error will be
* reported otherwise when the CmpRegion is created). For instance,
* a CmpRegion may combine a Region defined within an ICRS SkyFrame
* with a Region defined within a Galactic SkyFrame. This is
* acceptable because the SkyFrame class knows how to convert between
* these two systems, and consequently the
c astConvert
f AST_CONVERT
* function will also be able to convert between them. In such cases,
* the second component Region will be mapped into the coordinate Frame
* of the first component Region, and the Frame represented by the
* CmpRegion as a whole will be the Frame of the first component Region.
*
* Since a CmpRegion is itself a Region, it can be used as a
* component in forming further CmpRegions. Regions of arbitrary
* complexity may be built from simple individual Regions in this
* way.
* Parameters:
c region1
f REGION1 = INTEGER (Given)
* Pointer to the first component Region.
c region2
f REGION2 = INTEGER (Given)
* Pointer to the second component Region. This Region will be
* transformed into the coordinate Frame of the first region before
* use. An error will be reported if this is not possible.
c oper
f OPER = INTEGER (Given)
* The boolean operator with which to combine the two Regions. This
* must be one of the symbolic constants AST__AND, AST__OR or AST__XOR.
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 CmpRegion. 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.
f A character string containing an optional comma-separated
f list of attribute assignments to be used for initialising the
f new CmpRegion. The syntax used is identical to that for the
f AST_SET routine.
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 astCmpRegion()
f AST_CMPREGION = INTEGER
* A pointer to the new CmpRegion.
* Notes:
* - If one of the supplied Regions has an associated uncertainty,
* that uncertainty will also be used for the returned CmpRegion.
* If both supplied Regions have associated uncertainties, the
* uncertainty associated with the first Region will be used for the
* returned CmpRegion.
* - Deep copies are taken of the supplied Regions. This means that
* any subsequent changes made to the component Regions using the
* supplied pointers will have no effect on the CmpRegion.
* - 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 astCmpRegion constructor function. It returns an ID value
* (instead of a true C pointer) to external users, and must be
* provided because astCmpRegion_ has a variable argument list which
* cannot be encapsulated in a macro (where this conversion would
* otherwise occur).
* - Because no checking or casting of arguments is performed
* before the function is invoked, the "region1" and "region2" parameters
* are of type (void *) and are converted from an ID value to a
* pointer and validated within the function itself.
* - The variable argument list also prevents this function from
* invoking astCmpRegion_ directly, so it must be a re-implementation
* of it in all respects, except for the conversions between IDs
* and pointers on input/output of Objects.
*/
/* Local Variables: */
astDECLARE_GLOBALS /* Pointer to thread-specific global data */
AstCmpRegion *new; /* Pointer to new CmpRegion */
AstRegion *region1; /* Pointer to first Region structure */
AstRegion *region2; /* Pointer to second Region structure */
va_list args; /* Variable argument list */
int *status; /* Pointer to inherited status value */
/* Get a pointer to the thread specific global data structure. */
astGET_GLOBALS(NULL);
/* Initialise. */
new = NULL;
/* Get a pointer to the inherited status value. */
status = astGetStatusPtr;
/* Check the global status. */
if ( !astOK ) return new;
/* Obtain the Region pointers from the ID's supplied and validate the
pointers to ensure they identify valid Regions. */
region1 = astVerifyRegion( astMakePointer( region1_void ) );
region2 = astVerifyRegion( astMakePointer( region2_void ) );
if ( astOK ) {
/* Initialise the CmpRegion, allocating memory and initialising the
virtual function table as well if necessary. */
new = astInitCmpRegion( NULL, sizeof( AstCmpRegion ), !class_init,
&class_vtab, "CmpRegion", region1, region2,
oper );
/* 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 CmpRegion's
attributes. */
va_start( args, options );
astVSet( new, options, NULL, args );
va_end( args );
/* If an error occurred, clean up by deleting the new object. */
if ( !astOK ) new = astDelete( new );
}
}
/* Return an ID value for the new CmpRegion. */
return astMakeId( new );
}
AstCmpRegion *astInitCmpRegion_( void *mem, size_t size, int init,
AstCmpRegionVtab *vtab, const char *name,
AstRegion *region1, AstRegion *region2,
int oper, int *status ) {
/*
*+
* Name:
* astInitCmpRegion
* Purpose:
* Initialise a CmpRegion.
* Type:
* Protected function.
* Synopsis:
* #include "cmpregion.h"
* AstCmpRegion *astInitCmpRegion_( void *mem, size_t size, int init,
* AstCmpRegionVtab *vtab, const char *name,
* AstRegion *region1, AstRegion *region2,
* int oper )
* Class Membership:
* CmpRegion initialiser.
* Description:
* This function is provided for use by class implementations to initialise
* a new CmpRegion object. It allocates memory (if necessary) to
* accommodate the CmpRegion plus any additional data associated with the
* derived class. It then initialises a CmpRegion 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 CmpRegion at the start of
* the memory passed via the "vtab" parameter.
* Parameters:
* mem
* A pointer to the memory in which the CmpRegion is to be initialised.
* This must be of sufficient size to accommodate the CmpRegion data
* (sizeof(CmpRegion)) 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 CmpRegion (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
* CmpRegion structure, so a valid value must be supplied even if not
* required for allocating memory.
* init
* A logical flag indicating if the CmpRegion'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 CmpRegion.
* 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 Object
* astClass function).
* region1
* Pointer to the first Region.
* region2
* Pointer to the second Region.
* oper
* The boolean operator to use. Must be one of AST__AND, AST__OR or
* AST__XOR.
* Returned Value:
* A pointer to the new CmpRegion.
* 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: */
AstCmpRegion *new; /* Pointer to new CmpRegion */
AstFrame *frm; /* Frame encapsulated by first Region */
AstFrameSet *fs; /* FrameSet connecting supplied Regions */
AstMapping *map; /* Mapping between two supplied Regions */
AstMapping *smap; /* Simplified Mapping between two supplied Regions */
AstRegion *new_reg1; /* Replacement for first region */
AstRegion *new_reg2; /* Replacement for second region */
AstRegion *reg1; /* First Region to store in the CmpRegion */
AstRegion *reg2; /* Second Region to store in the CmpRegion */
AstRegion *xor1; /* Copy of first supplied Region or NULL */
AstRegion *xor2; /* Copy of second supplied Region or NULL */
int i; /* Loop count */
int used_oper; /* The boolean operation actually used */
/* Check the global status. */
if ( !astOK ) return NULL;
/* If necessary, initialise the virtual function table. */
if ( init ) astInitCmpRegionVtab( vtab, name );
/* Initialise. */
new = NULL;
/* Check the supplied oper value. */
if( oper != AST__AND && oper != AST__OR && oper != AST__XOR && astOK ) {
astError( AST__INTRD, "astInitCmpRegion(%s): Illegal "
"boolean operator value (%d) supplied.", status, name, oper );
}
/* Take copies of the supplied Regions. */
reg1 = astCopy( region1 );
reg2 = astCopy( region2 );
/* Get the Mapping from the second to the first Region. */
fs = astConvert( reg2, reg1, "" );
/* Report an error if not possible. */
if( fs == NULL ) {
frm = NULL;
if( astOK ) astError( AST__INTRD, "astInitCmpRegion(%s): No Mapping can "
"be found between the two supplied Regions.", status, name );
/* Otherwise, map the second Region into the Frame of the first (unless
they are already in the same Frame). This results in both component
Frames having the same current Frame. This current Frame is used as the
encapsulated Frame within the parent Region structure. */
} else {
frm = astGetFrame( fs, AST__CURRENT );
map = astGetMapping( fs, AST__BASE, AST__CURRENT );
smap = astSimplify( map );
if( !astIsAUnitMap( smap ) ) {
new_reg2 = astMapRegion( reg2, smap, frm );
(void) astAnnul( reg2 );
reg2 = new_reg2;
}
smap = astAnnul( smap );
map = astAnnul( map );
fs = astAnnul( fs );
}
/* The CmpRegion class does not implement XOR directly (as it does for
AND and OR). Instead, when requested to create an XOR CmpRegion, it
creates a CmpRegion that uses AND and OR to simulate XOR. The top
level XOR CmpRegion actually uses AST__OR and the two component
regions within it are CmpRegions formed by combing the two supplied
Regions (one being negated first) using AND. Create the required
component Regions. */
if( oper == AST__XOR ) {
astNegate( reg1 );
new_reg1 = (AstRegion *) astCmpRegion( reg1, reg2, AST__AND, " ",
status );
astNegate( reg1 );
astNegate( reg2 );
new_reg2 = (AstRegion *) astCmpRegion( reg1, reg2, AST__AND, " ",
status );
astNegate( reg2 );
xor1 = reg1;
xor2 = reg2;
reg1 = new_reg1;
reg2 = new_reg2;
used_oper = AST__OR;
/* For AND and OR, use the supplied operator. */
} else {
xor1 = NULL;
xor2 = NULL;
used_oper = oper;
}
/* Initialise a Region structure (the parent class) as the first component
within the CmpRegion structure, allocating memory if necessary. A NULL
PointSet is suppled as the two component Regions will perform the function
of defining the Region shape. The base Frame of the FrameSet in the
parent Region structure will be the same as the current Frames of the
FrameSets in the two component Regions. */
if ( astOK ) {
new = (AstCmpRegion *) astInitRegion( mem, size, 0,
(AstRegionVtab *) vtab, name,
frm, NULL, NULL );
/* Initialise the CmpRegion data. */
/* --------------------------- */
/* Store pointers to the component Regions. */
new->region1 = astClone( reg1 );
new->region2 = astClone( reg2 );
/* Note the operator used to combine the somponent Regions. */
new->oper = used_oper;
/* If we are creating an XOR CmpRegion, save copies of the supplied
Regions (i.e. the supplied Regions which are XORed). These will not
be the same as "reg1" and "reg2" since each of those two regions will
be CmpRegions that combine the supplied Regions using AST__AND. */
if( oper == AST__XOR ) {
new->xor1 = xor1;
new->xor2 = xor2;
} else {
new->xor1 = NULL;
new->xor2 = NULL;
}
/* Initialised cached values to show they have not yet been found. */
for( i = 0; i < 2; i++ ) {
new->rvals[ i ] = NULL;
new->offs[ i ] = NULL;
new->nbreak[ i ] = 0;
new->d0[ i ] = AST__BAD;
new->dtot[ i ] = AST__BAD;
}
new->bounded = -INT_MAX;
/* If the base->current Mapping in the FrameSet within each component Region
is a UnitMap, then the FrameSet does not need to be included in the
Dump of the new CmpRegion. Set the RegionFS attribute of the component
Region to zero to flag this. */
map = astGetMapping( reg1->frameset, AST__BASE, AST__CURRENT );
if( astIsAUnitMap( map ) ) astSetRegionFS( reg1, 0 );
map = astAnnul( map );
map = astGetMapping( reg2->frameset, AST__BASE, AST__CURRENT );
if( astIsAUnitMap( map ) ) astSetRegionFS( reg2, 0 );
map = astAnnul( map );
/* Copy attribute values from the first component Region to the parent
Region. */
if( astTestMeshSize( new->region1 ) ) {
astSetMeshSize( new, astGetMeshSize( new->region1 ) );
}
if( astTestClosed( new->region1 ) ) {
astSetClosed( new, astGetClosed( new->region1 ) );
}
/* If an error occurred, clean up by annulling the Region pointers and
deleting the new object. */
if ( !astOK ) {
new->region1 = astAnnul( new->region1 );
new->region2 = astAnnul( new->region2 );
new = astDelete( new );
}
}
/* Free resources */
reg1 = astAnnul( reg1 );
reg2 = astAnnul( reg2 );
if( frm ) frm = astAnnul( frm );
/* Return a pointer to the new object. */
return new;
}
AstCmpRegion *astLoadCmpRegion_( void *mem, size_t size,
AstCmpRegionVtab *vtab, const char *name,
AstChannel *channel, int *status ) {
/*
*+
* Name:
* astLoadCmpRegion
* Purpose:
* Load a CmpRegion.
* Type:
* Protected function.
* Synopsis:
* #include "cmpregion.h"
* AstCmpRegion *astLoadCmpRegion( void *mem, size_t size,
* AstCmpRegionVtab *vtab, const char *name,
* AstChannel *channel )
* Class Membership:
* CmpRegion loader.
* Description:
* This function is provided to load a new CmpRegion 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
* CmpRegion structure in this memory, using data read from the input
* Channel.
*
* If the "init" flag is set, it also initialises the contents of a
* virtual function table for a CmpRegion at the start of the memory
* passed via the "vtab" parameter.
* Parameters:
* mem
* A pointer to the memory into which the CmpRegion is to be
* loaded. This must be of sufficient size to accommodate the
* CmpRegion data (sizeof(CmpRegion)) 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 CmpRegion (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 CmpRegion 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(AstCmpRegion) is used instead.
* vtab
* Pointer to the start of the virtual function table to be
* associated with the new CmpRegion. If this is NULL, a pointer to
* the (static) virtual function table for the CmpRegion 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 "CmpRegion" is used instead.
* Returned Value:
* A pointer to the new CmpRegion.
* 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: */
AstCmpRegion *new; /* Pointer to the new CmpRegion */
AstRegion *reg1; /* First Region read from dump */
AstRegion *reg2; /* Second Region read from dump */
AstFrame *f1; /* Base Frame in parent Region */
AstRegion *creg; /* Pointer to component Region */
astDECLARE_GLOBALS /* Pointer to thread-specific global data */
int i; /* Loop count */
int oper; /* The operator to include in the dump */
/* Initialise. */
new = NULL;
/* Get a pointer to the thread specific global data structure. */
astGET_GLOBALS(channel);
/* 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 CmpRegion. In this case the
CmpRegion belongs to this class, so supply appropriate values to be
passed to the parent class loader (and its parent, etc.). */
if ( !vtab ) {
size = sizeof( AstCmpRegion );
vtab = &class_vtab;
name = "CmpRegion";
/* If required, initialise the virtual function table for this class. */
if ( !class_init ) {
astInitCmpRegionVtab( 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 CmpRegion. */
new = astLoadRegion( mem, size, (AstRegionVtab *) 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, "CmpRegion" );
/* 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. */
/* Operator */
/* -------- */
oper = astReadInt( channel, "operator", AST__AND );
/* First Region. */
/* -------------- */
reg1 = astReadObject( channel, "regiona", NULL );
/* Second Region. */
/* --------------- */
reg2 = astReadObject( channel, "regionb", NULL );
/* Initialised cached values to show they have not yet been found. */
for( i = 0; i < 2; i++ ) {
new->rvals[ i ] = NULL;
new->offs[ i ] = NULL;
new->nbreak[ i ] = 0;
new->d0[ i ] = AST__BAD;
new->dtot[ i ] = AST__BAD;
}
new->bounded = -INT_MAX;
/* The CmpRegion class does not implement XOR directly (as it does for
AND and OR). Instead, when requested to create an XOR CmpRegion, it
creates a CmpRegion that uses AND and OR to simulate XOR. The top
level XOR CmpRegion actually uses AST__OR and the two component
regions within it are CmpRegions formed by combing the two supplied
Regions (one being negated first) using AND. Create the required
component Regions. */
if( oper == AST__XOR ) {
astNegate( reg1 );
new->region1 = (AstRegion *) astCmpRegion( reg1, reg2, AST__AND,
" ", status );
astNegate( reg1 );
astNegate( reg2 );
new->region2 = (AstRegion *) astCmpRegion( reg1, reg2, AST__AND,
" ", status );
astNegate( reg2 );
new->xor1 = reg1;
new->xor2 = reg2;
new->oper = AST__OR;
/* For AND and OR, use the supplied Regions and operator. */
} else {
new->region1 = reg1;
new->region2 = reg2;
new->xor1 = NULL;
new->xor2 = NULL;
new->oper = oper;
}
/* If either component Region has a dummy FrameSet rather than the correct
FrameSet, the correct FrameSet will have copies of the base Frame of the
new CmpRegion as both its current and base Frames, connected by a UnitMap
(this is equivalent to a FrameSet containing a single Frame). However if
the new CmpRegion being loaded has itself got a dummy FrameSet, then we do
not do this since we do not yet know what the correct FrameSet is. In this
case we wait until the parent Region invokes the astSetRegFS method on the
new CmpRegion. */
if( !astRegDummyFS( new ) ) {
f1 = astGetFrame( ((AstRegion *) new)->frameset, AST__BASE );
creg = new->region1;
if( astRegDummyFS( creg ) ) astSetRegFS( creg, f1 );
creg = new->region2;
if( astRegDummyFS( creg ) ) astSetRegFS( creg, f1 );
f1 = astAnnul( f1 );
}
/* If an error occurred, clean up by deleting the new CmpRegion. */
if ( !astOK ) new = astDelete( new );
}
/* Return the new CmpRegion 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. */
int astCmpRegionList_( AstCmpRegion *this, int *nreg, AstRegion ***reg_list,
int *status ) {
if ( !astOK ) return AST__AND;
return (**astMEMBER(this,CmpRegion,CmpRegionList))( this, nreg, reg_list,
status );
}
|