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
|
<!DOCTYPE doctype PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy for Mac OS X (vers 31 October 2006 - Apple Inc. build 16.4), see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="GENERATOR" content="Mozilla/4.78 [en] (X11; U; Linux 2.4.7-10 i686) [Netscape]">
<title>SAMP</title>
</head>
<body link="#0000FF" alink="#FF0000" vlink="#551A8B">
<h3><img alt="" src="../sun.gif" height="98" align="middle" width="100"> SAMP</h3>
<blockquote>
<p>SAMP is a messaging protocol that enables astronomy software tools to interoperate and communicate. Broadly speaking, SAMP is an abstract framework for loosely-coupled, asynchronous, RPC-like and/or event-based communication, based on a central service providing multi-directional publish/subscribe message brokering. The message semantics are extensible and use structured but weakly-typed data. For more information on SAMP, please click <a href="http://www.ivoa.net/Documents/latest/SAMP.html">here</a>.</p>
<p>The samp implementation for DS9 is based on the <a href="xpa.html">XPA</a> model with 2 private calls:</p>
<tt>ds9.get<br>
Arguments<br>
cmd (string) required<br>
url (string) optional<br>
Returned value<br>
OK (samp.result map)<br>
value (string) optional<br>
url (string) optional<br>
ERROR (samp.error map)<br>
samp.errortxt (string)<br>
<br>
ds9.set<br>
Arguments<br>
cmd (string) required<br>
url (string) optional<br>
Returned value<br>
OK<br>
ERROR (samp.error map)<br>
samp.errortxt (string)<br></tt>
<p><tt>ds9.set</tt> maybe called via notification, call and call/wait. <tt>ds9.get</tt> can only be called via call and call/wait. Most of the <tt>ds9.get</tt> calls return a value string, but a few will return a url instead.</p>
<tt><a href="#twomass">2mass</a><br>
<a href="#threed">3d</a><br>
<a href="#about">about</a><br>
<a href="#analysis">analysis</a><br>
<a href="#array">array</a><br>
<a href="#background">background</a><br>
<a href="#backup">backup</a><br>
<a href="#bin">bin</a><br>
<a href="#blink">blink</a><br>
<a href="#block">block</a><br>
<a href="#catalog">catalog</a><br>
<a href="#cd">cd</a><br>
<a href="#cmap">cmap</a><br>
<a href="#colorbar">colorbar</a><br>
<a href="#console">console</a><br>
<a href="#contour">contour</a><br>
<a href="#crop">crop</a><br>
<a href="#crosshair">crosshair</a><br>
<a href="#cube">cube</a><br>
<a href="#cursor">cursor</a><br>
<a href="#data">data</a><br>
<a href="#dsssao">dsssao</a><br>
<a href="#dsseso">dsseso</a><br>
<a href="#dssstsci">dssstsci</a><br>
<a href="#envi">envi</a><br>
<a href="#exit">exit</a><br>
<a href="#export">export</a><br>
<a href="#file">file</a><br>
<a href="#fits">fits</a><br>
<a href="#frame">frame</a><br>
<a href="#gif">gif</a><br>
<a href="#grid">grid</a><br>
<a href="#header">header</a><br>
<a href="#height">height</a><br>
<a href="#iconify">iconify</a><br>
<a href="#iexam">iexam</a><br>
<a href="#iis">iis</a><br>
<a href="#jpeg">jpeg</a><br>
<a href="#lock">lock</a><br>
<a href="#lower">lower</a><br>
<a href="#magnifier">magnifier</a><br>
<a href="#mask">mask</a><br>
<a href="#match">match</a><br>
<a href="#mecube">mecube</a><br>
<a href="#minmax">minmax</a><br>
<a href="#mode">mode</a><br>
<a href="#mosaic">mosaic</a><br>
<a href="#mosaicimage">mosaicimage</a><br>
<a href="#movie">movie</a><br>
<a href="#multiframe">multiframe</a><br>
<a href="#nameserver">nameserver</a><br>
<a href="#nan">nan</a><br>
<a href="#nrrd">nrrd</a><br>
<a href="#nvss">nvss</a><br>
<a href="#orient">orient</a><br>
<a href="#pagesetup">pagesetup</a><br>
<a href="#pan">pan</a><br>
<a href="#pixeltable">pixeltable</a><br>
<a href="#plot">plot</a><br>
<a href="#png">png</a><br>
<a href="#precision">precision</a><br>
<a href="#prefs">prefs</a><br>
<a href="#preserve">preserve</a><br>
<a href="#psprint">psprint</a><br>
<a href="#print">print</a><br>
<a href="#exit">quit</a><br>
<a href="#raise">raise</a><br>
<a href="#regions">regions</a><br>
<a href="#restore">restore</a><br>
<a href="#rgb">rgb</a><br>
<a href="#rgbarray">rgbarray</a><br>
<a href="#rgbcube">rgbcube</a><br>
<a href="#rgbimage">rgbimage</a><br>
<a href="#rotate">rotate</a><br>
<a href="#samp">samp</a><br>
<a href="#save">save</a><br>
<a href="#saveimage">saveimage</a><br>
<a href="#scale">scale</a><br>
<a href="#shm">shm</a><br>
<a href="#sia">sia</a><br>
<a href="#single">single</a><br>
<a href="#skyview">skyview</a><br>
<a href="#sleep">sleep</a><br>
<a href="#smooth">smooth</a><br>
<a href="#source">source</a><br>
<a href="#tcl">tcl</a><br>
<a href="#threads">threads</a><br>
<a href="#tiff">tiff</a><br>
<a href="#tile">tile</a><br>
<a href="#update">update</a><br>
<a href="#url">url</a><br>
<a href="#version">version</a><br>
<a href="#view">view</a><br>
<a href="#vla">vla</a><br>
<a href="#vlss">vlss</a><br>
<a href="#vo">vo</a><br>
<a href="#wcs">wcs</a><br>
<a href="#web">web</a><br>
<a href="#width">width</a><br>
<a href="#zscale">zscale</a><br>
<a href="#zoom">zoom</a><br></tt>
<p><b><a name="twomass" id="twomass"></a>2mass</b></p>
<p>Support for 2MASS Digital Sky Survey.</p>
<tt>Syntax:<br>
2mass []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[survey j|h|k]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
2mass name<br>
2mass coord<br>
2mass size<br>
2mass save<br>
2mass frame<br>
2mass survey<br>
<br>
ds9.set(string cmd)<br>
2mass<br>
2mass m31<br>
2mass name m31<br>
2mass name clear<br>
2mass 00:42:44.404 +41:16:08.78<br>
2mass size 60 60 arcmin<br>
2mass save yes<br>
2mass frame current<br>
2mass update frame<br>
2mass survey j<br>
2mass open<br>
2mass close<br></tt>
<p><b><a name="threed" id="threed"></a>3d</b></p>
<p>Support for 3D frame.</p>
<tt>Syntax:<br>
3d []<br>
[view <az> <el>]<br>
[az <az>]<br>
[el <el>]<br>
[scale <scale>]<br>
[method mip|aip]<br>
[background none|azimuth|elevation]<br>
[border yes|no]<br>
[border color <color>]<br>
[highlite yes|no]<br>
[hightlite color <color>]<br>
[compass yes|no]<br>
[compass color <color>]<br>
[match]<br>
[lock [yes|no]]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
3d view<br>
3d az<br>
3d el<br>
3d scale<br>
3d method<br>
3d background<br>
3d border<br>
3d border color<br>
3d highlite<br>
3d highlite color<br>
3d compass<br>
3d compass color<br>
3d lock<br>
<br>
ds9.set(string cmd)<br>
3d # create new 3D frame<br>
3d view 45 30<br>
3d az 45<br>
3d el 30<br>
3d scale 10<br>
3d method mip<br>
3d background azimuth<br>
3d border yes<br>
3d border color red<br>
3d highlite yes<br>
3d highlite color red<br>
3d compass yes<br>
3d compass color red<br>
3d match<br>
3d lock yes<br>
3d open<br>
3d close<br></tt>
<p><b><a name="about" id="about"></a>about</b></p>
<p>Get DS9 credits.</p>
<tt>Syntax:<br>
about<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
about<br></tt>
<p><b><a name="align" id="align"></a>align</b></p>
<p>Controls the World Coordinate System alignment for the current frame.</p>
<tt>Syntax:<br>
align []<br>
[yes|no]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
align<br>
<br>
ds9.set(string cmd)<br>
align yes</tt><br>
<p><b><a name="analysis" id="analysis"></a>analysis</b></p>
<p>Control external analysis tasks. Tasks are numbered as they are loaded, starting with 0. Can also be used to display a message and display text in the text dialog window.</p>
<tt>Syntax:<br>
analysis [<task number>]<br>
[<filename>]<br>
[task <task number>|<task name>]<br>
[load <filename>]<br>
[clear]<br>
[clear][load <filename>]<br>
[message ok|okcancel|yesno <message>]<br>
[entry <message>]<br>
[text]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
analysis<br>
analysis task<br>
analysis entry {Please enter something}<br>
analysis entry okcancel {Hello World}<br>
<br>
ds9.set(string cmd)<br>
analysis 0 # invoke first analysis task<br>
analysis task 0<br>
analysis task foobar<br>
analysis task {foo bar}<br>
analysis my.ans<br>
analysis load my.ans<br>
analysis clear<br>
analysis clear load my.ans<br>
analysis message {This is a message}<br>
analysis text {this is text}<br>
<br>
ds9.set(string cmd, string url)<br>
analysis load<br>
analysis text</tt><b><br></b>
<p><b><a name="array" id="array"></a>array</b></p>
<p>Load raw data array into current frame.<br></p>
<tt>Syntax:<br>
array [native|little|big]<br>
array [new|mask] [[xdim=<x>,ydim=<y>|dim=<dim>],zdim=<z>,bitpix=<b>,skip=<s>,endian=[little|big]]<br>
<br>
Example:<br>
string url = ds9.get(string cmd)<br>
array<br>
array little<br>
<br>
ds9.set(string command, string url)<br>
array foo.arr[dim=512,bitpix=-32,endian=little]<br>
array new foo.arr[dim=512,bitpix=-32,endian=little]<br>
array mask foo.arr[dim=512,bitpix=-32,endian=little]<br></tt>
<p><b><a name="background" id="background"></a>bg<br>
background</b></p>
<p>Set image background color.</p>
<tt>Syntax:<br>
bg <color><br>
<br>
Example:<br>
string url = ds9.get(string cmd)<br>
bg<br>
<br>
ds9.set(string cmd)<br>
bg red</tt><br>
<p><b><a name="backup" id="backup"></a>backup</b></p>
<p>Create a backup save set.</p>
<tt>Syntax:<br>
backup <filename><br>
<br>
Example:<br>
ds9.set(string cmd)<br>
backup ds9.bck</tt><br>
<p><b><a name="bin" id="bin"></a>bin</b></p>
<p>Controls binning factor, binning buffer size, and binning function for binning FITS bin tables. The access point blocking is provided for backward compatibility.</p>
<tt>Syntax:<br>
bin [about <x> <y>]<br>
[about center]<br>
[buffersize <value>]<br>
[cols <x> <y>]<br>
[colsz <x> <y> <z>]<br>
[factor <value> [<vector>]]<br>
[depth <value>]<br>
[filter <string>]<br>
[filter clear]<br>
[function average|sum]<br>
[in]<br>
[out]<br>
[to fit]<br>
[match]<br>
[lock [yes|no]]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
bin about<br>
bin buffersize<br>
bin cols<br>
bin factor<br>
bin depth<br>
bin filter<br>
bin function<br>
bin smooth<br>
bin smooth function<br>
bin smooth radius<br>
bin lock<br>
<br>
ds9.set(string cmd)<br>
bin about 4096 4096<br>
bin about center<br>
bin buffersize 512<br>
bin cols detx dety<br>
bin colsz detx dety time<br>
bin factor 4<br>
bin factor 4 2<br>
bin depth 10<br>
bin filter 'pha > 5'<br>
bin filter clear<br>
bin function sum<br>
bin in<br>
bin out<br>
bin to fit<br>
bin match<br>
bin lock yes<br>
bin open<br>
bin close<br></tt>
<p><b><a name="blink" id="blink"></a>blink</b></p>
<p>Blink mode parameters. Interval is in seconds.<br></p>
<tt>Syntax:<br>
blink []<br>
[yes|no]<br>
[interval <value>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
blink<br>
blink interval<br>
<br>
ds9.set(string cmd)<br>
blink<br>
blink yes<br>
blink interval 1</tt><br>
<p><b><a name="block" id="block"></a>block</b></p>
<p>Controls blocking parameters.</p>
<tt>Syntax:<br>
block[<value>]<br>
[<value> <value>]<br>
[to <value>]<br>
[to <value> <value>]<br>
[in]<br>
[out]<br>
[to fit]<br>
[match]<br>
[lock [yes|no]]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
block<br>
block lock<br>
<br>
ds9.set(string cmd)<br>
block4<br>
block4 2<br>
blockto 4<br>
blockto 4 2<br>
blockin<br>
blockout<br>
blockto fit<br>
blockmatch<br>
blocklock yes<br>
blockopen<br>
blockclose<br></tt>
<p><b><a name="catalog" id="catalog"></a>catalog<br>
cat<br></b></p>
<p>Support for catalogs. The first three commands will create a new catalog search. All other commands operated on the last search created, unless indicated otherwise.</p>
<tt>Syntax:<br>
catalog [new]<br>
[ned|simbad|denis|skybot]<br>
[aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho]<br>
[ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1]<br>
[2mass|iras]<br>
[csc|xmm|rosat]<br>
[first|nvss]<br>
[chandralog|cfhtlog|esolog|stlog|xmmlog]<br>
[cds <catalogname>]<br>
[cds <catalogid>]<br>
<br>
[load <filename>]<br>
[import sb|tsv <filename>]<br>
<br>
[<ref>] [<ra> <dec> <coordsys>]<br>
[<ref>] [allcols]<br>
[<ref>] [allrows]<br>
[<ref>] [cancel]<br>
[<ref>] [clear]<br>
[<ref>] [close]<br>
[<ref>] [crosshair]<br>
[<ref>] [dec <col>]<br>
[<ref>] [edit yes|no]<br>
[<ref>] [export sb|tsv <filename>]<br>
[<ref>] [filter <string>]<br>
[<ref>] [filter load <filename>]<br>
[<ref>] [header]<br>
[<ref>] [location <code>]<br>
[<ref>] [match]<br>
[<ref>] [match <ref> <ref>]<br>
[<ref>] [match error <value> degrees|arcmin|arcsec]<br>
[<ref>] [match function 1and2|1not2|2not1]<br>
[<ref>] [match return 1and2|1only|2only]<br>
[<ref>] [match unique yes|no]<br>
[<ref>] [maxrows <number>]<br>
[<ref>] [name <object>]<br>
[<ref>] [panto yes|no]<br>
[<ref>] [plot <xcol> <ycol> <xerrcol> <yerrcol>]<br>
[<ref>] [print]<br>
[<ref>] [psky <skyframe>]<br>
[<ref>] [psystem <coordsys>]<br>
[<ref>] [ra <col>]<br>
[<ref>] [regions]<br>
[<ref>] [retrieve]<br>
[<ref>] [samp]<br>
[<ref>] [samp broadcast]<br>
[<ref>] [samp send <application>]<br>
[<ref>] [save <filename>]<br>
[<ref>] [servercds|adac|cadc|cambridge|sao|ukirt|iucaa|bejing|saao]<br>
[<ref>] [show yes|no]<br>
[<ref>] [radius <value> degrees|arcmin|arcsec]<br>
[<ref>] [sky <skyframe>]<br>
[<ref>] [skyformat <skyformat>]<br>
[<ref>] [sort <col> incr|decr]<br>
[<ref>] [symbol [#] condition|shape|color|text|font|fontsize|fontweight|fontslant <value>]<br>
[<ref>] [symbol [#] text|size|size2|units|angle <value>]<br>
[<ref>] [symbol shape circle|ellipse|box|text|point]<br>
[<ref>] [symbol shapecircle point|box point|diamond point|cross point|x point|arrow point|boxcircle point]<br>
[<ref>] [symbol add| [#] remove]<br>
[<ref>] [symbol save|load <filename>]<br>
[<ref>] [system <coordsys>]<br>
[<ref>] [update]<br>
[<ref>] [x <col>]<br>
[<ref>] [y <col>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
catalog<br>
catalog header<br>
<br>
ds9.set(string cmd)<br>
catalog new<br>
catalog 2mass<br>
catalog cds 2mass<br>
catalog cds{I/252}<br>
<br>
catalog load foo.xml<br>
catalog import tsv foo.tsv<br>
<br>
catalog coordinate 202.48 47.21 fk5<br>
catalog allrows<br>
catalog allcols<br>
catalog cancel<br>
catalog clear<br>
catalog close<br>
catalog crosshair<br>
catalog dec DEC<br>
catalog edit yes<br>
catalog export tsv bar.tsv<br>
catalog filter {$Jmag>10}<br>
catalog filter load foo.flt<br>
catalog header<br>
catalog location 500<br>
catalog match error 2 arcsec<br>
catalog match function 1and2<br>
catalog match unique no<br>
catalog match return 1only<br>
catalog match # last two catalogs loaded<br>
catalog match 2mass csc<br>
catalog maxrows 2000<br>
catalog name m51<br>
catalog panto no<br>
catalog plot{$Jmag} {$Hmag} {$e_Jmag} {$e_Hmag}<br>
catalog print<br>
catalog psky fk5<br>
catalog psystem wcs<br>
catalog ra RA<br>
catalog regions<br>
catalog retrieve<br>
catalog samp broadcast<br>
catalog samp send aladin<br>
catalog save foo.xml<br>
catalog server sao<br>
catalog show yes<br>
catalog radius 1 degrees<br>
catalog symbol condition{$Jmag>15}<br>
catalog symbol 2 shape{boxcircle point}<br>
catalog symbol color red<br>
catalog symbol font times<br>
catalog symbol fontsize 14<br>
catalog symbol fontweight bold<br>
catalog symbol fontslant italic<br>
catalog symbol add<br>
catalog symbol 2 remove<br>
catalog symbol load foo.sym<br>
catalog symbol save bar.sym<br>
catalog sky fk5<br>
catalog skyformat degrees<br>
catalog sort {Jmag} incr<br>
catalog system wcs<br>
catalog update<br>
catalog x RA<br>
catalog y DEC<br></tt>
<p><b><a name="cd" id="cd"></a>cd</b></p>
<p>Sets/Returns the current working directory.</p>
<tt>Syntax:<br>
cd [<directory>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
cd<br>
<br>
ds9.set(string cmd)<br>
cd /home/mrbill<br></tt>
<p><b><a name="cmap" id="cmap"></a>cmap</b></p>
<p>Controls the colormap for the current frame. The colormap name is not case sensitive. A valid contrast value is from 0 to 10 and bias value from 0 to 1.</p>
<tt>Syntax:<br>
cmap [<colormap>]<br>
[file]<br>
[load <filename>]<br>
[save <filename>]<br>
[invert yes|no]<br>
[<constrast> <bias>]<br>
[tag [load|save] <filename>]<br>
[tag delete]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
cmap<br>
cmap file<br>
cmap invert<br>
cmap value<br>
<br>
ds9.set(string cmd)<br>
cmap Heat<br>
cmap load foo.sao<br>
cmap save bar.sao<br>
cmap invert yes<br>
cmap 5 .5<br>
cmap tag load foo.tag<br>
cmap tag save foo.tag<br>
cmap tag delete<br>
cmap open<br>
cmap close<br></tt>
<p><b><a name="colorbar" id="colorbar"></a>colorbar</b></p>
<p>Controls colorbar parameters.</p>
<tt>Syntax:<br>
colorbar []<br>
[yes|no]<br>
[orientation]<br>
[horizontal|vertical]<br>
[numerics yes|no]<br>
[space value|distance]<br>
[font times|helvetica|courier]<br>
[fontsize <value>]<br>
[fontweight normal|bold]<br>
[fontslant roman|italic]<br>
[size]<br>
[ticks]<br>
[match]<br>
[lock [yes|no]]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
colorbar<br>
colorbar orientation<br>
colorbar numerics<br>
colorbar space<br>
colorbar font<br>
colorbar fontsize<br>
colorbar fontweight<br>
colorbar fontslant<br>
colorbar size<br>
colorbar ticks<br>
colorbar lock<br>
<br>
ds9.set(string cmd)<br>
colorbar yes<br>
colorbar vertical<br>
colorbar numerics yes<br>
colorbar space value<br>
colorbar font times<br>
colorbar fontsize 14<br>
colorbar fontwieght bold<br>
colorbar fontslant italic<br>
colorbar size 20<br>
colorbar ticks 11<br>
colorbar match<br>
colorbar lock yes</tt><br>
<p><b><a name="console" id="console"></a>console</b></p>
<p>Display tcl console window.</p>
<tt>Syntax:<br>
-console<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
console<br></tt>
<p><b><a name="contour" id="contour"></a>contour</b></p>
<p>Controls contours in the current frame.</p>
<tt>Syntax:<br>
contour []<br>
[yes|no]<br>
[<coordsys> [<skyframe>]]<br>
[clear]<br>
[generate]<br>
[load <filename>]<br>
[save <filename> [<coordsys> <skyframe>]]<br>
[convert]<br>
[load levels <filename>]<br>
[save levels <filename>]<br>
[copy]<br>
[paste [<coordsys> <color> <width> yes|no]]<br>
[color <color>]<br>
[width <width>]<br>
[dash yes|no]<br>
[smooth <smooth>]<br>
[method block|smooth]<br>
[nlevels <number of levels>]<br>
[scale linear|log|pow|squared|sqrt|asinh|sinh|histequ]<br>
[scale log exp <value>]<br>
[mode minmax|<value>|zscale|zmax]<br>
[scope global|local]<br>
[limits <min> <max>]<br>
[levels <value value value...>]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
contour<br>
contour wcs fk5<br>
contour color<br>
contour width<br>
contour dash<br>
contour smooth<br>
contour method<br>
contour nlevels<br>
contour scale<br>
contour log exp<br>
contour mode<br>
contour scope<br>
contour limits<br>
contour levels<br>
<br>
ds9.set(string cmd)<br>
contour<br>
contour yes<br>
contour clear<br>
contour generate<br>
contour load ds9.ctr<br>
contour save ds9.con<br>
contour save ds9.con wcs fk5<br>
contour convert<br>
contour load levels ds9.ctr<br>
contour save levels ds9.lev<br>
contour copy<br>
contour paste<br>
contour paste wcs red 2 no<br>
contour color yellow<br>
contour width 2<br>
contour dash yes<br>
contour smooth 5<br>
contour method smooth<br>
contour nlevels 10<br>
contour scale sqrt<br>
contour log exp 1000<br>
contour mode zscale<br>
contour scope local<br>
contour limits 1 100<br>
contour levels 1 10 100 1000<br>
contour open<br>
contour close<br></tt>
<p><b><a name="crop" id="crop"></a>crop</b></p>
<p>Set current image display area.</p>
<tt>Syntax:<br>
crop [<x> <y> <width> <height> [<coordsys>][<skyframe>][degrees|arcmin|arcsec]<br>
[match <coordsys>]<br>
[lock <coordsys>|none]<br>
[reset]<br>
[3dzmin zmax <coordsys>]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
crop # get crop in physical coords<br>
crop wcs galactic sexagesimal arcsec<br>
crop lock<br>
<br>
ds9.set(string cmd)<br>
crop 40 30 10 20 # set crop in physical coords<br>
crop +104:51:06.915 +68:33:40.761 28.144405 22.000204 wcs galactic arcsec<br>
crop match wcs<br>
crop lock wcs<br>
crop reset<br>
crop 3d .25 .5 wcs<br>
crop open<br>
crop close<br></tt>
<p><b><a name="crosshair" id="crosshair"></a>crosshair</b></p>
<p>Controls the current position of the crosshair in the current frame. DS9 is placed in crosshair mode when the crosshair is set.</p>
<tt>Syntax:<br>
crosshair [<x> <y> <coordsys> [<skyframe>]]<br>
[match <coordsys>]<br>
[lock <coordsys>|none]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
crosshair # get crosshair in physical coords<br>
crosshair wcs fk4 sexagesimal # get crosshair in wcs coords<br>
crosshair lock<br>
<br>
ds9.set(string cmd)<br>
crosshair 100 100 physical # set crosshair in physical<br>
crosshair 345 58.8 wcs fk5 # set crosshair in wcs coords<br>
crosshair 23:01:00 +58:52:51 wcs fk5<br>
crosshair match wcs<br>
crosshair lock wcs<br></tt>
<p><b><a name="cube" id="cube"></a>cube<br></b></p>
<p>Controls FITS cube.</p>
<tt>Syntax:<br>
cube []<br>
[play|stop|next|prev|first|last]<br>
[<slice> [<coordsys>]]<br>
[interval <numeric>]<br>
[match <coordsys>]<br>
[lock <coordsys>|none]<br>
[order 123|132|213|231|312|321]<br>
[axes lock [yes|no]]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
cube<br>
cube wcs<br>
cube interval<br>
cube lock<br>
cube order<br>
cube axes lock<br>
<br>
ds9.set(string cmd)<br>
cube<br>
cube play<br>
cube last<br>
cube 3<br>
cube 4.4 wcs<br>
cube interval 2<br>
cube match wcs<br>
cube lock wcs<br>
cube order 123<br>
cube axes lock yes<br>
cube open<br>
cube close</tt><br>
<p><b><a name="cursor" id="cursor"></a>cursor</b></p>
<p>Move mouse pointer or crosshair in image pixels in the current frame. Note, this will move selected Regions also.</p>
<tt>Syntax:<br>
cursor [<x> <y>]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
cursor 10 10<br></tt>
<p><b><a name="data" id="data"></a>data</b></p>
<p>Return an array of data values given a lower left corner and a width and height in specified coordinate system. The last argument of yes indicates to strip the coordinates from the output and just list the data values. The default is yes.<br></p>
<tt>Syntax:<br>
data [<coordsys> [<skyframe>] <x> <y> <width> <height> [yes|no]]<br>
<br>
Example:<br>
string url = ds9.get(string cmd)<br>
data image 450 520 3 3 yes<br>
data physical 899 1039 6 6 no<br>
data fk5 202.47091 47.196811 0.00016516669 0.00016516669 no<br>
data wcs fk5 13:29:53.018 +47:11:48.52 0.00016516669 0.00016516669 no<br></tt>
<p><b><a name="dsssao" id="dsssao"></a>dsssao<br>
dss<br></b></p>
<p>Support for Digital Sky Survey at SAO.</p>
<tt>Syntax:<br>
dsssao []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
dsssao name<br>
dsssao coord<br>
dsssao size<br>
dsssao save<br>
dsssao frame<br>
<br>
ds9.set(string cmd)<br>
dsssao<br>
dsssao m31<br>
dsssao name m31<br>
dsssao name clear<br>
dsssao 00:42:44.404 +41:16:08.78<br>
dsssao size 60 60 arcmin<br>
dsssao save yes<br>
dsssao frame current<br>
dsssao update frame<br>
dsssao open<br>
dsssao close<br></tt>
<p><b><a name="dsseso" id="dsseso"></a>dsseso</b></p>
<p>Support for Digital Sky Survey at ESO.</p>
<tt>Syntax:<br>
dsseso []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[survey DSS1|DSS2-red|DSS2-blue|DSS2-infrared]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
dsseso name<br>
dsseso coord<br>
dsseso size<br>
dsseso save<br>
dsseso frame<br>
dsseso survey<br>
<br>
ds9.set(string cmd)<br>
dsseso<br>
dsseso m31<br>
dsseso name m31<br>
dsseso name clear<br>
dsseso 00:42:44.404 +41:16:08.78<br>
dsseso size 60 60 arcmin<br>
dsseso save yes<br>
dsseso frame current<br>
dsseso update frame<br>
dsseso survey DSS2-red<br>
dsseso open<br>
dsseso close<br></tt>
<p><b><a name="dssstsci" id="dssstsci"></a>dssstsci</b></p>
<p>Support for Digital Sky Survey at STSCI.</p>
<tt>Syntax:<br>
dssstsci []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[survey poss2ukstu_red|poss2ukstu_ir|poss2ukstu_blue]<br>
[survey poss1_blue|poss1_red]<br>
[survey all|quickv|phase2_gsc2|phase2_gsc1]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
dssstsci name<br>
dssstsci coord<br>
dssstsci size<br>
dssstsci save<br>
dssstsci frame<br>
dssstsci survey<br>
<br>
ds9.set(string cmd)<br>
dssstsci<br>
dssstsci m31<br>
dssstsci name m31<br>
dssstsci name clear<br>
dssstsci 00:42:44.404 +41:16:08.78<br>
dssstsci size 60 60 arcmin<br>
dssstsci save yes<br>
dssstsci frame current<br>
dssstsci update frame<br>
dssstsci survey all<br>
dssstsci open<br>
dssstsci close</tt><br>
<p><b><a name="envi" id="envi"></a>envi</b></p>
<p>Load an ENVI header and file. Optional parameter: array endian.<br></p>
<tt>Syntax:</tt><tt><br></tt> <tt>envi [new] <header> [<filename>]</tt><tt><br></tt> <tt> </tt><tt><br></tt> <tt>Example:</tt><tt><br></tt> <tt>ds9.set(string cmd)</tt><tt><br></tt> <tt>envi foo.hdr</tt><tt><br></tt> <tt>envi new foo.hdr</tt><tt><br></tt> <tt>envi foo.hdr foo.bsq</tt><br>
<br>
<b><a name="exit" id="exit"></a>exit</b><br>
<p><b>quit<br></b></p>
<p>Quits DS9.</p>
<tt>Syntax:<br>
exit<br>
quit<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
exit</tt><br>
<p><b><a name="export" id="export"></a>export<br></b></p>
<p>Export loaded image data of current frame in specified image format. Optional parameters: array endian, nrrd endian, jpeg quality (1-100) and tiff compression method.</p>
<tt>Syntax:<br>
export[array|nrrd|envi|gif|tiff|jpeg|png]<filename><br>
export array <filename>[big|little|native]<br>
export nrrd <filename>[big|little|native]<br>
export envi <header> [<filename>][big|little|native]<br>
export jpeg <filename>[1-100]<br>
export tiff <filename>[none|jpeg|packbits|deflate]<br>
<br>
Example:<br>
<br>
ds9.set (string cmd)<br>
export array foo.arr little<br>
export nrrd foo.nrrd little<br>
export envi foo.hdr little<br>
export envi foo.hdr foo.bsq little<br>
export tiff foo.tiff jpeg<br>
export jpeg foo.jpeg 75<br>
export png foo.png</tt><br>
<p><b><a name="file" id="file"></a>file</b></p>
<p>Query currently loaded file information.</p>
<tt>Syntax:<br>
file<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
file<br></tt>
<p><b><a name="fits" id="fits"></a>fits</b></p>
<p>Load a FITS image into the current frame or query the currently loaded image.<br></p>
<tt>Syntax:<br>
fits[new|mask|slice] [<filename>]<br>
[width|height|depth|bitpix|type]<br>
[size [wcs|wcsa...wcsz] [fk4|fk5|icrs|galactic|ecliptic] [degrees|arcmin|arcsecs]]<br>
[header [<ext>] [keyword <string>]]<br>
[image|table|slice]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
fits<br>
fits width<br>
fits height<br>
fits depth<br>
fits bitpix<br>
fits size<br>
fits size wcs fk5 arcmin<br>
fits header # primary<br>
fits header 2 # hdu 2<br>
fits header -2 # hdu 2 with inherit<br>
fits header keyword BITPIX<br>
fits header 1 keyword BITPIX<br>
fits image<br>
fits table<br>
fits slice<br>
<br>
ds9.set(string cmd, string url)<br>
fits foo.fits<br>
fits new foo.fits<br>
fits bar.fits[bin=detx,dety]<br>
fits slice foo.fits<br>
fits mask foo.fits<br>
<br></tt> <b><a name="frame" id="frame"></a>frame</b>
<p>Controls frame functions. Frames may be created, deleted, reset, and centered. While return the current frame number. If you goto a frame that does not exists, it will be created. If the frame is hidden, it will be shown. The 'frameno' option is available for backward compatibility.</p>
<tt>Syntax:<br>
frame [center [#|all]]<br>
[clear [#|all]]<br>
[new [rgb|3d]]<br>
[delete [#|all]]<br>
[reset [#|all]]<br>
[refresh [#|all]]<br>
[hide [#|all]]<br>
[show [#|all]]<br>
[move first]<br>
[move back]<br>
[move forward]<br>
[move last]<br>
[first]<br>
[prev]<br>
[next]<br>
[last]<br>
[frameno #]<br>
[#]<br>
[match <coordsys>]<br>
[lock <coordsys>|none]<br>
[has [amplifier|datamin|datasec|detector|grid|iis|irafmin|physical|smooth]]<br>
[has contour [aux]]]<br>
[has fits [ |bin|cube|mosaic]]<br>
[has marker [highlite|paste|select|undo]]<br>
[has system <coordsys>]<br>
[has wcs [<wcssys>]]<br>
[has wcs celestial [<wcssys>]]<br>
[has wcs linear [<wcssys>]]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
frame # returns the id of the current frame<br>
frame frameno # returns the id of the current frame<br>
frame all # returns the id of all frames<br>
frame active # returns the id of all active frames<br>
frame lock<br>
frame has amplifier<br>
frame has datamin<br>
frame has datasec<br>
frame has detector<br>
frame has grid<br>
frame has iis<br>
frame has irafmin<br>
frame has physical<br>
frame has smooth<br>
frame has contour<br>
frame has contour aux<br>
frame has fits<br>
frame has fits bin<br>
frame has fits cube<br>
frame has fits mosaic<br>
frame has marker highlite<br>
frame has marker paste<br>
frame has marker select<br>
frame has marker undo<br>
frame has system physical<br>
frame has wcs wcsa<br>
frame has wcs celestial wcsa<br>
frame has wcs linear wcsa<br>
<br>
ds9.set(string cmd)<br>
frame center # center current frame<br>
frame center 1 # center 'Frame1'<br>
frame center all # center all frames<br>
frame clear # clear current frame<br>
frame new # create new frame<br>
frame new rgb # create new rgb frame<br>
frame delete # delete current frame<br>
frame reset # reset current frame<br>
frame refresh # refresh current frame<br>
frame hide # hide current frame<br>
frame show 1 # show frame 'Frame1'<br>
frame move first # move frame to first in order<br>
frame move back # move frame back in order<br>
frame move forward # move frame forward in order<br>
frame move last # move frame to last in order<br>
frame first # goto first frame<br>
frame prev # goto prev frame<br>
frame next # goto next frame<br>
frame last # goto last frame<br>
frame frameno 4 # goto frame 'Frame4', create if needed<br>
frame 3 # goto frame 'Frame3', create if needed<br>
frame match wcs<br>
frame lock wcs</tt><br>
<p><b><a name="gif" id="gif"></a>gif</b></p>
<p>Load GIF image into current frame.<br></p>
<tt>Syntax:<br>
gif [new|slice] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
gif<br>
<br>
ds9.set(string cmd)<br>
gif foo.gif<br>
gif new foo.gif<br>
gif slice foo.gif<br></tt>
<p><b><a name="grid" id="grid"></a>grid</b></p>
<p>Controls coordinate grid. For grid numeric format syntax, click <a href="grid.html#Format">here</a>.</p>
<tt>Syntax:<br>
grid []<br>
[yes|no]<br>
[type analysis|publication]<br>
[system <coordsys>]<br>
[sky <skyframe>]<br>
[skyformat <skyformat>]<br>
[grid yes|no]<br>
[grid color <color>]<br>
[grid width <value>]<br>
[grid dash yes|no]<br>
[grid gap1 <value>]<br>
[grid gap2 <value>]<br>
[grid gap3 <value>]<br>
[axes yes|no]<br>
[axes color <color>]<br>
[axes width <value>]<br>
[axes dash yes|no]<br>
[axes type interior|exterior]<br>
[axes origin lll|llu|lul|luu|ull|ulu|uul|uuu]<br>
[format1 <format>]<br>
[format2 <format>]<br>
[tickmarks yes|no]<br>
[tickmarks color <color>]<br>
[tickmarks width <value>]<br>
[tickmarks dash yes|no]<br>
[border yes|no]<br>
[border color <color>]<br>
[border width <value>]<br>
[border dash yes|no]<br>
[numerics yes|no]<br>
[numerics font times|helvetica|courier]<br>
[numerics fontsize <value>]<br>
[numerics fontweight normal|bold]<br>
[numerics fontslant roman|italic]<br>
[numerics color <color>]<br>
[numerics gap1 <value>]<br>
[numerics gap2 <value>]<br>
[numerics gap3 <value>]<br>
[numerics type interior|exterior]<br>
[numerics vertical yes|no]<br>
[title yes|no]<br>
[title text <text>]<br>
[title def yes|no]<br>
[title gap <value>]<br>
[title font times|helvetica|courier]<br>
[title fontsize <value>]<br>
[title fontweight normal|bold]<br>
[title fontslant roman|italic]<br>
[title color <color>]<br>
[labels yes|no]<br>
[labels text1 <text>]<br>
[labels text2 <text>]<br>
[labels def1 yes|no]<br>
[labels def2 yes|no]<br>
[labels gap1 <value>]<br>
[labels gap2 <value>]<br>
[labels font times|helvetica|courier]<br>
[labels fontsize <value>]<br>
[labels fontweight normal|bold]<br>
[labels fontslant roman|italic]<br>
[labels color <color>]<br>
[reset]<br>
[load <filename>]<br>
[save <filename>]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
grid<br>
grid type<br>
grid system<br>
grid sky<br>
grid skyformat<br>
grid grid<br>
grid grid color<br>
grid grid width<br>
grid grid dash<br>
grid grid gap1<br>
grid grid gap2<br>
grid grid gap3<br>
grid axes<br>
grid axes color<br>
grid axes width<br>
grid axes dash<br>
grid axes type<br>
grid axes origin<br>
grid format1<br>
grid format2<br>
grid tickmarks<br>
grid tickmarks color<br>
grid tickmarks width<br>
grid tickmarks dash<br>
grid border<br>
grid border color<br>
grid border width<br>
grid border dash<br>
grid numerics<br>
grid numerics font<br>
grid numerics fontsize<br>
grid numerics fontweight<br>
grid numerics fontslant<br>
grid numerics color<br>
grid numerics gap1<br>
grid numerics gap2<br>
grid numerics gap3<br>
grid numerics type<br>
grid numerics vertical<br>
grid title<br>
grid title text<br>
grid title def<br>
grid title gap<br>
grid title font<br>
grid title fontsize<br>
grid title fontweight<br>
grid title fontslant<br>
grid title color<br>
grid labels<br>
grid labels text1<br>
grid labels text2<br>
grid labels def1<br>
grid labels def2<br>
grid labels gap1<br>
grid labels gap2<br>
grid labels font<br>
grid labels fontsize<br>
grid labels fontweight<br>
grid labels fontslant<br>
grid labels color<br>
<br>
ds9.set(string cmd)<br>
grid<br>
grid yes<br>
grid type analysis<br>
grid system wcs<br>
grid sky fk5<br>
grid skyformat degrees<br>
grid grid yes<br>
grid grid color red<br>
grid grid width 2<br>
grid grid dash yes<br>
grid grid gap1 10<br>
grid grid gap2 10<br>
grid grid gap3 10<br>
grid axes yes<br>
grid axes color red<br>
grid axes width 2<br>
grid axes dash yes<br>
grid axes type exterior<br>
grid axes origin lll<br>
grid format1 d.2<br>
grid format2 d.2<br>
grid tickmarks yes<br>
grid tickmarks color red<br>
grid tickmarks width 2<br>
grid tickmarks dash yes<br>
grid border yes<br>
grid border color red<br>
grid border width 2<br>
grid border dash yes<br>
grid numerics yes<br>
grid numerics font courier<br>
grid numerics fontsize 12<br>
grid numerics fontweight bold<br>
grid numerics fontslant italic<br>
grid numerics color red<br>
grid numerics gap1 10<br>
grid numerics gap2 10<br>
grid numerics gap3 10<br>
grid numerics type exterior<br>
grid numerics vertical yes<br>
grid title yes<br>
grid title text {Hello World}<br>
grid title def yes<br>
grid title gap 10<br>
grid title fontsize 12<br>
grid title font courier<br>
grid title fontweight bold<br>
grid title fontslant italic<br>
grid title color red<br>
grid labels yes<br>
grid labels text1 {Hello World}<br>
grid labels text2 {Hello World}<br>
grid labels def1 yes<br>
grid labels def2 yes<br>
grid labels gap1 10<br>
grid labels gap2 10<br>
grid labels font courier<br>
grid labels fontsize 12<br>
grid labels fontweight bold<br>
grid labels fontslant italic<br>
grid labels color red<br>
grid reset<br>
grid load foo.grd<br>
grid save foo.grd<br>
grid open<br>
grid close<br></tt>
<p><b><a name="header" id="header"></a>header</b></p>
<p>Display current fits header dialog. Optional extension number maybe specified. Please note, this differs from samp fits header.</p>
<tt>Syntax:<br>
header [<ext>]<br>
[close [<ext>]]<br>
[save [<ext>] <filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
header<br>
header 2<br>
header close<br></tt>
<p><b><a name="height" id="height"></a>height</b></p>
<p>Set the height of the image display window.</p>
<tt>Syntax:<br>
height [<value>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
height<br>
<br>
ds9.set(string cmd)<br>
height 512<br></tt>
<p><b><a name="iconify" id="iconify"></a>iconify</b></p>
<p>Toggles iconification.</p>
<tt>Syntax:<br>
iconify []<br>
[yes|no]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
iconify<br>
<br>
ds9.set(string cmd)<br>
iconify<br>
iconify yes</tt><br>
<p><b><a name="iexam" id="iexam"></a>iexam</b></p>
<p>Interactive examine function. A blinking cursor will indicate to the user to click on a point on an image. The specified information will be returned at that time. The default event is <tt>button</tt>. In the last form, the following macros will be expanded if present: <tt>$width, $height, $depth, $bitpix, $filename, $regions, $filename[$regions], $env, $pan, $value, $x, $y, $z.</tt> See <a href="file:///Users/joye/saods9/doc/ref/analysis.html#macros">Analysis Macros</a> for more information.</p>
<tt>Syntax:<br>
iexam []<br>
[[]|button|key|any] coordinate <coordsys> [<skyframe>] [<skyformat>]<br>
[[]|button|key|any] data [width][height]<br>
[[]|button|key|any] <macro string>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
iexam<br>
iexam coordinate image<br>
iexam key coordinate image # return coordinate and key event<br>
iexam coordinate wcs fk5 degrees<br>
iexam coordinate wcs galactic sexagesimal<br>
iexam coordinate fk5<br>
iexam data # return data value<br>
iexam key data # return data value and key event<br>
iexam data 3 3 # return all data in 3x3 box about selected point<br>
iexam {'Click at $x,$y in file $filename'}<br></tt>
<p><b><a name="iis" id="iis"></a>iis</b></p>
<p>Set/Get IIS Filename. Optional mosaic number maybe supplied.</p>
<tt>Syntax:<br>
iis [filename <filename> [#]]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
iis filename<br>
iis filename 4<br>
<br>
ds9.set(string cmd)<br>
iis filename foo.fits<br>
iis filename bar.fits 4</tt><br>
<p><b><a name="jpeg" id="jpeg"></a>jpeg</b></p>
<p>Load JPEG image into current frame. Optional parameters: <tt>jpeg</tt> quality (1-100)</p>
<tt>Syntax:<br>
jpeg [new|slice] [<filename>] [1-100]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
jpeg<br>
<br>
ds9.set(string cmd)<br>
jpeg foo.jpeg<br>
jpeg new foo.jpeg<br>
jpeg slice foo.jpeg<br></tt>
<p><b><a name="lock" id="lock"></a>lock</b></p>
<p>Lock all other frames to the current frame.</p>
<tt>Syntax:<br>
lock[frame <coordsys>|none]<br>
[crosshair <coordsys>|none]<br>
[crop <coordsys>|none]<br>
[slice <coordsys>|none]<br>
[bin [yes|no]]<br>
[axes [yes|no]]<br>
[scale [yes|no]]<br>
[scalelimits [yes|no]]<br>
[colorbar [yes|no]]<br>
[block [yes|no]]<br>
[smooth [yes|no]]<br>
[3d [yes|no]]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
lock frame<br>
lock crosshair<br>
lock crop<br>
lock slice<br>
lock bin<br>
lock axes<br>
lock scale<br>
lock scalelimits<br>
lock colorbar<br>
lock block<br>
lock smooth<br>
lock 3d<br>
<br>
ds9.set(string cmd)<br>
lock frame wcs<br>
lock crosshair wcs<br>
lock crop wcs<br>
lock slice wcs<br>
lock bin yes<br>
lock axes yes<br>
lock scale yes<br>
lock scalelimits yes<br>
lock colorbar yes<br>
lock block yes<br>
lock smooth yes<br>
lock 3d yes<br>
<br></tt> <b><a name="lower" id="lower"></a>lower</b>
<p>Lower in the window stacking order.</p>
<tt>Syntax:<br>
lower<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
lower<br></tt>
<p><b><a name="magnifier" id="magnifier"></a>magnifier</b></p>
<p>Controls the magnifier settings.</p>
<tt>Syntax:<br>
magnifier [color <color>]<br>
[zoom <value>]<br>
[cursor yes|no]<br>
[region yes|no]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
magnifier color<br>
magnifier zoom<br>
magnifier cursor<br>
magnifier region<br>
<br>
ds9.set(string cmd)<br>
magnifier color yellow<br>
magnifier zoom 2<br>
magnifier cursor no<br>
magnifier region no<br></tt>
<p><b><a name="mask" id="mask"></a>mask<br></b></p>
<p>Controls mask parameters.</p>
<tt>Syntax:<br>
mask [color <color>]<br>
[mark zero|nonzero|nan|nonnan|range]<br>
[range <low> <high>]<br>
[transparency <value>]<br>
[system <coordsys>]<br>
[clear]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
mask color<br>
mask mark<br>
mask range<br>
mask system<br>
mask transparency<br>
<br>
ds9.set(string cmd)<br>
mask color red<br>
mask mark zero<br>
mask range 10 100<br>
mask transparency 50<br>
mask system wcs<br>
mask clear<br>
mask open<br>
mask close<br></tt>
<p><b><a name="match" id="match"></a>match</b></p>
<p>Match all other frames to the current frame.</p>
<tt>Syntax:<br>
match[frame <coordsys>]<br>
[crosshair <coordsys>]<br>
[crop <coordsys>]<br>
[slice <coordsys>]<br>
[bin]<br>
[axes]<br>
[scale]<br>
[scalelimits]<br>
[colorbar]<br>
[block]<br>
[smooth]<br>
[3d]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
match frame wcs<br>
match crosshair wcs<br>
match crop wcs<br>
match slice wcs<br>
match bin<br>
match axes<br>
match scale<br>
match scalelimits<br>
match colorbar<br>
match block<br>
match smooth<br>
match 3d<br></tt>
<p><b><a name="mecube" id="mecube"></a>mecube</b></p>
<p>Load FITS multiple extension file as data cube.<br></p>
<tt>Syntax:<br>
mecube [new] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
mecube<br>
<br>
ds9.set(string cmd)<br>
mecube foo.fits<br>
mecube new foo.fits<br></tt>
<p><b><a name="minmax" id="minmax"></a>minmax</b></p>
<p>This is how DS9 determines the min and max data values from the data. <tt>SCAN</tt> will scan all data.</p>
<tt>Syntax:<br>
minmax [scan|sample|datamin|irafmin]<br>
[mode scan|sample|datamin|irafmin]<br>
[interval #]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
minmax mode<br>
minmax sample<br>
<br>
ds9.set(string cmd)<br>
minmax scan<br>
minmax mode scan<br>
minmax interval 100<br></tt>
<p><b><a name="mode" id="mode"></a>mode</b></p>
<p>Controls the first mouse button mode.</p>
<tt>Syntax:<br>
mode [none|region|crosshair|colorbar|pan|zoom|rotate|catalog|examine|3d]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
mode<br>
<br>
ds9.set(string cmd)<br>
mode crosshair</tt><br>
<p><b><a name="mosaic" id="mosaic"></a>mosaic</b></p>
<p>Load FITS mosaic segment into current frame.</p>
<tt>Syntax:<br>
mosaic [wcs|wcsa...wcsz|iraf] [new|mask] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
mosaic<br>
<br>
ds9.set(string cmd)<br>
mosaic foo.fits<br>
mosaic wcs foo.fits<br>
mosaic wcs new foo.fits<br>
mosaic wcs mask foo.fits<br></tt>
<p><b><a name="mosaicimage" id="mosaicimage"></a>mosaicimage</b></p>
<p>Load FITS mosaic image into current frame.</p>
<tt>Syntax:<br>
mosaicimage [wcs|wcsa...wcsz|iraf|wfpc2] [new|mask] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
mosaicimage<br>
ds9.set(string cmd)<br>
mosaicimage foo.fits<br>
mosaicimage wcs foo.fits<br>
mosaicimage wcs new foo.fits<br>
mosaicimage wcs mask foo.fits<br></tt>
<p><b><a name="movie" id="movie"></a>movie</b></p>
<p>Create a movie from snap shots of the DS9 window. A <tt>slice</tt> movie cycles though all slices of a cube. A <tt>frame</tt> movie cycles through all active frames. A <tt>3d</tt> movie cycles through specified viewing angles. The default action is <tt>slice</tt>. Movie types are either <tt>MPEG</tt> or <tt>Animated GIF</tt>, with default <tt>MPEG</tt>. Optional parameters for <tt>3d</tt>: number of frames, azimuth from/to, elevation from/to, slice from/to, oscillate/repeat times.</p>
<tt>Syntax:<br>
movie[slice|frame|3d][mpeg|gif] <filename><br>
movie 3d [mpeg|gif] <filename> [number|azfrom|azto|elfrom|elto|slfrom|slto|oscillate|repeat <#>]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
movie slice mpeg ds9.mpg<br>
movie frame gif ds9.gif<br>
movie 3d mpeg ds9.mpg number 10 azfrom -60 azto 60 oscillate 1<br></tt>
<p><b><a name="multiframe" id="multiframe"></a>multiframe</b></p>
<p>Load FITS multiple extension file as multiple images.<br></p>
<tt>Syntax:<br>
multiframe [<filename>]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
multiframe foo.fits</tt><br>
<p><b><a name="nameserver" id="nameserver"></a>nameserver</b></p>
<p>Support Name Server functions. Coordinates are in fk5.</p>
<tt>Syntax:<br>
nameserver [<object>]<br>
[name <object>]<br>
[server ned-sao|ned-cds|simbad-sao|simbad-cds|vizier-sao|vizier-cds]<br>
[skyformat degrees|sexagesimal]<br>
[pan]<br>
[crosshair]<br>
[close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
nameserver<br>
nameserver server<br>
nameserver skyformat<br>
nameserver m31<br>
<br>
ds9.set(string cmd)<br>
nameserver m31<br>
nameserver name m31<br>
nameserver server ned-sao<br>
nameserver skyformat sexagesimal<br>
nameserver pan<br>
nameserver crosshair<br>
nameserver open<br>
nameserver close<br></tt>
<p><b><a name="nan" id="nan"></a>nan</b></p>
<p>Set image not-a-number color.</p>
<tt>Syntax:<br>
nan <color><br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
nan<br>
<br>
ds9.set(string cmd)<br>
nan red</tt><br>
<p><b><a name="nrrd" id="nrrd"></a>nrrd</b></p>
<p>Load an NRRD (Nearly Raw Raster Data) file. Optional parameter: array endian.<br></p>
<tt>Syntax:<br>
nrrd [native|little|big]<br>
nrrd [new|mask] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
nrrd<br>
nrrd big<br>
<br>
ds9.set(string cmd, string url)<br>
nrrd foo.nrrd<br>
nrrd new foo.nrrd<br>
nrrd mask foo.nrrd</tt><br>
<p><b><a name="nvss" id="nvss"></a>nvss</b></p>
<p>Support for NRAO VLA Sky Survey.</p>
<tt>Syntax:<br>
nvss []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
nvss name<br>
nvss coord<br>
nvss size<br>
nvss save<br>
nvss frame<br>
<br>
ds9.set(string cmd)<br>
nvss<br>
nvss m31<br>
nvss name m31<br>
nvss name clear<br>
nvss 00:42:44.404 +41:16:08.78<br>
nvss size 60 60 arcmin<br>
nvss save yes<br>
nvss frame current<br>
nvss update frame<br>
nvss open<br>
nvss close<br></tt>
<p><b><a name="orient" id="orient"></a>orient</b></p>
<p>Controls the orientation of the current frame.</p>
<tt>Syntax:<br>
orient [none|x|y|xy]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
orient<br>
<br>
ds9.set(string cmd)<br>
orient xy<br>
orient open<br>
orient close<br></tt>
<p><b><a name="pagesetup" id="pagesetup"></a>pagesetup</b></p>
<p>Controls Page Setup options.</p>
<tt>Syntax:<br>
pagesetup [orient portrait|landscape]<br>
[scale <numeric>]<br>
[size letter|legal|tabloid|poster|a4]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
pagesetup orient<br>
pagesetup scale<br>
pagesetup size<br>
<br>
ds9.set(string cmd)<br>
pagesetup orient portrait<br>
pagesetup scale 50<br>
pagesetup size poster<br></tt>
<p><b><a name="pan" id="pan"></a>pan</b></p>
<p>Controls the current image cursor location for the current frame.</p>
<tt>Syntax:<br>
pan [<coordsys> [<skyframe>] [<skyformat>]] # get current coords<br>
<br>
pan [<x> <y> <coordsys> [<skyframe>]] # relative<br>
[to <x> <y> <coordsys> [<skyframe>]] # absolute<br>
[open|close]<br>
[close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
pan # get current image coords<br>
pan wcs fk4 sexagesimal # get current wcs coords<br>
<br>
ds9.set(string cmd)<br>
pan 200 200 image # pan relative<br>
pan to 400 400 physical # pan to physical coords<br>
pan to 13:29:55 47:11:50 wcs fk5 # pan to wcs coords<br>
pan open<br>
pan close<br></tt>
<p><b><a name="pixeltable" id="pixeltable"></a>pixeltable</b></p>
<p>Display/Hide the pixel table.</p>
<tt>Syntax:<br>
pixeltable []<br>
[yes|open]<br>
[no|close]<br>
<br>
Example:<br>
string url = ds9.get(string cmd)<br>
pixeltable<br>
<br>
ds9.set(string cmd)<br>
pixeltable<br>
pixeltable yes<br>
pixeltable open<br>
pixeltable close<br></tt>
<p><b><a name="plot" id="plot"></a>plot</b></p>
<p>Display and configure data plots. All plot commands take an optional second command, the plot name. If no plot name is specified, the last plot created is assumed. Plot data is assumed to be a pair of coordinates, with optional error values. The follow are valid data descriptions:</p>
<blockquote><tt>xy x and y coordinates<br>
xyex x,y coordinates with x errors<br>
xyey x,y coordinates with y errors<br>
xyexey x,y coordinates with x and y errors<br></tt></blockquote>
<p><tt>To create a new plot, use the plot new command.</tt></p>
<tt>Syntax:<br>
# create new empty plot window<br>
plot []<br>
[line|bar|scatter]<br>
[new]<br>
[new line|bar|scatter]<br>
[new name <plotname>]<br>
[new name <plotname> line|bar|scatter]<br>
<br>
#load data into existing plot from stdin<br>
plot [[<plotname>] data xy|xyex|xyey|xyexey]<br>
<br>
# existing plot<br>
plot [[<plotname>] load <filename> xy|xyex|xyey|xyexey]<br>
[[<plotname>] save <filename>]<br>
[[<plotname>] layout grid|row|column|strip]<br>
[[<plotname>] layout strip weight <percent>]<br>
[[<plotname>] add graph line|bar|scatter]<br>
[[<plotname>] select graph <graph>]<br>
[[<plotname>] delete graph]<br>
[[<plotname>] select dataset <dataset>]<br>
[[<plotname>] delete dataset]<br>
[[<plotname>] duplicate]<br>
[[<plotname>] stats yes|no]<br>
[[<plotname>] list yes|no]<br>
[[<plotname>] loadconfig <filename>]<br>
[[<plotname>] saveconfig <filename>]<br>
[[<plotname>] pagesetup orient portrait|landscape]<br>
[[<plotname>] pagesetup size letter|legal|tabloid|poster|a4]<br>
[[<plotname>] print]<br>
[[<plotname>] print destination printer|file]<br>
[[<plotname>] print command <command>]<br>
[[<plotname>] print filename <filename>]<br>
[[<plotname>] print color rgb|gray]<br>
[[<plotname>] close]<br>
[[<plotname>] mode pointer|zoom]<br>
<br>
# export image<br>
plot [[<plotname>] export <filename>]<br>
[[<plotname>] export gif|tiff|jpeg|png <filename>]<br>
[[<plotname>] export jpeg <filename> [1-100]]<br>
[[<plotname>] export tiff <filename> none|jpeg|packbits|deflate]]<br>
<br>
# configure graph<br>
plot [[<plotname>] axis x|y grid yes|no]<br>
[[<plotname>] axis x|y log yes|no]<br>
[[<plotname>] axis x|y flip yes|no]<br>
[[<plotname>] axis x|y auto yes|no]<br>
[[<plotname>] axis x|y min <value>]<br>
[[<plotname>] axis x|y max <value>]<br>
[[<plotname>] axis x|y format <string>]<br>
[[<plotname>] background <value>]<br>
[[<plotname>] legend yes|no]<br>
[[<plotname>] legend position right|left|top|bottom]<br>
[[<plotname>] font title|labels|numbers font times|helvetica|courier]<br>
[[<plotname>] font title|labels|numbers size <value>]<br>
[[<plotname>] font title|labels|numbers weight normal|bold]<br>
[[<plotname>] font title|labels|numbers slant roman|italic]<br>
[[<plotname>] title <string>]<br>
[[<plotname>] title x|y <string>]<br>
[[<plotname>] barmode normal|stacked|aligned|overlap]<br>
<br>
# configure current dataset<br>
plot [[<plotname>] show yes|no]<br>
[[<plotname>] shape none|circle|square|diamond|plus|splus|scross|triangle|arrow]<br>
[[<plotname>] shape fill yes|no]<br>
[[<plotname>] shape color <value>]<br>
[[<plotname>] smooth step|linear|cubic|quadratic|catrom]<br>
[[<plotname>] color <value>]<br>
[[<plotname>] width <value>]<br>
[[<plotname>] dash yes|no]<br>
[[<plotname>] error yes|no]<br>
[[<plotname>] error color <value>]<br>
[[<plotname>] error cap yes|no]<br>
[[<plotname>] error width <value>]<br>
[[<plotname>] name <string>]<br>
<br>
Example:<br>
# return all plotnames<br>
string value = ds9.get(string cmd)<br>
plot<br>
<br>
# create new empty plot window<br>
ds9.set(string cmd)<br>
plot<br>
plot bar<br>
plot new<br>
plot new bar<br>
plot new name foo<br>
plot new name foo bar<br>
<br>
# existing plot<br>
string value = ds9.get(string cmd)<br>
plot select layout<br>
plot select layout strip weight<br>
plot select graph<br>
plot select dataset<br>
plot stats<br>
plot list<br>
<br>
ds9.set(string cmd)<br>
plot load foo.dat xy<br>
plot save foo.dat<br>
plot layout strip<br>
plot layout strip weight 30<br>
plot add graph scatter<br>
plot select graph 1<br>
plot delete graph<br>
plot select dataset 1<br>
plot delete dataset<br>
plot duplicate<br>
plot stats yes<br>
plot list yes<br>
plot loadconfig foo.plt<br>
plot saveconfig foo.plt<br>
plot pagesetup orient portrait<br>
plot pagesetup size letter<br>
plot print<br>
plot print destination file<br>
plot print command lp<br>
plot print filename foo.ps<br>
plot print color rgb<br>
plot close<br>
<br>
# plot mode<br>
string value = ds9.get(string cmd)<br>
plot mode<br>
<br>
ds9.set(string cmd)<br>
plot mode pointer<br>
<br>
# export plot<br>
ds9.set(string cmd)<br>
plot export tiff foo.tiff jpeg<br>
plot export jpeg foo.jpeg 75<br>
plot export png foo.png<br>
<br>
# configure plot<br>
string value = ds9.get(string cmd)<br>
plot axis x grid<br>
plot axis x log<br>
plot axis x flip<br>
plot axis x auto<br>
plot axis x min<br>
plot axis x max<br>
plot axis x format<br>
plot background<br>
plot legend<br>
plot legend position<br>
plot font numbers font<br>
plot font numbers size<br>
plot font numbers weight<br>
plot font numbers slant<br>
plot title<br>
plot title x<br>
<br>
ds9.set(string cmd)<br>
plot axis x grid yes<br>
plot axis x log yes<br>
plot axis x flip yes<br>
plot axis x auto no<br>
plot axis x min 0<br>
plot axis x max 100<br>
plot axis x format "%f"<br>
plot background white<br>
plot legend yes<br>
plot legend position left<br>
plot font numbers font times<br>
plot font numbers size 12<br>
plot font numbers weight bold<br>
plot font numbers slant italic<br>
plot title "This is a Title"<br>
plot title x "X Axis"<br>
plot title y "Y Axis"<br>
plot title legend "This is the Legend"<br>
<br>
# bar plot<br>
string value = ds9.get(string cmd)<br>
plot barmode<br>
<br>
ds9.set(string cmd)<br>
plot barmode aligned<br>
<br>
# configure current dataset<br>
string value = ds9.get(string cmd)<br>
plot show<br>
plot shape<br>
plot shape fill<br>
plot shape color<br>
plot smooth<br>
plot color<br>
plot width<br>
plot dash<br>
plot error<br>
plot error color<br>
plot error cap<br>
plot error width<br>
plot name<br>
<br>
ds9.set(string cmd)<br>
plot show yes<br>
plot shape circle<br>
plot shape fill no<br>
plot shape color cyan<br>
plot smooth step<br>
plot color red<br>
plot width 2<br>
plot dash yes<br>
plot error yes<br>
plot error color red<br>
plot error cap yes<br>
plot error width 2<br>
plot name "My Data"<br>
<br></tt> <b><a name="png" id="png"></a>png</b>
<p>Load PNG image into current frame.</p>
<tt>Syntax:<br>
png [new|slice] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
png<br>
<br>
ds9.set(string cmd)<br>
png foo.png<br>
png new foo.png<br>
png slice foo.png</tt><br>
<p><b><a name="precision" id="precision"></a>precision</b></p>
<p>Set region and coordinate output format precision.</p>
<tt>Syntax:<br>
precision <linear><degree><hms><dms><arcmin><arcsec><br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
precision<br>
<br>
ds9.set(string cmd)<br>
precision 8 10 4 3 5 3<br></tt>
<p><b><a name="prefs" id="prefs"></a>prefs</b></p>
<p>Controls various preference settings.</p>
<tt>Syntax:<br>
prefs [clear]<br>
[irafalign yes|no]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
prefs irafalign<br>
<br>
ds9.set(string cmd)<br>
prefs clear<br>
prefs irafalign<br>
<br></tt> <b><a name="preserve" id="preserve"></a>preserve</b>
<p>Preserve the follow attributes while loading a new image.</p>
<tt>Syntax:<br>
preserve [pan yes|no]<br>
[regions yes|no]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
preserve pan<br>
preserve regions<br>
<br>
ds9.set(string cmd)<br>
preserve pan yes<br>
preserve regions yes<br></tt>
<p><b><a name="psprint" id="psprint"></a>psprint</b></p>
<p>Invokes postscript printing. Please see <a href="file:///Users/joye/saods9/ds9/doc/ref/command.html#print">print</a> for further details.</p>
<p><b><a name="print" id="print"></a>print</b></p>
<p>Controls printing. Use print option to set printing options.</p>
<tt>Syntax:<br>
print [destination printer|file]<br>
[command <command>]<br>
[filename <filename>]<br>
[color rgb|cmyk|gray]<br>
[level 1|2|3]<br>
[resolution72|screen|96|144|150|225|300|600|1200]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
print destination<br>
print command<br>
print filename<br>
print color<br>
print level<br>
print resolution<br>
<br>
ds9.set(string cmd)<br>
print<br>
print destination file<br>
print command lp<br>
print filename foo.ps<br>
print color cmyk<br>
print level 2<br>
print resolution 96</tt>
<p><b><a name="raise" id="raise"></a>raise</b></p>
<p>Raise in the window stacking order.</p>
<tt>Syntax:<br>
raise<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
raise</tt>
<p><b><a name="regions" id="regions"></a>regions</b></p>
<p>Controls regions in the current frame.</p>
<tt>Syntax:<br>
regions [<filename>]<br>
[load [all] <filename>]<br>
[save <filename>]<br>
[list [close]]<br>
[epsilon <integer>]<br>
[show yes|no]<br>
[showtext yes|no]<br>
[centroid]<br>
[centroid auto yes|no]<br>
[centroid radius <value>|iteration <value>]<br>
[getinfo]<br>
[move front]<br>
[move back]<br>
[select all]<br>
[select none]<br>
[select invert]<br>
[delete all]<br>
[delete select]<br>
[format ds9|xml|ciao|saotng|saoimage|pros|xy]<br>
[system image|physical|wcs|wcsa...wcsz]<br>
[sky fk4|fk5|icrs|galactic|ecliptic]<br>
[skyformat degrees|sexagesimal]<br>
[strip yes|no]<br>
[shape <shape>]<br>
[color &ltcolor>]<br>
[width <width>]<br>
[fixed|edit|rotate|delete yes|no]<br>
[include|exclude|source|background]<br>
[command <marker command>]<br>
[composite]<br>
[dissolve]<br>
[template <filename>]<br>
[template <filename> at <ra> <dec> <coordsys> <skyframe>]<br>
[savetemplate <filename>]<br>
[groups]<br>
[group new]<br>
[group <tag> new]<br>
[group <tag> update]<br>
[group <tag> select]<br>
[group <tag> color <color>]<br>
[group <tag> copy]<br>
[group <tag> delete]<br>
[group <tag> cut]<br>
[group <tag> font <font>]<br>
[group <tag> move <int> <int>]<br>
[group <tag> movefront]<br>
[group <tag> moveback]<br>
[group <tag> property <property> yes|no]<br>
[copy]<br>
[cut]<br>
[paste image|physical|wcs|wcsa...wcsz]<br>
[undo]<br>
[include|exclude|source|background|selected]<br>
[-format ds9|ciao|saotng|saoimage|pros|xy]<br>
[-system image|physical|wcs|wcsa...wcsz]<br>
[-sky fk4|fk5|icrs|galactic|ecliptic]<br>
[-skyformat degrees|sexagesimal]<br>
[-prop select|edit|move|rotate|delete|fixed|include|source 1|0]<br>
[-group <tag>]<br>
[-strip yes|no]<br>
[-wcs yes|no]<br>
<br>
Example:<br>
string url = ds9.get(string cmd)<br>
regions<br>
regions -format ds9 -system wcs -sky fk5 -skyformat sexagesimal -prop edit 1 -group foo<br>
string value = ds9.get(string cmd)<br>
regions epsilon<br>
regions show<br>
regions showtext<br>
regions centroid<br>
regions centroid auto<br>
regions centroid radius<br>
regions centroid iteration<br>
regions selected<br>
regions format<br>
regions system<br>
regions sky<br>
regions skyformat<br>
regions strip<br>
regions shape<br>
regions color<br>
regions width<br>
regions source<br>
regions background<br>
regions include<br>
regions exclude<br>
regions selected<br>
regions groups<br>
<br>
ds9.set(string cmd)<br>
regions foo.reg<br>
regions -format ciao bar.reg # load as ciao format<br>
regions foo.fits # FITS regions files do not need a format specification<br>
regions load foo.reg # load foo.reg into current frame<br>
regions load all foo.reg # load foo.reg into all frames<br>
regions load *.reg# expand *.reg and load into current frame<br>
regions load all *.reg # expand *.reg and load into all frames<br>
regions save foo.reg<br>
regions list<br>
regions list close<br>
regions epsilon 5<br>
regions show yes<br>
regions showtext no<br>
regions centroid<br>
regions centroid auto yes<br>
regions centroid radius 10<br>
regions centroid iteration 20<br>
regions getinfo<br>
regions move back<br>
regions move front<br>
regions select all<br>
regions select none<br>
regions select invert<br>
regions delete all<br>
regions delete select<br>
regions format ds9<br>
regions system wcs<br>
regions sky fk5<br>
regions skyformat degrees<br>
regions strip yes<br>
regions shape ellipse<br>
regions color red<br>
regions width 3<br>
regions edit yes<br>
regions include<br>
regions command "circle 100 100 20 # color=red"<br>
regions composite<br>
regions dissolve<br>
regions template foo.tpl<br>
regions template foo.tpl at 13:29:55.92 +47:12:48.02 fk5<br>
regions savetemplate foo.tpl<br>
regions group new<br>
regions group foo new<br>
regions group foo update<br>
regions group foo select<br>
regions group foo color red<br>
regions group foo copy<br>
regions group foo delete<br>
regions group foo cut<br>
regions group foo font 'times 14 bold'<br>
regions group foo move 100 100<br>
regions group foo movefront<br>
regions group foo moveback<br>
regions group foo property delete no<br>
regions copy<br>
regions cut<br>
regions paste wcs<br>
regions undo<br></tt>
<p><b><a name="restore" id="restore"></a>restore</b></p>
<p>Restore DS9 to a previous state from a backup save set.</p>
<tt>Syntax:<br>
restore <filename><br>
<br>
Example:<br>
restore ds9.bck</tt><br>
<p><b><a name="rgb" id="rgb"></a>rgb</b></p>
<p>Create RGB frame and control RGB frame parameters.</p>
<tt>Syntax:<br>
rgb []<br>
[red|green|blue]<br>
[channel [red|green|blue]]<br>
[view [red|green|blue] [yes|no]]<br>
[system <coordsys>]<br>
[lock wcs|crop|slice|bin|scale|scalelimits|colorbar|block|smooth [yes|no]]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
rgb channel<br>
rgb lock wcs<br>
rgb lock crop<br>
rgb lock slice<br>
rgb lock bin<br>
rgb lock scale<br>
rgb lock scalelimits<br>
rgb lock colorbar<br>
rgb lock block<br>
rgb lock smooth<br>
rgb system<br>
rgb view red<br>
rgb view green<br>
rgb view blue<br>
<br>
ds9.set(string cmd)<br>
rgb # create new rgb frame<br>
rgb red # set current channel to red<br>
rgb channel red # set current channel to red<br>
rgb view blue no # turn off blue channel<br>
rgb system wcs # set rgb coordinate system<br>
rgb lock wcs yes<br>
rgb lock crop yes<br>
rgb lock slice yes<br>
rgb lock bin yes<br>
rgb lock scale yes<br>
rgb lock scalelimits yes<br>
rgb lock colorbar yes<br>
rgb lock block yes<br>
rgb lock smooth yes<br>
rgb open<br>
rgb close</tt><br>
<p><b><a name="rgbarray" id="rgbarray"></a>rgbarray</b></p>
<p>Load raw data array cube into rgb frame.<br></p>
<tt>Syntax:<br>
rgbarray [native|big|little]<br>
rgbarray [new] [[xdim=<x>,ydim=<y>|dim=<dim>],[zdim=3],bitpix=<b>,skip=<s>,endian=[little|big]]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
rgbarray<br>
<br>
ds9.set(string cmd)<br>
rgbarray foo.arr[dim=512,zdim=3,bitpix=-32,endian=little]<br>
rgbarray new foo.arr[dim=512,zdim=3,bitpix=-32,endian=little]</tt><br>
<p><b><a name="rgbcube" id="rgbcube"></a>rgbcube</b></p>
<p>Load FITS rgbcube into rgb frame.<br></p>
<tt>Syntax:<br>
rgbcube [new] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
rgbcube<br>
<br>
ds9.set(string cmd)<br>
rgbcube foo.fits<br>
rgbcube new foo.fits</tt><br>
<p><b><a name="rgbimage" id="rgbimage"></a>rgbimage</b></p>
<p>Load FITS rgbimage into rgb frame.<br></p>
<tt>Syntax:<br>
rgbimage [new] [<filename>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
rgbimage<br>
<br>
ds9.set(string cmd)<br>
rgbimage foo.fits<br>
rgbimage new foo.fits<br></tt>
<p><b><a name="rotate" id="rotate"></a>rotate</b></p>
<p>Controls the rotation angle (in degrees) of the current frame.</p>
<tt>Syntax:<br>
rotate [<value>]<br>
[to <value>]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
rotate<br>
<br>
ds9.set(string cmd)<br>
rotate 45<br>
rotate to 30<br>
rotate open<br>
rotate close</tt><br>
<p><b><a name="samp" id="samp"></a>samp</b></p>
<p>Configure SAMP protocol.</p>
<tt>Syntax:<br>
samp [no|disconnect]<br>
[broadcast [image|table]]<br>
[send [image|table] <application>]<br>
<br>
Example:<br>
<br>
ds9.set(string cmd)<br>
samp no<br>
samp disconnect<br>
samp broadcast image<br>
samp send image aladin</tt>
<p><b><a name="save" id="save"></a>save<br></b></p>
<p>Save loaded image data of current frame as FITS.</p>
<tt>Syntax:<br>
save[fits|rgbimage|rgbcube|mecube|mosaic|mosaicimage] <filename> [image|table|slice]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
save foo.fits<br>
save fits foo.fits image<br>
save fits foo.fits table<br>
save fits foo.fits slice<br>
save rgbimage foo.fits<br>
save rgbcube foo.fits<br>
save mecube foo.fits<br>
save mosaic foo.fits<br>
save mosaicimage foo.fits</tt><br>
<p><b><a name="saveimage" id="saveimage"></a>saveimage</b></p>
<p>Create a snap shot of the current DS9 window and save in specified image format. If no format specified, the file name extension is used to determine the output format. Optional parameters: <tt>jpeg</tt> quality (1-100) and <tt>tiff</tt> compression method.</p>
<tt>Syntax:<br>
saveimage[fits|eps|gif|tiff|jpeg|png]<filename><br>
saveimage <filename>.jpeg [1-100]<br>
saveimage <filename>.tiff [none|jpeg|packbits|deflate]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
saveimage ds9.tiff<br>
saveimage jpeg ds9.jpeg 75</tt><br>
<p><b><a name="scale" id="scale"></a>scale</b></p>
<p>Controls the limits and color scale distribution.</p>
<tt>Syntax:<br>
scale [linear|log|pow|sqrt|squared|asinh|sinh|histequ]<br>
[log exp <value>]<br>
[datasec yes|no]<br>
[limits <minvalue> <maxvalue>]<br>
[mode minmax|<value>|zscale|zmax]<br>
[scope local|global]<br>
[match]<br>
[match limits]<br>
[lock [yes|no]]<br>
[lock limits [yes|no]]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
scale<br>
scale log exp<br>
scale datasec<br>
scale limits<br>
scale mode<br>
scale scope<br>
scale lock<br>
scale lock limits<br>
<br>
ds9.set(string cmd)<br>
scale linear<br>
scale log exp 100<br>
scale datasec yes<br>
scale histequ<br>
scale limits 1 100<br>
scale mode zscale<br>
scale mode 99.5<br>
scale scope local<br>
scale match<br>
scale match limits<br>
scale lock yes<br>
scale lock limits yes<br>
scale open<br>
scale close<br></tt>
<p><b><a name="shm" id="shm"></a>shm</b></p>
<p>Load a shared memory segment into the current frame.</p>
<tt>Syntax:<br>
shm [<key> [<filename>]]<br>
[key <key> [<filename>]]<br>
[shmid <id> [<filename>]]<br>
[fits [key|shmid] <id> [<filename>]]<br>
[mosaicimage [iraf|wcs|wcsa...wcsz|wfpc2] [key|shmid] <id> [<filename>]]<br>
[mosaic [iraf|wcs|wcsa...wcsz] [key|shmid] <id> [<filename>]]<br>
[rgbcube [key|shmid] <id> [<filename>]<br>
[rgbimage [key|shmid] <id> [<filename>]]<br>
[rgbarray [key|shmid] <id> [xdim=<x>,ydim=<y>|dim=<dim>,zdim=3],bitpix=<b>,[skip=<s>]]<br>
[array [key|shmid] <id> [xdim=<x>,ydim=<y>|dim=<dim>],bitpix=<b>,[skip=<s>]]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
shm<br>
<br>
ds9.set(string cmd)<br>
shm 102<br>
shm key 102<br>
shm shmid 102 foo<br>
shm fits key 100 foo<br>
shm mosaicimage iraf key 100 foo<br>
shm mosaicimage wcs key 100 foo<br>
shm mosaicimage wcsa key 100 foo<br>
shm mosaicimage wfpc2 key 100 foo<br>
shm mosaic iraf key 100 foo<br>
shm mosaic wcs key 100 foo<br>
shm rgbcube key 100 foo<br>
shm rgbimage key 100 foo<br>
shm rgbarray key 100 [dim=200,zdim=3,bitpix=-32]<br>
shm array shmid 102 [dim=32,bitpix=-32]<br>
<br></tt> <b><a name="sia" id="sia"></a>sia<br></b>
<p>Support for VO Simple Image Access protocol. The first command will create a new search. All other commands operated on the last search created, unless indicated otherwise.</p>
<tt>Syntax:<br>
sia[2mass|akari|astrowise|cadc|cxc|mast|sdss|skyview|tgssadr]<br>
[<ref>] [cancel]<br>
[<ref>] [clear]<br>
[<ref>] [close]<br>
[<ref>] [coordinate <ra> <dec> <coordsys>]<br>
[<ref>] [crosshair]<br>
[<ref>] [export sb|tsv <filename>]<br>
[<ref>] [name <object>]<br>
[<ref>] [print]<br>
[<ref>] [retrieve]<br>
[<ref>] [save <filename>]<br>
[<ref>] [radius <value> degrees|arcmin|arcsec]<br>
[<ref>] [sky <skyframe>]<br>
[<ref>] [skyformat <skyformat>]<br>
[<ref>] [system <coordsys>]<br>
[<ref>] [update]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
sia<br>
<br>
ds9.set(string cmd)<br>
sia2mass<br>
siacancel<br>
siaclear<br>
siaclose<br>
siacoordinate 202.48 47.21 fk5<br>
siacrosshair<br>
siaexport tsv bar.tsv<br>
sianame m51<br>
siaprint<br>
siaretrieve<br>
siasave foo.xml<br>
siaradius 1degrees<br>
siasky fk5<br>
sia skyformat degrees<br>
siasystem wcs<br>
siaupdate<br>
<br></tt> <b><a name="single" id="single"></a>single</b>
<p>Select Single Display mode</p>
<tt>Syntax:<br>
single<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
single<br>
<br>
ds9.set(string cmd)<br>
single<br></tt>
<p><b><a name="skyview" id="skyview"></a>skyview</b></p>
<p>Support for SkyView image server at HEASARC.</p>
<tt>Syntax:<br>
skyview []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[pixels <width> <height>]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[survey <survey>]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
skyview name<br>
skyview coord<br>
skyview size<br>
skyview pixels<br>
skyview save<br>
skyview frame<br>
skyview survey<br>
<br>
ds9.set(string cmd)<br>
skyview<br>
skyview m31<br>
skyview name m31<br>
skyview name clear<br>
skyview 00:42:44.404 +41:16:08.78<br>
skyview size 60 60 arcmin<br>
skyview pixels 600 600<br>
skyview save yes<br>
skyview frame current<br>
skyview update frame<br>
skyview survey sdssi<br>
skyview open<br>
skyview close<br></tt>
<p><b><a name="sleep" id="sleep"></a>sleep</b></p>
<p>Delays execution for specified number of seconds. Default is 1 second.</p>
<tt>Syntax:<br>
sleep [#]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
sleep<br>
sleep 2<br></tt>
<p><b><a name="smooth" id="smooth"></a>smooth</b></p>
<p>Smooth current image or set smooth parameters.</p>
<p><tt>Boxcar width =<i>2*radius+1</i><br>
Tophat diameter =<i>2*radius+1</i><br>
Gaussian diameter =<i>2*radius+1,</i>mean<i>=0</i><br>
Elliptical Gaussian diameter =<i>2*radius+1,</i>mean<i>=0</i>Syntax:<br></tt></p>
<tt>smooth []<br>
[yes|no]<br>
[function boxcar|tophat|gaussian]<br>
[radius <value>]<br>
[radiusminor <value>]<br>
[sigma <value>]<br>
[sigmaminor <value>]<br>
[angle <value>]<br>
[match]<br>
[lock [yes|no]]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
smooth<br>
smooth function<br>
smooth radius<br>
smooth radiusminor<br>
smooth sigma<br>
smooth sigmaminor<br>
smooth angle<br>
smooth lock<br>
<br>
ds9.set(string cmd)<br>
smooth<br>
smooth yes<br>
smooth function tophat<br>
smooth radius 4<br>
smooth radiusminor 4<br>
smooth sigma 2.0<br>
smooth sigmaminor 2.0<br>
smooth angle 45<br>
smooth match<br>
smooth lock yes<br>
smooth open<br>
smooth close<br></tt>
<p><b><a name="source" id="source"></a>source</b></p>
<p>Source TCL code from a file.</p>
<tt>Syntax:<br>
source [filename]<br>
<br>
Example:<br>
ds9.set(string cmd)<br>
source foo.tcl</tt><br>
<p><b><a name="tcl" id="tcl"></a>tcl</b></p>
<p>Execute one TCL command.<br></p>
<tt>Syntax:<br>
tcl <tcl command><br>
<br>
Example:<br>
ds9.set(string cmd)<br>
tcl {puts {Hello, World}}<br></tt>
<p><b><a name="threads" id="threads"></a>threads</b></p>
<p>Set number of process threads for functions which are multi-threaded.</p>
<tt>Syntax:<br>
threads #<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
threads<br>
ds9.set(string cmd)<br>
threads 8</tt><br>
<p><b><a name="tiff" id="tiff"></a>tiff</b></p>
<p>Load TIFF image into current frame. Optional parameters: <tt>tiff</tt> compression method.</p>
<tt>Syntax:<br>
tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
tiff<br>
tiff jpeg<br>
<br>
ds9.set(string cmd)<br>
tiff foo.tiff<br>
tiff new foo.tiff<br>
tiff slice foo.tiff</tt><br>
<p><b><a name="tile" id="tile"></a>tile</b></p>
<p>Controls the tile display mode.</p>
<tt>Syntax:<br>
tile []<br>
[yes|no]<br>
[mode grid|column|row]<br>
[grid]<br>
[grid mode automatic|manual]<br>
[grid direction x|y]<br>
[grid layout <col> <row>]<br>
[grid gap <pixels>]<br>
[row]<br>
[column]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
tile<br>
tile mode<br>
tile grid mode<br>
tile grid direction<br>
tile grid layout<br>
tile grid gap<br>
<br>
ds9.set(string cmd)<br>
tile<br>
tile yes<br>
tile mode row<br>
tile grid<br>
tile grid mode manual<br>
tile grid direction x<br>
tile grid layout 5 5<br>
tile grid gap 10<br>
tile row<br>
tile column</tt>
<p><b><a name="update" id="update"></a>update</b></p>
<p>Updates the current frame or region of frame. In the second form, the first argument is the number of the fits HDU (starting with 1) and the remaining args are a bounding box in IMAGE coordinates. By default, the screen is updated the next available idle cycle. However, you may force an immediate update by specifying the NOW option.</p>
<tt>Syntax:<br>
update []<br>
[# x1 y1 x2 y2]<br>
[now]<br>
[now # x1 y1 x2 y2]<br>
<br>
Example:<br>
<br>
ds9.set(string cmd)<br>
update<br>
update 1 100 100 300 400<br>
update now<br>
update now 1 100 100 300 400</tt><br>
<p><b><a name="url" id="url"></a>url</b></p>
<p>Load FITS from URL into the current frame</p>
<tt>Syntax:<br>
url <url><br>
<br>
Example:<br>
ds9.set(string cmd)<br>
url http://foo.bar.edu/foo.fits</tt>
<p><b><a name="version" id="version"></a>version</b></p>
<p>Returns the current version of DS9.</p>
<tt>Syntax:<br>
version<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
version</tt>
<p><b><a name="view" id="view"></a>view</b></p>
<p>Controls the GUI.</p>
<tt>Syntax:<br>
view [layout horizontal|vertical]<br>
[keyvalue <string>]<br>
[info yes|no]<br>
[panner yes|no]<br>
[magnifier yes|no]<br>
[buttons yes|no]<br>
[colorbar yes|no]<br>
[colorbar horizontal|vertical]<br>
[colorbar numerics yes|no]<br>
[graph horizontal|vertical yes|no]<br>
[filename yes|no[<br>
[object yes|no]<br>
[keyword yes|no]<br>
[minmax yes|no]<br>
[lowhigh yes|no]<br>
[units yes|no]<br>
[image|physical|wcs|wcsa...wcsz yes|no]<br>
[frame yes|no]<br>
[red yes|no]<br>
[green yes|no]<br>
[blue yes|no]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
view layout<br>
view keyvalue<br>
view info<br>
view panner<br>
view magnifier<br>
view buttons<br>
view colorbar<br>
view graph horizontal<br>
view filename<br>
view object<br>
view keyword<br>
view minmax<br>
view lowhigh<br>
view units<br>
view image<br>
view wcsa<br>
view red<br>
view frame<br>
<br>
ds9.set(string cmd)<br>
view layout vertical<br>
view keyvalue BITPIX<br>
view info yes<br>
view panner yes<br>
view magnifier yes<br>
view buttons yes<br>
view colorbar yes<br>
view graph horizontal yes<br>
view filename yes<br>
view object yes<br>
view keyword yes<br>
view minmax yes<br>
view lowhigh yes<br>
view units yes<br>
view wcsa yes<br>
view frame yes<br>
view red yes<br>
view green yes<br>
view blue yes</tt><br>
<p><b><a name="vla" id="vla"></a>vla</b></p>
<p>Support for VLA Sky Survey.</p>
<tt>Syntax:<br>
vla []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[survey first|stripe82]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
vla name<br>
vla coord<br>
vla size<br>
vla save<br>
vla frame<br>
vla survey<br>
<br>
ds9.set(string cmd)<br>
vla<br>
vla m31<br>
vla name m31<br>
vla name clear<br>
vla 00:42:44.404 +41:16:08.78<br>
vla size 60 60 arcmin<br>
vla save yes<br>
vla frame current<br>
vla update frame<br>
vla survey stripe82<br>
vla open<br>
vla close<br></tt>
<p><b><a name="vlss" id="vlss"></a>vlss</b></p>
<p>Support for NRAO VLSS Sky Survey.</p>
<tt>Syntax:<br>
vlss []<br>
[<object>]<br>
[name <object>|clear]<br>
[<ra> <dec>] # in wcs fk5<br>
[size <width> <height> degrees|arcmin|arcsec]<br>
[save yes|no]<br>
[frame new|current]<br>
[update frame|crosshair]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
vlss name<br>
vlss coord<br>
vlss size<br>
vlss save<br>
vlss frame<br>
<br>
ds9.set(string cmd)<br>
vlss<br>
vlss m31<br>
vlss name m31<br>
vlss name clear<br>
vlss 00:42:44.404 +41:16:08.78<br>
vlss size 60 60 arcmin<br>
vlss save yes<br>
vlss frame current<br>
vlss update frame<br>
vlss open<br>
vlss close</tt><br>
<p><b><a name="vo" id="vo"></a>vo</b></p>
<p>Invoke an connection to a Virtual Observatory site.</p>
<tt>Syntax:<br>
vo [method xpa|mime]<br>
[server <url>]<br>
[internal yes|no]<br>
[delay #]<br>
[<url>]<br>
[connect <url>]<br>
[disconnect <url>]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
vo<br>
vo method<br>
vo server<br>
vo internal<br>
vo delay<br>
vo connect<br>
<br>
ds9.set(string cmd)<br>
vo method xpa<br>
vo server "http://foo.bar.edu/list.txt"<br>
vo internal yes<br>
vo delay 15<br>
vo chandra-ed<br>
vo connect chandra-ed<br>
vo disconnect chandra-ed<br>
vo open<br>
vo close<br></tt>
<p><b><a name="wcs" id="wcs"></a>wcs</b></p>
<p>Controls the World Coordinate System for the current frame. If the wcs system, skyframe, or skyformat is modified, the info panel, compass, grid, and alignment will be modified accordingly. Also, using this access point, a new WCS specification can be loaded and used by the current image regardless of the WCS that was contained in the image file. WCS specification can be sent to DS9 as an ASCII file . Please see <a href="file.html#WCS">WCS</a> for more information.</p>
<tt>Syntax:<br>
wcs [[system] wcs|wcsa...wcsz]<br>
[[sky] fk4|fk5|icrs|galactic|ecliptic]<br>
[[skyformat] degrees|sexagesimal]<br>
[align yes|no]<br>
[reset [#]]<br>
[replace [#] <filename>]<br>
[append [#] <filename>]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
wcs<br>
wcs system<br>
wcs sky<br>
wcs skyformat<br>
wcs align<br>
<br>
ds9.set(string cmd)<br>
wcs wcs<br>
wcs system wcs<br>
wcs fk5<br>
wcs sky fk5<br>
wcs sexagesimal<br>
wcs skyformat sexagesimal<br>
wcs align yes<br>
wcs reset<br>
wcs reset 3<br>
wcs replace foo.wcs<br>
wcs replace 3 foo.wcs<br>
wcs append foo.wcs<br>
wcs append 3 foo.wcs<br>
wcs open<br>
wcs close<br></tt>
<p><b><a name="web" id="web"></a>web</b></p>
<p>Display specified URL in the web display.</p>
<tt>Syntax:<br>
web []<br>
[<url>]<br>
[new <webname> <url>]<br>
[<webname>] [click back|forward|stop|reload|#]<br>
[<webname>] [clear]<br>
[<webname>] [close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
web<br>
<br>
ds9.set(string cmd)<br>
web www.cnn.com<br>
web new www.cnn.com<br>
web hvweb www.apple.com<br>
web click back<br>
web click 2<br>
web clear<br>
web close<br></tt>
<p><b><a name="width" id="width"></a>width</b></p>
<p>Set the width of the image display window.</p>
<tt>Syntax:<br>
width [<value>]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
width<br>
<br>
ds9.set(string cmd)<br>
width 512<br></tt>
<p><b><a name="zscale" id="zscale"></a>zscale</b></p>
<p>Set Scale Limits based on the <i>IRAF</i> algorithm.</p>
<tt>Syntax:<br>
zscale []<br>
[contrast]<br>
[sample]<br>
[line]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
zscale contrast<br>
zscale sample<br>
zscale line<br>
<br>
ds9.set(string cmd)<br>
zscale<br>
zscale contrast .25<br>
zscale sample 600<br>
zscale line 120<br></tt>
<p><b><a name="zoom" id="zoom"></a>zoom</b></p>
<p>Controls the current zoom value for the current frame.</p>
<tt>Syntax:<br>
zoom [<value>]<br>
[<value> <value>]<br>
[to <value>]<br>
[to <value> <value>]<br>
[in]<br>
[out]<br>
[to fit]<br>
[open|close]<br>
<br>
Example:<br>
string value = ds9.get(string cmd)<br>
zoom<br>
<br>
ds9.set(string cmd)<br>
zoom 2<br>
zoom 2 4<br>
zoom to 4<br>
zoom to 2 4<br>
zoom in<br>
zoom out<br>
zoom to fit<br>
zoom open<br>
zoom close<br></tt></blockquote>
</body>
</html>
|
