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
//
// GENERATED FILE
//
use *;
use crateSpiceContext;
use *;
const CNVTOL: f64 = 0.000001;
const NWMAX: i32 = 15;
const NWDIST: i32 = 5;
const NWSEP: i32 = 5;
const NWRR: i32 = 5;
const NWUDS: i32 = 5;
const NWPA: i32 = 5;
const NWILUM: i32 = 5;
const ADDWIN: f64 = 0.5;
const FRMNLN: i32 = 32;
const FOVTLN: i32 = 40;
const FTCIRC: & = b"CIRCLE";
const FTELLI: & = b"ELLIPSE";
const FTPOLY: & = b"POLYGON";
const FTRECT: & = b"RECTANGLE";
const ANNULR: & = b"ANNULAR";
const ANY: & = b"ANY";
const PARTL: & = b"PARTIAL";
const FULL: & = b"FULL";
const DSSHAP: & = b"DSK";
const EDSHAP: & = b"ELLIPSOID";
const PTSHAP: & = b"POINT";
const RYSHAP: & = b"RAY";
const SPSHAP: & = b"SPHERE";
const NOCTYP: i32 = 4;
const OCLLN: i32 = 7;
const SHPLEN: i32 = 9;
const MAXVRT: i32 = 10000;
const CIRFOV: & = b"CIRCLE";
const ELLFOV: & = b"ELLIPSE";
const POLFOV: & = b"POLYGON";
const RECFOV: & = b"RECTANGLE";
const RECSYS: & = b"RECTANGULAR";
const LATSYS: & = b"LATITUDINAL";
const SPHSYS: & = b"SPHERICAL";
const RADSYS: & = b"RA/DEC";
const CYLSYS: & = b"CYLINDRICAL";
const GEOSYS: & = b"GEODETIC";
const PGRSYS: & = b"PLANETOGRAPHIC";
const XCRD: & = b"X";
const YCRD: & = b"Y";
const ZCRD: & = b"Z";
const RADCRD: & = b"RADIUS";
const LONCRD: & = b"LONGITUDE";
const LATCRD: & = b"LATITUDE";
const RACRD: & = b"RIGHT ASCENSION";
const DECCRD: & = b"DECLINATION";
const RNGCRD: & = b"RANGE";
const CLTCRD: & = b"COLATITUDE";
const ALTCRD: & = b"ALTITUDE";
const POSDEF: & = b"POSITION";
const SOBDEF: & = b"SUB-OBSERVER POINT";
const SINDEF: & = b"SURFACE INTERCEPT POINT";
const NWREL: i32 = 5;
const NWLONG: i32 = 7;
const EXWIDX: i32 = ;
const MXBEGM: i32 = 55;
const MXENDM: i32 = 13;
const MXMSG: i32 = ;
const NABCOR: i32 = 15;
const ABATSZ: i32 = 6;
const GEOIDX: i32 = 1;
const LTIDX: i32 = ;
const STLIDX: i32 = ;
const CNVIDX: i32 = ;
const XMTIDX: i32 = ;
const RELIDX: i32 = ;
const CORLEN: i32 = 5;
const MAXPAR: i32 = 10;
const LBCELL: i32 = -5;
const SEP: i32 = 1;
const DIST: i32 = 2;
const COORD: i32 = 3;
const RNGRAT: i32 = 4;
const PHASE: i32 = 5;
const ILUANG: i32 = 6;
const ANGSPD: i32 = 7;
const APDIAM: i32 = 8;
const NQ: i32 = 8;
const NC: i32 = 7;
const MAXOP: i32 = 6;
const MAXCLN: i32 = 80;
/// GF, Geometric event finder
///
/// Determine time intervals when a specified geometric quantity
/// satisfies a specified mathematical condition.
///
/// # Required Reading
///
/// * [GF](crate::required_reading::gf)
/// * [SPK](crate::required_reading::spk)
/// * [TIME](crate::required_reading::time)
/// * [NAIF_IDS](crate::required_reading::naif_ids)
/// * [FRAMES](crate::required_reading::frames)
///
/// # Brief I/O
///
/// ```text
/// VARIABLE I/O DESCRIPTION
/// -------- --- --------------------------------------------------
/// MAXPAR P Maximum number of parameters required to define
/// any quantity.
/// CNVTOL P Default convergence tolerance.
/// UDSTEP I Name of the routine that computes and returns a
/// time step.
/// UDREFN I Name of the routine that computes a refined time.
/// GQUANT I Type of geometric quantity.
/// QNPARS I Number of quantity definition parameters.
/// QPNAMS I Names of quantity definition parameters.
/// QCPARS I Array of character quantity definition parameters.
/// QDPARS I Array of double precision quantity definition
/// parameters.
/// QIPARS I Array of integer quantity definition parameters.
/// QLPARS I Array of logical quantity definition parameters.
/// OP I Operator that either looks for an extreme value
/// (max, min, local, absolute) or compares the
/// geometric quantity value and a number.
/// REFVAL I Reference value.
/// TOL I Convergence tolerance in seconds
/// ADJUST I Absolute extremum adjustment value.
/// CNFINE I SPICE window to which the search is restricted.
/// RPT I Progress reporter on (.TRUE.) or off (.FALSE.).
/// UDREPI I Function that initializes progress reporting.
/// UDREPU I Function that updates the progress report.
/// UDREPF I Function that finalizes progress reporting.
/// MW I Size of workspace windows.
/// NW I The number of workspace windows needed for the
/// search.
/// WORK O Array containing workspace windows.
/// BAIL I Logical indicating program interrupt monitoring.
/// UDBAIL I Name of a routine that signals a program interrupt.
/// RESULT I-O SPICE window containing results.
/// ```
///
/// # Detailed Input
///
/// ```text
/// UDSTEP is the name of the user specified routine that computes a
/// time step in an attempt to find a transition of the state
/// of the specified coordinate. In the context of this
/// routine's algorithm, a "state transition" occurs where
/// the geometric state changes from being in the desired
/// geometric condition event to not, or vice versa.
///
/// This routine relies on UDSTEP returning step sizes small
/// enough so that state transitions within the confinement
/// window are not overlooked. There must never be two roots
/// A and B separated by less than STEP, where STEP is the
/// minimum step size returned by UDSTEP for any value of ET
/// in the interval [A, B].
///
/// The calling sequence for UDSTEP is:
///
/// CALL UDSTEP ( ET, STEP )
///
/// where:
///
/// ET is the input start time from which the
/// algorithm is to search forward for a state
/// transition. ET is expressed as seconds past
/// J2000 TDB.
///
/// STEP is the output step size. STEP indicates how
/// far to advance ET so that ET and ET+STEP may
/// bracket a state transition and definitely do
/// not bracket more than one state transition.
/// Units are TDB seconds.
///
/// If a constant step size is desired, the SPICELIB routine
///
/// GFSTEP
///
/// may be used as the step size function. This is the
/// default option. If GFSTEP is used, the step size must be
/// set by calling
///
/// CALL GFSSTP ( STEP )
///
/// prior to calling this routine.
///
/// UDREFN is the name of the user specified routine that computes a
/// refinement in the times that bracket a transition point.
/// In other words, once a pair of times have been detected
/// such that the system is in different states at each of
/// the two times, UDREFN selects an intermediate time which
/// should be closer to the transition state than one of the
/// two known times.
///
/// The calling sequence for UDREFN is:
///
/// CALL UDREFN ( T1, T2, S1, S2, T )
///
/// where the inputs are:
///
/// T1 is a time when the system is in state S1. T1 is
/// expressed as seconds past J2000 TDB.
///
/// T2 is a time when the system is in state S2. T2 is
/// expressed as seconds past J2000 TDB. T2 is
/// assumed to be larger than T1.
///
/// S1 is the state of the system at time T1. S1 is a
/// LOGICAL value.
///
/// S2 is the state of the system at time T2. S2 is a
/// LOGICAL value.
///
/// UDREFN may use or ignore the S1 and S2 values.
///
/// The output is:
///
/// T is next time to check for a state transition.
/// T has value between T1 and T2. T is expressed
/// as seconds past J2000 TDB.
///
/// If a simple bisection method is desired, the SPICELIB
/// routine
///
/// GFREFN
///
/// may be used as the refinement function. This is the
/// default option.
///
/// GQUANT is a string containing the name of a geometric quantity.
/// The times when this quantity satisfies a condition
/// specified by the arguments OP and ADJUST (described
/// below) are to be found.
///
/// Each quantity is specified by the quantity name given in
/// argument GQUANT, and by a set of parameters specified by
/// the arguments
///
/// QNPARS
/// QPNAMS
/// QCPARS
/// QDPARS
/// QIPARS
/// QLPARS
///
/// For each quantity listed here, we also show how to set up
/// these input arguments to define the quantity. See the
/// detailed discussion of these arguments below for further
/// information.
///
/// GQUANT may be any of the strings:
///
/// 'ANGULAR SEPARATION'
/// 'COORDINATE'
/// 'DISTANCE'
/// 'ILLUMINATION ANGLE'
/// 'PHASE ANGLE'
/// 'RANGE RATE'
///
/// GQUANT strings are case insensitive. Values, meanings,
/// and associated parameters are discussed below.
///
/// The aberration correction parameter indicates the
/// aberration corrections to be applied to the state of the
/// target body to account for one-way light time and stellar
/// aberration. If relevant, it applies to the rotation of
/// the target body as well.
///
/// Supported aberration correction options for observation
/// (case where radiation is received by observer at ET) are:
///
/// 'NONE' No correction.
/// 'LT' Light time only.
/// 'LT+S' Light time and stellar aberration.
/// 'CN' Converged Newtonian (CN) light time.
/// 'CN+S' CN light time and stellar aberration.
///
/// Supported aberration correction options for transmission
/// (case where radiation is emitted from observer at ET)
/// are:
///
/// 'XLT' Light time only.
/// 'XLT+S' Light time and stellar aberration.
/// 'XCN' Converged Newtonian (CN) light time.
/// 'XCN+S' CN light time and stellar aberration.
///
/// For detailed information, see the geometry finder
/// required reading, gf.req.
///
/// Case, leading and trailing blanks are not significant in
/// aberration correction parameter strings.
///
///
/// ANGULAR SEPARATION
///
/// is the apparent angular separation of two target
/// bodies as seen from an observing body.
///
/// Quantity Parameters:
///
/// QNPARS = 8
/// QPNAMS(1) = 'TARGET1'
/// QPNAMS(2) = 'FRAME1'
/// QPNAMS(3) = 'SHAPE1'
/// QPNAMS(4) = 'TARGET2'
/// QPNAMS(5) = 'FRAME2'
/// QPNAMS(6) = 'SHAPE2'
/// QPNAMS(7) = 'OBSERVER'
/// QPNAMS(8) = 'ABCORR'
///
/// QCPARS(1) = <name of first target>
/// QCPARS(2) = <name of body-fixed frame
/// of first target>
/// QCPARS(3) = <shape of first target>
/// QCPARS(4) = <name of second target>
/// QCPARS(5) = <name of body-fixed frame
/// of second target>
/// QCPARS(6) = <shape of second target>
/// QCPARS(7) = <name of observer>
/// QCPARS(8) = <aberration correction>
///
/// The target shape model specifiers may be set to either
/// of the values
///
/// 'POINT'
/// 'SPHERE'
///
/// The shape models for the two bodies need not match.
///
/// Spherical models have radii equal to the longest
/// equatorial radius of the PCK-based tri-axial
/// ellipsoids used to model the respective bodies. When
/// both target bodies are modeled as spheres, the angular
/// separation between the bodies is the angle between the
/// closest points on the limbs of the spheres, as viewed
/// from the vantage point of the observer. If the limbs
/// overlap, the angular separation is negative.
///
/// (In this case, the angular separation is the angle
/// between the centers of the spheres minus the sum of
/// the apparent angular radii of the spheres.)
///
///
/// COORDINATE
///
/// is a coordinate of a specified vector in a specified
/// reference frame and coordinate system. For example, a
/// coordinate can be the Z component of the earth-sun
/// vector in the J2000 reference frame, or the latitude
/// of the nearest point on Mars to an orbiting
/// spacecraft, expressed relative to the IAU_MARS
/// reference frame.
///
/// The method by which the vector is defined is indicated
/// by the
///
/// 'VECTOR DEFINITION'
///
/// parameter. Allowed values and meanings of this
/// parameter are:
///
/// 'POSITION'
///
/// The vector is defined by the position of a
/// target relative to an observer.
///
/// 'SUB-OBSERVER POINT'
///
/// The vector is the sub-observer point on a
/// specified target body.
///
/// 'SURFACE INTERCEPT POINT'
///
/// The vector is defined as the intercept point of
/// a vector from the observer to the target body.
///
/// Some vector definitions, such as the sub-observer
/// point, may be specified by a variety of methods, so a
/// parameter is provided to select the computation
/// method. The computation method parameter name is
///
/// 'METHOD'
///
/// If the vector definition is
///
/// 'POSITION'
///
/// the 'METHOD' parameter must be set to blank:
///
/// ' '
///
/// If the vector definition is
///
/// 'SUB-OBSERVER POINT'
///
/// the 'METHOD' parameter must be set to either:
///
/// 'Near point: ellipsoid'
/// 'Intercept: ellipsoid'
///
/// If the vector definition is
///
/// 'SURFACE INTERCEPT POINT'
///
/// the 'METHOD' parameter must be set to:
///
/// 'Ellipsoid'
///
/// The intercept computation uses a triaxial
/// ellipsoid to model the surface of the target
/// body. The ellipsoid's radii must be available in
/// the kernel pool.
///
/// The supported coordinate systems and coordinate names:
///
/// Coordinate System Coordinates Range
/// ----------------- ----------------- ------------
///
/// 'RECTANGULAR' 'X'
/// 'Y'
/// 'Z'
///
/// 'LATITUDINAL' 'RADIUS'
/// 'LONGITUDE' (-Pi,Pi]
/// 'LATITUDE' [-Pi/2,Pi/2]
///
/// 'RA/DEC' 'RANGE'
/// 'RIGHT ASCENSION' [0,2Pi)
/// 'DECLINATION' [-Pi/2,Pi/2]
///
/// 'SPHERICAL' 'RADIUS'
/// 'COLATITUDE' [0,Pi]
/// 'LONGITUDE' (-Pi,Pi]
///
/// 'CYLINDRICAL' 'RADIUS'
/// 'LONGITUDE' [0,2Pi)
/// 'Z'
///
/// 'GEODETIC' 'LONGITUDE' (-Pi,Pi]
/// 'LATITUDE' [-Pi/2,Pi/2]
/// 'ALTITUDE'
///
/// 'PLANETOGRAPHIC' 'LONGITUDE' [0,2Pi)
/// 'LATITUDE' [-Pi/2,Pi/2]
/// 'ALTITUDE'
///
/// When geodetic coordinates are selected, the radii used
/// are those of the central body associated with the
/// reference frame. For example, if IAU_MARS is the
/// reference frame, then geodetic coordinates are
/// calculated using the radii of Mars taken from a SPICE
/// planetary constants kernel. One cannot ask for
/// geodetic coordinates for a frame which doesn't have an
/// extended body as its center.
///
/// Reference frame names must be recognized by the SPICE
/// frame subsystem.
///
/// Quantity Parameters:
///
/// QNPARS = 10
/// QPNAMS(1) = 'TARGET'
/// QPNAMS(2) = 'OBSERVER'
/// QPNAMS(3) = 'ABCORR'
/// QPNAMS(4) = 'COORDINATE SYSTEM'
/// QPNAMS(5) = 'COORDINATE'
/// QPNAMS(6) = 'REFERENCE FRAME'
/// QPNAMS(7) = 'VECTOR DEFINITION'
/// QPNAMS(8) = 'METHOD'
/// QPNAMS(9) = 'DREF'
/// QPNAMS(10) = 'DVEC'
///
/// Only 'SURFACE INTERCEPT POINT' searches make use of
/// the 'DREF' and 'DVEC' parameters.
///
/// QCPARS(1) = <name of target>
/// QCPARS(2) = <name of observer>
/// QCPARS(3) = <aberration correction>
/// QCPARS(4) = <coordinate system name>
/// QCPARS(5) = <coordinate name>
/// QCPARS(6) = <target reference frame name>
/// QCPARS(7) = <vector definition>
/// QCPARS(8) = <computation method>
/// QCPARS(9) = <reference frame of DVEC pointing
/// vector, defined in QDPARS>
///
/// QDPARS(1) = <DVEC pointing vector x component
/// from observer>
/// QDPARS(2) = <DVEC pointing vector y component
/// from observer>
/// QDPARS(3) = <DVEC pointing vector z component
/// from observer>
///
/// DISTANCE
///
/// is the apparent distance between a target body and an
/// observing body. Distances are always measured between
/// centers of mass.
///
/// Quantity Parameters:
///
/// QNPARS = 3
/// QPNAMS(1) = 'TARGET'
/// QPNAMS(2) = 'OBSERVER'
/// QPNAMS(3) = 'ABCORR'
///
/// QCPARS(1) = <name of target>
/// QCPARS(2) = <name of observer>
/// QCPARS(3) = <aberration correction>
///
///
/// ILLUMINATION ANGLE
///
/// is any of the illumination angles
///
/// emission
/// phase
/// solar incidence
///
/// defined at a surface point on a target body. These
/// angles are defined as in the SPICELIB routine ILUMIN.
///
/// Quantity Parameters:
///
/// QNPARS = 8
/// QPNAMS(1) = 'TARGET'
/// QPNAMS(2) = 'ILLUM'
/// QPNAMS(3) = 'OBSERVER'
/// QPNAMS(4) = 'ABCORR'
/// QPNAMS(5) = 'FRAME'
/// QPNAMS(6) = 'ANGTYP'
/// QPNAMS(7) = 'METHOD'
/// QPNAMS(8) = 'SPOINT'
///
/// QCPARS(1) = <name of target>
/// QCPARS(1) = <name of illumination source>
/// QCPARS(3) = <name of observer>
/// QCPARS(4) = <aberration correction>
/// QCPARS(5) = <target body-fixed frame>
/// QCPARS(6) = <type of illumination angle>
/// QCPARS(7) = <computation method>
///
/// The surface point is specified using rectangular
/// coordinates in the specified body-fixed frame.
///
/// QDPARS(1) = <X coordinate of surface point>
/// QDPARS(2) = <Y coordinate of surface point>
/// QDPARS(3) = <Z coordinate of surface point>
///
///
/// PHASE ANGLE
///
/// is the apparent phase angle between a target body
/// center and an illuminating body center as seen from an
/// observer.
///
/// Quantity Parameters:
///
/// QNPARS = 4
/// QPNAMS(1) = 'TARGET'
/// QPNAMS(2) = 'OBSERVER'
/// QPNAMS(3) = 'ABCORR'
/// QPNAMS(4) = 'ILLUM'
///
/// QCPARS(1) = <name of target>
/// QCPARS(2) = <name of observer>
/// QCPARS(3) = <aberration correction>
/// QCPARS(4) = <name of illuminating body>
///
///
/// RANGE RATE
///
/// is the apparent range rate between a target body and
/// an observing body.
///
/// Quantity Parameters:
///
/// QNPARS = 3
/// QPNAMS(1) = 'TARGET'
/// QPNAMS(2) = 'OBSERVER'
/// QPNAMS(3) = 'ABCORR'
///
/// QCPARS(1) = <name of target>
/// QCPARS(2) = <name of observer>
/// QCPARS(3) = <aberration correction>
///
/// QNPARS is the count of quantity parameter definition parameters.
/// These parameters supply the quantity-specific information
/// needed to fully define the quantity used in the search
/// performed by this routine.
///
/// QPNAMS is an array of names of quantity definition parameters.
/// The names occupy elements 1:QNPARS of this array. The
/// value associated with the Ith element of QPNAMS is
/// located in element I of the parameter value argument
/// having data type appropriate for the parameter:
///
/// Data Type Argument
/// --------- --------
/// Character strings QCPARS
/// Double precision numbers QDPARS
/// Integers QIPARS
/// Logicals QLPARS
///
/// The order in which the parameter names are listed is
/// unimportant, as long as the corresponding parameter
/// values are listed in the same order.
///
/// The names in QPNAMS are case-insensitive.
///
/// See the description of the input argument GQUANT for a
/// discussion of the parameter names and values associated
/// with a given quantity.
///
/// QCPARS,
/// QDPARS,
/// QIPARS,
/// QLPARS are, respectively, parameter value arrays of types
///
/// CHARACTER*(*) QCPARS
/// DOUBLE PRECISION QDPARS
/// INTEGER QIPARS
/// LOGICAL QLPARS
///
/// The value associated with the Ith name in the array
/// QPNAMS resides in the Ith element of whichever of these
/// arrays has the appropriate data type.
///
/// All of these arrays should be declared with dimension at
/// least QNPARS.
///
/// The names in the array QCPARS are case-insensitive.
///
/// Note that there is no required order for QPNAMS/Q*PARS
/// pairs.
///
/// See the description of the input argument GQUANT for a
/// discussion of the parameter names and values associated
/// with a given quantity.
///
/// OP is a scalar string comparison operator indicating the
/// numeric constraint of interest. Values are:
///
/// '>' value of geometric quantity greater than
/// some reference (REFVAL).
///
/// '=' value of geometric quantity equal to some
/// reference (REFVAL).
///
/// '<' value of geometric quantity less than some
/// reference (REFVAL).
///
/// 'ABSMAX' The geometric quantity is at an absolute
/// maximum.
///
/// 'ABSMIN' The geometric quantity is at an absolute
/// minimum.
///
/// 'LOCMAX' The geometric quantity is at a local
/// maximum.
///
/// 'LOCMIN' The geometric quantity is at a local
/// minimum.
///
/// The caller may indicate that the region of interest is
/// the set of time intervals where the quantity is within a
/// specified distance of an absolute extremum. The argument
/// ADJUST (described below) is used to specified this
/// distance.
///
/// Local extrema are considered to exist only in the
/// interiors of the intervals comprising the confinement
/// window: a local extremum cannot exist at a boundary point
/// of the confinement window.
///
/// Case is not significant in the string OP.
///
/// REFVAL is the reference value used to define an equality or
/// inequality to be satisfied by the geometric quantity. The
/// units of REFVAL are radians, radians/sec, km, or km/sec
/// as appropriate.
///
/// TOL is a tolerance value used to determine convergence of
/// root-finding operations. TOL is measured in ephemeris
/// seconds and must be greater than zero.
///
/// ADJUST is the amount by which the quantity is allowed to vary
/// from an absolute extremum.
///
/// If the search is for an absolute minimum is performed,
/// the resulting window contains time intervals when the
/// geometric quantity GQUANT has values between ABSMIN and
/// ABSMIN + ADJUST.
///
/// If the search is for an absolute maximum, the
/// corresponding range is between ABSMAX - ADJUST and
/// ABSMAX.
///
/// ADJUST is not used for searches for local extrema,
/// equality or inequality conditions and must have value
/// zero for such searches. ADJUST must not be negative.
///
/// CNFINE is a SPICE window that confines the time period over
/// which the specified search is conducted. CNFINE may
/// consist of a single interval or a collection of
/// intervals.
///
/// In some cases the confinement window can be used to
/// greatly reduce the time period that must be searched
/// for the desired solution. See the $Particulars section
/// below for further discussion.
///
/// See the $Examples section below for a code example
/// that shows how to create a confinement window.
///
/// CNFINE must be initialized by the caller via the
/// SPICELIB routine SSIZED.
///
/// In some cases the observer's state may be computed at
/// times outside of CNFINE by as much as 2 seconds. See
/// $Particulars for details.
///
/// RPT is a logical variable which controls whether the progress
/// reporter is enabled. When RPT is .TRUE., progress
/// reporting is enabled and the routines UDREPI, UDREPU, and
/// UDREPF (see descriptions below) are used to report
/// progress.
///
/// UDREPI is the name of the user specified routine that
/// initializes a progress report. When progress reporting is
/// enabled, UDREPI is called at the start of a search. The
/// calling sequence of UDREPI is
///
/// UDREPI ( CNFINE, SRCPRE, SRCSUF )
///
/// DOUBLE PRECISION CNFINE ( LBCELL : * )
/// CHARACTER*(*) SRCPRE
/// CHARACTER*(*) SRCSUF
///
/// where
///
/// CNFINE
///
/// is a confinement window specifying the time period over
/// which a search is conducted, and
///
/// SRCPRE
/// SRCSUF
///
/// are prefix and suffix strings used in the progress
/// report: these strings are intended to bracket a
/// representation of the fraction of work done. For example,
/// when the SPICELIB progress reporting functions are used,
/// if SRCPRE and SRCSUF are, respectively,
///
/// 'Occultation/transit search'
/// 'done.'
///
/// the progress report display at the end of the search will
/// be:
///
/// Occultation/transit search 100.00% done.
///
/// If the user doesn't wish to provide a custom set of
/// progress reporting functions, the SPICELIB routine
///
/// GFREPI
///
/// may be used.
///
/// UDREPU is the name of the user specified routine that updates
/// the progress report for a search. The calling sequence of
/// UDREPU is
///
/// UDREPU (IVBEG, IVEND, ET )
///
/// DOUBLE PRECISION ET
/// DOUBLE PRECISION IVBEG
/// DOUBLE PRECISION IVEND
///
/// where ET is an epoch belonging to the confinement window,
/// IVBEG and IVEND are the start and stop times,
/// respectively of the current confinement window interval.
/// The ratio of the measure of the portion of CNFINE that
/// precedes ET to the measure of CNFINE would be a logical
/// candidate for the searches completion percentage; however
/// the method of measurement is up to the user.
///
/// If the user doesn't wish to provide a custom set of
/// progress reporting functions, the SPICELIB routine
///
/// GFREPU
///
/// may be used.
///
/// UDREPF is the name of the user specified routine that finalizes
/// a progress report. UDREPF has no arguments.
///
/// If the user doesn't wish to provide a custom set of
/// progress reporting functions, the SPICELIB routine
///
/// GFREPF
///
/// may be used.
///
/// MW is a parameter specifying the length of the SPICE
/// windows in the workspace array WORK (see description
/// below) used by this routine.
///
/// MW should be set to a number at least twice as large
/// as the maximum number of intervals required by any
/// workspace window. In many cases, it's not necessary to
/// compute an accurate estimate of how many intervals are
/// needed; rather, the user can pick a size considerably
/// larger than what's really required.
///
/// However, since excessively large arrays can prevent
/// applications from compiling, linking, or running
/// properly, sometimes MW must be set according to
/// the actual workspace requirement. A rule of thumb
/// for the number of intervals NINTVLS needed is
///
/// NINTVLS = 2*N + ( M / STEP )
///
/// where
///
/// N is the number of intervals in the confinement
/// window
///
/// M is the measure of the confinement window, in
/// units of seconds
///
/// STEP is the search step size in seconds
///
/// MW should then be set to
///
/// 2 * NINTVLS
///
/// NW is a parameter specifying the number of SPICE windows
/// in the workspace array WORK (see description below)
/// used by this routine. (The reason this dimension is
/// an input argument is that this allows run-time
/// error checking to be performed.)
///
/// BAIL is a logical flag indicating whether or not interrupt
/// signaling handling is enabled. When BAIL is set to
/// .TRUE., the input function UDBAIL (see description below)
/// is used to determine whether an interrupt has been
/// issued.
///
/// UDBAIL is the name of the user specified routine that indicates
/// whether an interrupt signal has been issued (for example,
/// from the keyboard). UDBAIL has no arguments and returns
/// a LOGICAL value. The return value is .TRUE. if an
/// interrupt has been issued; otherwise the value is .FALSE.
///
/// GFEVNT uses UDBAIL only when BAIL (see above) is set
/// to .TRUE., indicating that interrupt handling is
/// enabled. When interrupt handling is enabled, GFEVNT
/// and routines in its call tree will call UDBAIL to
/// determine whether to terminate processing and return
/// immediately.
///
/// If interrupt handing is not enabled, a logical
/// function must still be passed as an input argument.
/// The SPICELIB function
///
/// GFBAIL
///
/// may be used for this purpose.
///
/// RESULT is a double precision SPICE window which will contain
/// the search results. RESULT must be declared and
/// initialized with sufficient size to capture the full
/// set of time intervals within the search region on which
/// the specified condition is satisfied.
///
/// RESULT must be initialized by the caller via the
/// SPICELIB routine SSIZED.
///
/// If RESULT is non-empty on input, its contents will be
/// discarded before GFEVNT conducts its search.
/// ```
///
/// # Detailed Output
///
/// ```text
/// WORK is an array used to store workspace windows.
///
/// This array should be declared by the caller as shown:
///
/// DOUBLE PRECISION WORK ( LBCELL : MW, NW )
///
/// WORK need not be initialized by the caller.
///
/// WORK is modified by this routine. The caller should
/// re-initialize this array before attempting to use it for
/// any other purpose.
///
/// RESULT is a SPICE window representing the set of time intervals,
/// within the confinement period, when the specified
/// geometric event occurs.
///
/// The endpoints of the time intervals comprising RESULT
/// are interpreted as seconds past J2000 TDB.
///
/// If the search is for local extrema, or for absolute
/// extrema with ADJUST set to zero, then normally each
/// interval of RESULT will be a singleton: the left and
/// right endpoints of each interval will be identical.
///
/// If no times within the confinement window satisfy the
/// search criteria, RESULT will be returned with a
/// cardinality of zero.
/// ```
///
/// # Parameters
///
/// ```text
/// LBCELL is the SPICE cell lower bound.
///
/// MAXPAR is the maximum number of parameters required to define
/// any quantity. MAXPAR may grow if new quantities require
/// more parameters. MAXPAR is currently set to 10.
///
/// CNVTOL is the default convergence tolerance used by the
/// high-level GF search API routines. This tolerance is
/// used to terminate searches for binary state transitions:
/// when the time at which a transition occurs is bracketed
/// by two times that differ by no more than
/// SPICE_GF_CNVTOL, the transition time is considered
/// to have been found.
/// ```
///
/// # Exceptions
///
/// ```text
/// 1) There are varying requirements on how distinct the three
/// objects, QCPARS, must be. If the requirements are not met, an,
/// an error is signaled by a routine in the call tree of this
/// routine.
///
/// When GQUANT has value 'ANGULAR SEPARATION' then all three
/// must be distinct.
///
/// When GQUANT has value of either
///
/// 'DISTANCE'
/// 'COORDINATE'
/// 'RANGE RATE'
///
/// the QCPARS(1) and QCPARS(2) objects must be distinct.
///
/// 2) If any of the bodies involved do not have NAIF ID codes, an
/// error is signaled by a routine in the call tree of this
/// routine.
///
/// 3) If the value of GQUANT is not recognized as a valid value,
/// the error SPICE(NOTRECOGNIZED) is signaled.
///
/// 4) If the number of quantity definition parameters, QNPARS is
/// greater than the maximum allowed value, MAXPAR, the error
/// SPICE(INVALIDCOUNT) is signaled.
///
/// 5) If the proper required parameters are not supplied in QNPARS,
/// the error SPICE(MISSINGVALUE) is signaled.
///
/// 6) If the comparison operator, OP, is not recognized, the error
/// SPICE(NOTRECOGNIZED) is signaled.
///
/// 7) If the window size MW is less than 2, an error is signaled by
/// a routine in the call tree of this routine.
///
/// 8) If the number of workspace windows NW is too small for the
/// required search, an error is signaled by a routine in the call
/// tree of this routine.
///
/// 9) If TOL is not greater than zero, an error is signaled by a
/// routine in the call tree of this routine.
///
/// 10) If ADJUST is negative, an error is signaled by a routine in
/// the call tree of this routine.
///
/// 11) If ADJUST has a non-zero value when OP has any value other
/// than 'ABSMIN' or 'ABSMAX', an error is signaled by a routine
/// in the call tree of this routine.
///
/// 12) The user must take care when searching for an extremum
/// ('ABSMAX', 'ABSMIN', 'LOCMAX', 'LOCMIN') of an angular
/// quantity. Problems are most common when using the 'COORDINATE'
/// value of GQUANT with 'LONGITUDE' or 'RIGHT ASCENSION' values
/// for the coordinate name. Since these quantities are cyclical,
/// rather than monotonically increasing or decreasing, an
/// extremum may be hard to interpret. In particular, if an
/// extremum is found near the cycle boundary (-Pi for
/// 'LONGITUDE', 2*Pi for 'RIGHT ASCENSION') it may not be
/// numerically reasonable. For example, the search for times when
/// a longitude coordinate is at its absolute maximum may result
/// in a time when the longitude value is -Pi, due to roundoff
/// error.
///
/// 13) If operation of this routine is interrupted, the output result
/// window will be invalid.
/// ```
///
/// # Files
///
/// ```text
/// Appropriate SPK and PCK kernels must be loaded by the
/// calling program before this routine is called.
///
/// The following data are required:
///
/// - SPK data: ephemeris data for target, source and observer that
/// describes the ephemeris of these objects for the period
/// defined by the confinement window, CNFINE must be
/// loaded. If aberration corrections are used, the states of
/// target and observer relative to the solar system barycenter
/// must be calculable from the available ephemeris data.
/// Typically ephemeris data are made available by loading one
/// or more SPK files via FURNSH.
///
/// - PCK data: bodies are assumed to be spherical and must have a
/// radius loaded from the kernel pool. Typically this is done by
/// loading a text PCK file via FURNSH. If the bodies are
/// triaxial, the largest radius is chosen as that of the
/// equivalent spherical body.
///
/// - In some cases the observer's state may be computed at times
/// outside of CNFINE by as much as 2 seconds; data required to
/// compute this state must be provided by loaded kernels. See
/// $Particulars for details.
///
/// In all cases, kernel data are normally loaded once per program
/// run, NOT every time this routine is called.
/// ```
///
/// # Particulars
///
/// ```text
/// This routine provides the SPICE GF subsystem's general interface
/// to determines time intervals when the value of some
/// geometric quantity related to one or more objects and an observer
/// satisfies a user specified constraint. It puts these times in a
/// result window called RESULT. It does this by first finding
/// windows when the quantity of interest is either monotonically
/// increasing or decreasing. These windows are then manipulated to
/// give the final result.
///
/// Applications that require do not require support for progress
/// reporting, interrupt handling, non-default step or refinement
/// functions, or non-default convergence tolerance normally should
/// call a high level geometry quantity routine rather than
/// this routine.
///
/// The Search Process
/// ==================
///
/// Regardless of the type of constraint selected by the caller, this
/// routine starts the search for solutions by determining the time
/// periods, within the confinement window, over which the specified
/// geometric quantity function is monotone increasing and monotone
/// decreasing. Each of these time periods is represented by a SPICE
/// window. Having found these windows, all of the quantity
/// function's local extrema within the confinement window are known.
/// Absolute extrema then can be found very easily.
///
/// Within any interval of these "monotone" windows, there will be at
/// most one solution of any equality constraint. Since the boundary
/// of the solution set for any inequality constraint is contained in
/// the union of
///
/// - the set of points where an equality constraint is met
///
/// - the boundary points of the confinement window
///
/// the solutions of both equality and inequality constraints can be
/// found easily once the monotone windows have been found.
///
///
/// Step Size
/// =========
///
/// The monotone windows (described above) are found using a two-step
/// search process. Each interval of the confinement window is
/// searched as follows: first, the input step size is used to
/// determine the time separation at which the sign of the rate of
/// change of quantity function will be sampled. Starting at
/// the left endpoint of an interval, samples will be taken at each
/// step. If a change of sign is found, a root has been bracketed; at
/// that point, the time at which the time derivative of the quantity
/// function is zero can be found by a refinement process, for
/// example, using a binary search.
///
/// Note that the optimal choice of step size depends on the lengths
/// of the intervals over which the quantity function is monotone:
/// the step size should be shorter than the shortest of these
/// intervals (within the confinement window).
///
/// The optimal step size is *not* necessarily related to the lengths
/// of the intervals comprising the result window. For example, if
/// the shortest monotone interval has length 10 days, and if the
/// shortest result window interval has length 5 minutes, a step size
/// of 9.9 days is still adequate to find all of the intervals in the
/// result window. In situations like this, the technique of using
/// monotone windows yields a dramatic efficiency improvement over a
/// state-based search that simply tests at each step whether the
/// specified constraint is satisfied. The latter type of search can
/// miss solution intervals if the step size is longer than the
/// shortest solution interval.
///
/// Having some knowledge of the relative geometry of the targets and
/// observer can be a valuable aid in picking a reasonable step size.
/// In general, the user can compensate for lack of such knowledge by
/// picking a very short step size; the cost is increased computation
/// time.
///
/// Note that the step size is not related to the precision with which
/// the endpoints of the intervals of the result window are computed.
/// That precision level is controlled by the convergence tolerance.
///
///
/// Convergence Tolerance
/// =====================
///
/// Once a root has been bracketed, a refinement process is used to
/// narrow down the time interval within which the root must lie.
/// This refinement process terminates when the location of the root
/// has been determined to within an error margin called the
/// "convergence tolerance," passed to this routine as 'tol'.
///
/// The GF subsystem defines a parameter, CNVTOL (from gf.inc), as a
/// default tolerance. This represents a "tight" tolerance value
/// so that the tolerance doesn't become the limiting factor in the
/// accuracy of solutions found by this routine. In general the
/// accuracy of input data will be the limiting factor.
///
/// Making the tolerance tighter than CNVTOL is unlikely to
/// be useful, since the results are unlikely to be more accurate.
/// Making the tolerance looser will speed up searches somewhat,
/// since a few convergence steps will be omitted. However, in most
/// cases, the step size is likely to have a much greater affect
/// on processing time than would the convergence tolerance.
///
///
/// The Confinement Window
/// ======================
///
/// The simplest use of the confinement window is to specify a time
/// interval within which a solution is sought. However, the
/// confinement window can, in some cases, be used to make searches
/// more efficient. Sometimes it's possible to do an efficient search
/// to reduce the size of the time period over which a relatively
/// slow search of interest must be performed.
///
/// Certain types of searches require the state of the observer,
/// relative to the solar system barycenter, to be computed at times
/// slightly outside the confinement window CNFINE. The time window
/// that is actually used is the result of "expanding" CNFINE by a
/// specified amount "T": each time interval of CNFINE is expanded by
/// shifting the interval's left endpoint to the left and the right
/// endpoint to the right by T seconds. Any overlapping intervals are
/// merged. (The input argument CNFINE is not modified.)
///
/// The window expansions listed below are additive: if both
/// conditions apply, the window expansion amount is the sum of the
/// individual amounts.
///
/// - If a search uses an equality constraint, the time window
/// over which the state of the observer is computed is expanded
/// by 1 second at both ends of all of the time intervals
/// comprising the window over which the search is conducted.
///
/// - If a search uses stellar aberration corrections, the time
/// window over which the state of the observer is computed is
/// expanded as described above.
///
/// When light time corrections are used, expansion of the search
/// window also affects the set of times at which the light time-
/// corrected state of the target is computed.
///
/// In addition to the possible 2 second expansion of the search
/// window that occurs when both an equality constraint and stellar
/// aberration corrections are used, round-off error should be taken
/// into account when the need for data availability is analyzed.
/// ```
///
/// # Examples
///
/// ```text
/// The numerical results shown for this example may differ across
/// platforms. The results depend on the SPICE kernels used as
/// input, the compiler and supporting libraries, and the machine
/// specific arithmetic implementation.
///
/// 1) Conduct a DISTANCE search using the default GF progress
/// reporting capability.
///
/// The program will use console I/O to display a simple
/// ASCII-based progress report.
///
/// The program will find local maximums of the distance from
/// Earth to Moon with light time and stellar aberration
/// corrections to model the apparent positions of the Moon.
///
/// Use the meta-kernel shown below to load the required SPICE
/// kernels.
///
///
/// KPL/MK
///
/// File name: gfevnt_ex1.tm
///
/// This meta-kernel is intended to support operation of SPICE
/// example programs. The kernels shown here should not be
/// assumed to contain adequate or correct versions of data
/// required by SPICE-based user applications.
///
/// In order for an application to use this meta-kernel, the
/// kernels referenced here must be present in the user's
/// current working directory.
///
/// The names and contents of the kernels referenced
/// by this meta-kernel are as follows:
///
/// File name Contents
/// --------- --------
/// de414.bsp Planetary ephemeris
/// pck00008.tpc Planet orientation and
/// radii
/// naif0009.tls Leapseconds
///
///
/// \begindata
///
/// KERNELS_TO_LOAD = ( 'de414.bsp',
/// 'pck00008.tpc',
/// 'naif0009.tls' )
///
/// \begintext
///
/// End of meta-kernel
///
///
/// Example code begins here.
///
///
/// PROGRAM GFEVNT_EX1
/// IMPLICIT NONE
///
/// C
/// C SPICELIB functions
/// C
/// DOUBLE PRECISION SPD
/// INTEGER WNCARD
///
/// INCLUDE 'gf.inc'
///
/// C
/// C Local variables and initial parameters.
/// C
/// INTEGER LBCELL
/// PARAMETER ( LBCELL = -5 )
///
/// INTEGER LNSIZE
/// PARAMETER ( LNSIZE = 80 )
///
/// INTEGER MAXPAR
/// PARAMETER ( MAXPAR = 8 )
///
/// INTEGER MAXVAL
/// PARAMETER ( MAXVAL = 20000 )
///
///
/// INTEGER STRSIZ
/// PARAMETER ( STRSIZ = 40 )
///
/// INTEGER I
///
/// C
/// C Confining window
/// C
/// DOUBLE PRECISION CNFINE ( LBCELL : 2 )
///
/// C
/// C Confining window beginning and ending time strings.
/// C
/// CHARACTER*(STRSIZ) BEGSTR
/// CHARACTER*(STRSIZ) ENDSTR
///
/// C
/// C Confining window beginning and ending times
/// C
/// DOUBLE PRECISION BEGTIM
/// DOUBLE PRECISION ENDTIM
///
/// C
/// C Result window beginning and ending times for intervals.
/// C
/// DOUBLE PRECISION BEG
/// DOUBLE PRECISION END
///
/// C
/// C Geometric quantity results window, work window,
/// C bail switch and progress reporter switch.
/// C
/// DOUBLE PRECISION RESULT ( LBCELL : MAXVAL )
/// DOUBLE PRECISION WORK ( LBCELL : MAXVAL, NWDIST )
///
/// LOGICAL BAIL
/// LOGICAL GFBAIL
/// EXTERNAL GFBAIL
/// LOGICAL RPT
///
/// C
/// C Step size.
/// C
/// DOUBLE PRECISION STEP
///
/// C
/// C Geometric quantity name.
/// C
/// CHARACTER*(LNSIZE) EVENT
///
/// C
/// C Relational string
/// C
/// CHARACTER*(STRSIZ) RELATE
///
/// C
/// C Quantity definition parameter arrays:
/// C
/// INTEGER QNPARS
/// CHARACTER*(LNSIZE) QPNAMS ( MAXPAR )
/// CHARACTER*(LNSIZE) QCPARS ( MAXPAR )
/// DOUBLE PRECISION QDPARS ( MAXPAR )
/// INTEGER QIPARS ( MAXPAR )
/// LOGICAL QLPARS ( MAXPAR )
///
/// C
/// C Routines to set step size, refine transition times
/// C and report work.
/// C
/// EXTERNAL GFREFN
/// EXTERNAL GFREPI
/// EXTERNAL GFREPU
/// EXTERNAL GFREPF
/// EXTERNAL GFSTEP
///
/// C
/// C Reference and adjustment values.
/// C
/// DOUBLE PRECISION REFVAL
/// DOUBLE PRECISION ADJUST
///
/// INTEGER COUNT
///
/// C
/// C Saved variables
/// C
/// C The confinement, workspace and result windows CNFINE,
/// C WORK and RESULT are saved because this practice helps to
/// C prevent stack overflow.
/// C
/// SAVE CNFINE
/// SAVE RESULT
/// SAVE WORK
///
/// C
/// C Load leapsecond and spk kernels. The name of the
/// C meta kernel file shown here is fictitious; you
/// C must supply the name of a file available
/// C on your own computer system.
///
/// CALL FURNSH ('gfevnt_ex1.tm')
///
/// C
/// C Set a beginning and end time for confining window.
/// C
/// BEGSTR = '2001 jan 01 00:00:00.000'
/// ENDSTR = '2001 jun 30 00:00:00.000'
///
/// CALL STR2ET ( BEGSTR, BEGTIM )
/// CALL STR2ET ( ENDSTR, ENDTIM )
///
/// C
/// C Set condition for extremum.
/// C
/// RELATE = 'LOCMAX'
///
/// C
/// C Set reference value (if needed) and absolute extremum
/// C adjustment (if needed).
/// C
/// REFVAL = 0.D0
/// ADJUST = 0.D0
///
/// C
/// C Set quantity.
/// C
/// EVENT = 'DISTANCE'
///
/// C
/// C Turn on progress reporter and initialize the windows.
/// C
/// RPT = .TRUE.
/// BAIL = .FALSE.
///
/// CALL SSIZED ( 2, CNFINE )
/// CALL SSIZED ( MAXVAL, RESULT )
///
/// C
/// C Add 2 points to the confinement interval window.
/// C
/// CALL WNINSD ( BEGTIM, ENDTIM, CNFINE )
///
/// C
/// C Define input quantities.
/// C
/// QPNAMS(1) = 'TARGET'
/// QCPARS(1) = 'MOON'
///
/// QPNAMS(2) = 'OBSERVER'
/// QCPARS(2) = 'EARTH'
///
/// QPNAMS(3) = 'ABCORR'
/// QCPARS(3) = 'LT+S'
///
/// QNPARS = 3
///
/// C
/// C Set the step size to 1 day and convert to seconds.
/// C
/// STEP = 1.D-3*SPD()
///
/// CALL GFSSTP ( STEP )
///
/// C
/// C Look for solutions.
/// C
/// CALL GFEVNT ( GFSTEP, GFREFN, EVENT,
/// . QNPARS, QPNAMS, QCPARS,
/// . QDPARS, QIPARS, QLPARS,
/// . RELATE, REFVAL, CNVTOL,
/// . ADJUST, CNFINE, RPT,
/// . GFREPI, GFREPU, GFREPF,
/// . MAXVAL, NWDIST, WORK,
/// . BAIL, GFBAIL, RESULT )
///
///
/// C
/// C Check the number of intervals in the result window.
/// C
/// COUNT = WNCARD(RESULT)
///
/// WRITE (*,*) 'Found ', COUNT, ' intervals in RESULT'
/// WRITE (*,*) ' '
///
/// C
/// C List the beginning and ending points in each interval.
/// C
/// DO I = 1, COUNT
///
/// CALL WNFETD ( RESULT, I, BEG, END )
///
/// CALL TIMOUT ( BEG,
/// . 'YYYY-MON-DD HR:MN:SC.###### '
/// . // '(TDB) ::TDB ::RND', BEGSTR )
/// CALL TIMOUT ( END,
/// . 'YYYY-MON-DD HR:MN:SC.###### '
/// . // '(TDB) ::TDB ::RND', ENDSTR )
///
/// WRITE (*,*) 'Interval ', I
/// WRITE (*,*) 'Beginning TDB ', BEGSTR
/// WRITE (*,*) 'Ending TDB ', ENDSTR
/// WRITE (*,*) ' '
///
/// END DO
///
/// END
///
///
/// When this program was executed on a Mac/Intel/gfortran/64-bit
/// platform, the output was:
///
///
/// Distance pass 1 of 1 100.00% done.
///
/// Found 6 intervals in RESULT
///
/// Interval 1
/// Beginning TDB 2001-JAN-24 19:22:01.436672 (TDB)
/// Ending TDB 2001-JAN-24 19:22:01.436672 (TDB)
///
/// Interval 2
/// Beginning TDB 2001-FEB-20 21:52:07.914964 (TDB)
/// Ending TDB 2001-FEB-20 21:52:07.914964 (TDB)
///
/// Interval 3
/// Beginning TDB 2001-MAR-20 11:32:03.182345 (TDB)
/// Ending TDB 2001-MAR-20 11:32:03.182345 (TDB)
///
/// Interval 4
/// Beginning TDB 2001-APR-17 06:09:00.877038 (TDB)
/// Ending TDB 2001-APR-17 06:09:00.877038 (TDB)
///
/// Interval 5
/// Beginning TDB 2001-MAY-15 01:29:28.532819 (TDB)
/// Ending TDB 2001-MAY-15 01:29:28.532819 (TDB)
///
/// Interval 6
/// Beginning TDB 2001-JUN-11 19:44:10.855458 (TDB)
/// Ending TDB 2001-JUN-11 19:44:10.855458 (TDB)
///
///
/// Note that the progress report has the format shown below:
///
/// Distance pass 1 of 1 6.02% done.
///
/// The completion percentage was updated approximately once per
/// second.
///
/// When the program was interrupted at an arbitrary time,
/// the output was:
///
/// Distance pass 1 of 1 13.63% done.
/// Search was interrupted.
///
/// This message was written after an interrupt signal
/// was trapped. By default, the program would have terminated
/// before this message could be written.
/// ```
///
/// # Restrictions
///
/// ```text
/// 1) The kernel files to be used by GFEVNT must be loaded (normally
/// via the SPICELIB routine FURNSH) before GFEVNT is called.
///
/// 2) If using the default, constant step size routine, GFSTEP, the
/// entry point GFSSTP must be called prior to calling this
/// routine. The call syntax for GFSSTP:
///
/// CALL GFSSTP ( STEP )
/// ```
///
/// # Author and Institution
///
/// ```text
/// N.J. Bachman (JPL)
/// J. Diaz del Rio (ODC Space)
/// B.V. Semenov (JPL)
/// E.D. Wright (JPL)
/// ```
///
/// # Version
///
/// ```text
/// - SPICELIB Version 2.1.0, 27-OCT-2021 (JDR) (BVS) (NJB)
///
/// Edited the header to comply with NAIF standard.
///
/// Updated description of WORK and RESULT arguments in $Brief_I/O,
/// $Detailed_Input and $Detailed_Output.
///
/// Added SAVE statements for CNFINE, WORK and RESULT variables in
/// code example.
///
/// Added SAVE statement for DREF.
///
/// Fixed typo in $Exceptions entry #5, which referred to a non
/// existing input argument, replaced entry #7 by new entries #7
/// and #8, replaced entry #10 by new entries #10 and #11, and
/// added entry #13.
///
/// Added descriptions of MAXPAR and CNVTOL to the $Brief_I/O and
/// $Parameters sections.
///
/// Moved declaration of MAXPAR into the $Declarations section.
///
/// Updated header to describe use of expanded confinement window.
///
/// - SPICELIB Version 2.0.0, 05-SEP-2012 (EDW) (NJB)
///
/// Edit to comments to correct search description.
///
/// Edit to $Index_Entries.
///
/// Added geometric quantities:
///
/// Phase Angle
/// Illumination Angle
///
/// Code edits to implement use of ZZGFRELX in event calculations:
///
/// Range rate
/// Separation angle
/// Distance
/// Coordinate
///
/// The code changes for ZZGFRELX use should not affect the
/// numerical results of GF computations.
///
/// - SPICELIB Version 1.1.0, 09-OCT-2009 (NJB) (EDW)
///
/// Edits to argument descriptions.
///
/// Added geometric quantities:
///
/// Range Rate
///
/// - SPICELIB Version 1.0.0, 19-MAR-2009 (NJB) (EDW)
/// ```
//$Procedure GFEVNT ( GF, Geometric event finder )