File: commands_reference.html

package info (click to toggle)
siril 1.4.0~rc2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 47,352 kB
  • sloc: ansic: 174,082; cpp: 28,254; python: 7,891; makefile: 974; xml: 777; sh: 271
file content (2964 lines) | stat: -rw-r--r-- 251,658 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
 


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
  <meta charset="utf-8" />
  <meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Commands &mdash; Siril 1.4.0-rc1 documentation</title>
      
      
      
      

  
      
      
      
      
      
      
      
    
    
    
    
    
     
<meta name="readthedocs-project-slug" content="siril" /><meta name="readthedocs-version-slug" content="stable" /><meta name="readthedocs-resolver-filename" content="/Commands.html" /><meta name="readthedocs-http-status" content="200" /></head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="index.html">
            
              <img src="_static/org.free_astro.siril.svg" class="logo" alt="Logo"/>
          </a>
              <div class="switch-menus">
                <div class="version-switch"></div>
                <div class="language-switch"></div>
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">General</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="GUI.html">Graphical User Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="cwd.html">Working Directory</a></li>
<li class="toctree-l1"><a class="reference internal" href="Preferences.html">Preferences</a></li>
<li class="toctree-l1"><a class="reference internal" href="FileFormats.html">File Formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="Color-management.html">Color Management</a></li>
<li class="toctree-l1"><a class="reference internal" href="Sequences.html">Sequences</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">(Pre-)processing</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Workflow.html">Definitions and workflow</a></li>
<li class="toctree-l1"><a class="reference internal" href="Preprocessing.html">Preprocessing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Processing.html">Processing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Scientific Analyses and tools</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Astrometry.html">Astrometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="Dynamic-PSF.html">Dynamic PSF</a></li>
<li class="toctree-l1"><a class="reference internal" href="FITS-header.html">FITS header</a></li>
<li class="toctree-l1"><a class="reference internal" href="Intensity-Profiling.html">Intensity Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="Image-inspection.html">Image Inspectors</a></li>
<li class="toctree-l1"><a class="reference internal" href="Photometry.html">Photometry</a></li>
<li class="toctree-l1"><a class="reference internal" href="Plot.html">Plotting Feature</a></li>
<li class="toctree-l1"><a class="reference internal" href="Statistics.html">Statistics</a></li>
<li class="toctree-l1"><a class="reference internal" href="SirilForScientists.html">Siril for Scientists</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Automation</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Scripts.html">Scripting</a></li>
<li class="toctree-l1"><a class="reference internal" href="Headless.html">Headless mode</a></li>
<li class="toctree-l1"><a class="reference internal" href="Pathparsing.html">Path parsing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Livestacking</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Livestack.html">Livestacking</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendices</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Commands Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="Python-API.html">Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="Issues.html">How to report issues</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Siril</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
      <li class="breadcrumb-item active">Commands</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/Commands.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="commands">
<h1>Commands<a class="headerlink" href="#commands" title="Link to this heading"></a></h1>
<p>The following page lists all the commands available in Siril 1.4.0-rc1.</p>
<p>You can access an index by clicking this icon <a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a>.</p>
<p>Commands marked with this icon <img alt="Scriptable" src="_images/scriptable.svg" /> can be used in scripts while those marked with this one <img alt="Non scriptable" src="_images/nonscriptable.svg" /> cannot.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>For all the sequence commands typed in the command bar of the GUI, you can replace argument <strong>sequencename</strong> with a <code class="docutils literal notranslate"><span class="pre">.</span></code> if the sequence to be processed is already loaded.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>If you want to provide an argument that includes a string with spaces, for example a filename, you need to quote the entire argument not just the string. So for example you should use <code class="docutils literal notranslate"><span class="pre">command</span> <span class="pre">&quot;-filename=My</span> <span class="pre">File.fits&quot;</span></code>, <strong>not</strong> <code class="docutils literal notranslate"><span class="pre">command</span> <span class="pre">-filename=&quot;My</span> <span class="pre">File.fits&quot;</span></code>.</p>
</div>
<p id="addmax"><span class="commandname">addmax  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>addmax filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes a new image combining the image in memory with the image <strong>filename</strong>. At each pixel location, the new value is determined as the max of value in current image and in <strong>filename</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="asinh"><span class="commandname">asinh  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>asinh [-human] stretch { [offset] [-clipmode=] }
</pre></div>
</div>
<div class="line-block">
<div class="line">Stretches the image to show faint objects using an hyperbolic arcsin transformation. The mandatory argument <strong>stretch</strong>, typically between 1 and 1000, will give the strength of the stretch. The black point can be offset by providing an optional <strong>offset</strong> argument in the normalized pixel value of [0, 1]. Finally the option <strong>-human</strong> enables using human eye luminous efficiency weights to compute the luminance used to compute the stretch value for each pixel, instead of the simple mean of the channels pixel values. This stretch method preserves lightness from the L*a*b* color space. The clip mode can be set using the argument <strong>-clipmode=</strong>: values <strong>clip</strong>, <strong>rescale</strong>, <strong>rgbblend</strong> or <strong>globalrescale</strong> are accepted and the default is rgbblend</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="autoghs"><span class="commandname">autoghs  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>autoghs [-linked] shadowsclip stretchamount [-b=] [-hp=] [-lp=] [-clipmode=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Application of the generalized hyperbolic stretch with a symmetry point SP defined as k.sigma from the median of each channel (the provided <strong>shadowsclip</strong> value is the k here and can be negative). By default, SP and the stretch are computed per channel; SP can be computed as a mean of image channels by passing <strong>-linked</strong>. The stretch amount <strong>D</strong> is provided in the second mandatory argument.</div>
<div class="line">Implicit values of 13 for <strong>B</strong>, making it very focused on the SP brightness range, 0.7 for <strong>HP</strong>, 0 for <strong>LP</strong> are used but can be changed with the options of the same names. The clip mode can be set using the argument <strong>-clipmode=</strong>: values <strong>clip</strong>, <strong>rescale</strong>, <strong>rgbblend</strong> or <strong>globalrescale</strong> are accepted and the default is rgbblend</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="autostretch"><span class="commandname">autostretch  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>autostretch [-linked] [shadowsclip [targetbg]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Auto-stretches the currently loaded image, with different parameters for each channel (unlinked) unless <strong>-linked</strong> is passed. Arguments are optional, <strong>shadowclip</strong> is the shadows clipping point, measured in sigma units from the main histogram peak (default is -2.8), <strong>targetbg</strong> is the target background value, giving a final brightness to the image, range [0, 1], default is 0.25. The default values are those used in the Auto-stretch rendering from the GUI.</div>
<div class="line"><br /></div>
<div class="line">Do not use the unlinked version after color calibration, it will alter the white balance</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="bg"><span class="commandname">bg  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>bg
</pre></div>
</div>
<div class="line-block">
<div class="line">Returns the background level of the loaded image</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="bgnoise"><span class="commandname">bgnoise  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>bgnoise
</pre></div>
</div>
<div class="line-block">
<div class="line">Returns the background noise level of the loaded image</div>
</div>
<p>For more information, see the <a class="reference internal" href="Statistics.html#background-noise"><span class="std std-ref">statistics documentation</span></a></p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="binxy"><span class="commandname">binxy  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>binxy coefficient [-sum]
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes the numerical binning of the in-memory image (sum of the pixels 2x2, 3x3..., like the analogic binning of CCD camera). If the optional argument <strong>-sum</strong> is passed, then the sum of pixels is computed, while it is the average when no optional argument is provided</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="boxselect"><span class="commandname">boxselect  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>boxselect [-clear] [x y width height]
</pre></div>
</div>
<div class="line-block">
<div class="line">Make a selection area in the currently loaded image with the arguments <strong>x</strong>, <strong>y</strong>, <strong>width</strong> and <strong>height</strong>, with <strong>x</strong> and <strong>y</strong> being the coordinates of the top left corner starting at (0, 0), and <strong>width</strong> and <strong>height</strong>, the size of the selection. The <strong>-clear</strong> argument deletes any selection area. If no argument is passed, the current selection is printed</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="calibrate"><span class="commandname">calibrate  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>calibrate sequencename [-bias=filename] [-dark=filename] [-flat=filename] [-cc=dark [siglo sighi] || -cc=bpm bpmfile] [-cfa] [-debayer] [-fix_xtrans] [-equalize_cfa] [-opt[=exp]] [-all] [-prefix=] [-fitseq]
</pre></div>
</div>
<div class="line-block">
<div class="line">Calibrates the sequence <strong>sequencename</strong> using bias, dark and flat given in argument.</div>
<div class="line"><br /></div>
<div class="line">For bias, a uniform level can be specified instead of an image, by entering a quoted expression starting with an = sign, such as -bias=&quot;=256&quot; or -bias=&quot;=64*$OFFSET&quot;.</div>
<div class="line"><br /></div>
<div class="line">By default, cosmetic correction is not activated. If you wish to apply some, you will need to specify it with <strong>-cc=</strong> option.</div>
<div class="line">You can use <strong>-cc=dark</strong> to detect hot and cold pixels from the masterdark (a masterdark must be given with the <strong>-dark=</strong> option), optionally followed by <strong>siglo</strong> and <strong>sighi</strong> for cold and hot pixels respectively. A value of 0 deactivates the correction. If sigmas are not provided, only hot pixels detection with a sigma of 3 will be applied.</div>
<div class="line">Alternatively, you can use <strong>-cc=bpm</strong> followed by the path to your Bad Pixel Map to specify which pixels must be corrected. An example file can be obtained with a <em>find_hot</em> command on a masterdark.</div>
<div class="line"><br /></div>
<div class="line">Three options apply to color images (in CFA format): <strong>-cfa</strong> for cosmetic correction purposes, <strong>-debayer</strong> to demosaic images before saving them, and <strong>-equalize_cfa</strong> to equalize the mean intensity of RGB layers of the master flat, to avoid tinting the calibrated image.</div>
<div class="line">The <strong>-fix_xtrans</strong> option is dedicated to X-Trans images by applying a correction on darks and biases to remove a rectangle pattern caused by autofocus.</div>
<div class="line">It's also possible to optimize dark subtraction with <strong>-opt</strong>, which requires the supply of bias and dark masters, and automatically calculates the coefficient to be applied to dark, or calculates the coefficient thanks to the exposure keyword with <strong>-opt=exp</strong>.</div>
<div class="line">By default, frames marked as excluded will not be processed. The argument <strong>-all</strong> can be used to force processing of all frames even if marked as excluded.</div>
<div class="line">The output sequence name starts with the prefix &quot;pp_&quot; unless otherwise specified with option <strong>-prefix=</strong>.</div>
<div class="line">If <strong>-fitseq</strong> is provided, the output sequence will be a FITS sequence (single file)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="calibrate_single"><span class="commandname">calibrate_single  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>calibrate_single imagename [-bias=filename] [-dark=filename] [-flat=filename] [-cc=dark [siglo sighi] || -cc=bpm bpmfile] [-cfa] [-debayer] [-fix_xtrans] [-equalize_cfa] [-opt[=exp]] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Calibrates the image <strong>imagename</strong> using bias, dark and flat given in argument.</div>
<div class="line"><br /></div>
<div class="line">For bias, a uniform level can be specified instead of an image, by entering a quoted expression starting with an = sign, such as -bias=&quot;=256&quot; or -bias=&quot;=64*$OFFSET&quot;.</div>
<div class="line"><br /></div>
<div class="line">By default, cosmetic correction is not activated. If you wish to apply some, you will need to specify it with <strong>-cc=</strong> option.</div>
<div class="line">You can use <strong>-cc=dark</strong> to detect hot and cold pixels from the masterdark (a masterdark must be given with the <strong>-dark=</strong> option), optionally followed by <strong>siglo</strong> and <strong>sighi</strong> for cold and hot pixels respectively. A value of 0 deactivates the correction. If sigmas are not provided, only hot pixels detection with a sigma of 3 will be applied.</div>
<div class="line">Alternatively, you can use <strong>-cc=bpm</strong> followed by the path to your Bad Pixel Map to specify which pixels must be corrected. An example file can be obtained with a <em>find_hot</em> command on a masterdark.</div>
<div class="line"><br /></div>
<div class="line">Three options apply to color images (in CFA format): <strong>-cfa</strong> for cosmetic correction purposes, <strong>-debayer</strong> to demosaic images before saving them, and <strong>-equalize_cfa</strong> to equalize the mean intensity of RGB layers of the master flat, to avoid tinting the calibrated image.</div>
<div class="line">The <strong>-fix_xtrans</strong> option is dedicated to X-Trans images by applying a correction on darks and biases to remove a rectangle pattern caused by autofocus.</div>
<div class="line">It's also possible to optimize dark subtraction with <strong>-opt</strong>, which requires the supply of bias and dark masters, and automatically calculates the coefficient to be applied to dark, or calculates the coefficient thanks to the exposure keyword with <strong>-opt=exp</strong></div>
<div class="line">The output filename starts with the prefix &quot;pp_&quot; unless otherwise specified with option <strong>-prefix=</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="capabilities"><span class="commandname">capabilities  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>capabilities
</pre></div>
</div>
<div class="line-block">
<div class="line">Lists Siril capabilities, based on compilation options and runtime</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="catsearch"><span class="commandname">catsearch  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>catsearch name
</pre></div>
</div>
<div class="line-block">
<div class="line">Searches an object by <strong>name</strong> and adds it to the user annotation catalog. The object is first searched in the annotation catalogs, if not found a request is made to SIMBAD.</div>
<div class="line">The object can be a solar system object, in which case a prefix, 'a:' for asteroid, 'p:' for planet, 'c:' for comet, 'dp:' for dwarf planet or 's:' for natural satellite, is required before the object name. The search is done for the date, time and observing location found in the image header, using the <a class="reference external" href="https://ssp.imcce.fr/webservices/miriade/howto/ephemcc/#howto-sso">IMCCE Miriade service</a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="ccm"><span class="commandname">ccm  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>ccm m00 m01 m02 m10 m11 m12 m20 m21 m22 [gamma]
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies a color conversion matrix to the current image.</div>
<div class="line"><br /></div>
<div class="line">There are 9 mandatory arguments corresponding to the 9 matrix elements:</div>
<div class="line"><br /></div>
<div class="line">m00, m01, m02</div>
<div class="line">m10, m11, m12</div>
<div class="line">m20, m21, m22</div>
<div class="line"><br /></div>
<div class="line">An additional tenth argument <strong>[gamma]</strong> can be provided: if it is omitted, it defaults to 1.0.</div>
<div class="line"><br /></div>
<div class="line">These are applied to each pixel according to the following formulae:</div>
<div class="line"><br /></div>
<div class="line">r' = (m00 * r + m01 * g + m02 * b)^(-1/gamma)</div>
<div class="line">g' = (m10 * r + m11 * g + m12 * b)^(-1/gamma)</div>
<div class="line">b' = (m20 * r + m21 * g + m22 * b)^(-1/gamma)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="cd"><span class="commandname">cd  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>cd directory
</pre></div>
</div>
<div class="line-block">
<div class="line">Sets the new current working directory.</div>
<div class="line"><br /></div>
<div class="line">The argument <strong>directory</strong> can contain the ~ token, expanded as the home directory, directories with spaces in the name can be protected using single or double quotes</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="cdg"><span class="commandname">cdg  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>cdg
</pre></div>
</div>
<div class="line-block">
<div class="line">Returns the coordinates of the center of gravity of the image. Only pixels with values above 15.7% of max ADU and having four neighbors filling the same condition are used to compute it, and it is computed only if there are at least 50 of them</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="clahe"><span class="commandname">clahe  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>clahe cliplimit tileSize
</pre></div>
</div>
<div class="line-block">
<div class="line">Equalizes the histogram of an image using Contrast Limited Adaptive Histogram Equalization.</div>
<div class="line"><br /></div>
<div class="line"><strong>cliplimit</strong> sets the threshold for contrast limiting.</div>
<div class="line"><strong>tilesize</strong> sets the size of grid for histogram equalization. Input image will be divided into equally sized rectangular tiles</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="clear"><span class="commandname">clear  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>clear
</pre></div>
</div>
<div class="line-block">
<div class="line">Clears the graphical output logs</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="clearstar"><span class="commandname">clearstar  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>clearstar
</pre></div>
</div>
<div class="line-block">
<div class="line">Clears all the stars saved in memory and displayed on the screen</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="close"><span class="commandname">close  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>close
</pre></div>
</div>
<div class="line-block">
<div class="line">Properly closes the opened image and the opened sequence, if any</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="conesearch"><span class="commandname">conesearch  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>conesearch [limit_magnitude] [-cat=] [-phot] [-obscode=] [-tag={on|off}] [-log={on|off}] [-trix=] [-out=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Displays stars from the local catalog by default for the loaded plate solved image, down to the provided <strong>limit_magnitude</strong> (13 by default for most catalogues, except 14.5 for aavso_chart, 20 for solsys, and omitted for pgc).</div>
<div class="line">An alternate online catalog can be specified with <strong>-cat=</strong>, taking values</div>
<div class="line">- for stars: tycho2, nomad, gaia, localgaia, ppmxl, bsc, apass, gcvs, vsx, simbad, aavso_chart</div>
<div class="line">- for exoplanets: exo</div>
<div class="line">- for deep-sky: pgc</div>
<div class="line">- for solar system objects: solsys (closest <a class="reference external" href="https://vo.imcce.fr/webservices/data/displayIAUObsCodes.php">IAU observatory code</a> can be passed with the argument <strong>-obscode=</strong> for better position accuracy)</div>
<div class="line"><br /></div>
<div class="line">For stars catalogues containing photometric data, stars with no B-V information will be kept; they can be excluded by passing <strong>-phot</strong></div>
<div class="line">The argument <strong>-trix=</strong> can be passed instead of a catalogue followed by a number between 0 and 511 to plot stars contained in local catalogues trixel of level 3 (for dev usage mainly)</div>
<div class="line"><br /></div>
<div class="line">Some catalogs (bsc, gcvs, pgc, exo, aavso_chart, varisum and solsys) will also display, by default, names alongside markers in the display (GUI only) and list them in the log. For others with larger number of objects, namely vsx and simbad, the information can also be shown but, as it may clutter the display, it is not activated by default. This behavior can be toggled on/off with the options <strong>-tag=on|off</strong> to display names alongside markers and <strong>-log=on|off</strong> to list the objects in the console log</div>
<div class="line"><br /></div>
<div class="line">The list of items that are present in the image can optionally saved to a csv file by passing the argument <strong>-out=</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="convert"><span class="commandname">convert  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>convert basename [-debayer] [-fitseq] [-ser] [-start=index] [-out=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Converts all images of the current working directory that are in a supported format into Siril's sequence of FITS images (several files) or a FITS sequence (single file) if <strong>-fitseq</strong> is provided or a SER sequence (single file) if <strong>-ser</strong> is provided. The argument <strong>basename</strong> is the base name of the new sequence, numbers and the extension will be put behind it.</div>
<div class="line">For FITS images, Siril will try to make a symbolic link; if not possible, files will be copied. The option <strong>-debayer</strong> applies demosaicing to CFA input images; in this case no symbolic link is done.</div>
<div class="line"><strong>-start=index</strong> sets the starting index number, useful to continue an existing sequence (not used with -fitseq or <strong>-ser</strong>; make sure you remove or clear the target .seq if it exists in that case).</div>
<div class="line">The <strong>-out=</strong> option changes the output directory to the provided argument.</div>
<div class="line"><br /></div>
<div class="line">See also CONVERTRAW and LINK</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#convertraw"><span class="std std-ref">convertraw</span></a>, <a class="reference internal" href="#link"><span class="std std-ref">link</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="convertraw"><span class="commandname">convertraw  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>convertraw basename [-debayer] [-fitseq] [-ser] [-start=index] [-out=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same as CONVERT but converts only DSLR RAW files found in the current working directory</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#convert"><span class="std std-ref">convert</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="cosme"><span class="commandname">cosme  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>cosme [filename].lst
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies the local mean to a set of pixels on the loaded image (cosmetic correction). The coordinates of these pixels are in a text file [.lst file], the FIND_HOT command can also create it for single hot pixels, but manual operation is needed to remove rows or columns. COSME is adapted to correct residual hot and cold pixels after calibration.</div>
<div class="line">Instead of providing the list of bad pixels, it's also possible to detect them in the current image using the FIND_COSME command</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#find_hot"><span class="std std-ref">find_hot</span></a>, <a class="reference internal" href="#find_cosme"><span class="std std-ref">find_cosme</span></a></div>
</div>
<p>File format for the bad pixels list:
* Lines in the form <cite>P x y</cite> will fix the pixel at coordinates (x, y) type is an optional character (C or H) specifying to Siril if the current pixel is cold or hot. This line is created by the command FIND_HOT but you also can add the two following line types manually
* Lines in the form <cite>C x 0</cite> will fix the bad column at coordinates x.
* Lines in the form <cite>L y 0</cite> will fix the bad line at coordinates y.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="cosme_cfa"><span class="commandname">cosme_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>cosme_cfa [filename].lst
</pre></div>
</div>
<div class="line-block">
<div class="line">Same function as COSME but applying to RAW CFA images</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#cosme"><span class="std std-ref">cosme</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="crop"><span class="commandname">crop  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>crop [x y width height]
</pre></div>
</div>
<div class="line-block">
<div class="line">Crops to a selected area of the loaded image.</div>
<div class="line"><br /></div>
<div class="line">If a selection is active, no further arguments are required. Otherwise, or in scripts, arguments have to be given, with <strong>x</strong> and <strong>y</strong> being the coordinates of the top left corner, and <strong>width</strong> and <strong>height</strong> the size of the selection. Alternatively, the selection can be made using the BOXSELECT command</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#boxselect"><span class="std std-ref">boxselect</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="ddp"><span class="commandname">ddp  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>ddp level coef sigma
</pre></div>
</div>
<div class="line-block">
<div class="line">Performs a DDP (digital development processing) on the loaded image, as described first by Kunihiko Okano. This implementation is the one described in IRIS.</div>
<div class="line"><br /></div>
<div class="line">It combines a linear distribution on low levels (below <strong>level</strong>) and a non-linear one on high levels.</div>
<div class="line">It uses a Gaussian filter of standard deviation <strong>sigma</strong> and multiplies the resulting image by <strong>coef</strong>. Typical values for <strong>sigma</strong> are within 0.7 and 2. The level argument should be in the range [0, 65535] for 16-bit images and may be given either in the range [0, 1] or [0, 65535] for 32-bit images in which case it will be scaled automatically</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="denoise"><span class="commandname">denoise  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>denoise [-nocosmetic] [-mod=m] [ -vst | -da3d | -sos=n [-rho=r] ] [-indep]
</pre></div>
</div>
<div class="line-block">
<div class="line">Denoises the image using the non-local Bayesian algorithm described by <a class="reference external" href="https://www.ipol.im/pub/art/2013/16">Lebrun, Buades and Morel</a>.</div>
<div class="line"><br /></div>
<div class="line">It is strongly recommended to apply cosmetic correction to remove salt and pepper noise before running denoise, and by default this command will apply cosmetic correction automatically. However, if this has already been carried out earlier in the workflow it may be disabled here using the optional command <strong>-nocosmetic</strong>.</div>
<div class="line"><br /></div>
<div class="line">An optional argument <strong>-mod=m</strong> may be given, where 0 &lt;= m &lt;= 1. The output pixel is computed as : <em>out=m x d + (1 − m) x in</em>, where <em>d</em> is the denoised pixel value. A modulation value of 1 will apply no modulation. If the parameter is omitted, it defaults to 1.</div>
<div class="line"><br /></div>
<div class="line">The optional argument <strong>-vst</strong> can be used to apply the generalised Anscombe variance stabilising transform prior to NL-Bayes. This is useful with photon-starved images such as single subs, where the noise follows a Poisson or Poisson-Gaussian distribution rather than being primarily Gaussian. It cannot be used in conjunction with DA3D or SOS, and for denoising stacked images it is usually not beneficial.</div>
<div class="line"><br /></div>
<div class="line">The optional argument <strong>-da3d</strong> can be used to enable Data-Adaptive Dual Domain Denoising (DA3D) as a final stage denoising algorithm. This uses the output of BM3D as a guide image to refine the denoising. It improves detail and reduces staircasing artefacts.</div>
<div class="line"><br /></div>
<div class="line">The optional argument <strong>-sos=n</strong> can be used to enable Strengthen-Operate-Subtract (SOS) iterative denoise boosting, with the number of iterations specified by n. In particular, this booster may produce better results if the un-boosted NL-Bayes algorithm produces artefacts in background areas. If both -da3d and -sos=n are specified, the last to be specified will apply.</div>
<div class="line"><br /></div>
<div class="line">The optional argument <strong>-rho=r</strong> may be specified, where 0 &lt; r &lt; 1. This is used by the SOS booster to determine the amount of noisy image added in to the intermediate result between each iteration. If -sos=n is not specified then the parameter is ignored.</div>
<div class="line"><br /></div>
<div class="line">The default is not to apply DA3D or SOS, as the improvement in denoising is usually relatively small and these techniques requires additional processing time.</div>
<div class="line"><br /></div>
<div class="line">In very rare cases, blocky coloured artefacts may be found in the output when denoising colour images. The optional argument <strong>-indep</strong> can be used to prevent this by denoising each channel separately. This is slower but will eliminate artefacts</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="dir"><span class="commandname">dir  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>dir
</pre></div>
</div>
<div class="line-block">
<div class="line">Lists files and directories in the working directory</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
<div class="line">This command is only available on Microsoft Windows, for the equivalent command on Linux and MacOS, see <a class="reference internal" href="#ls"><span class="std std-ref">ls</span></a>.</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="disto"><span class="commandname">disto  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>disto [clear]
</pre></div>
</div>
<div class="line-block">
<div class="line">Shows distortion field on a plate-solved image which solution includes distortion terms</div>
<div class="line"><br /></div>
<div class="line">Pass option <strong>clear</strong> to disable</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="dumpheader"><span class="commandname">dumpheader  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>dumpheader
</pre></div>
</div>
<div class="line-block">
<div class="line">Dumps the FITS header of the loaded image in the console</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="entropy"><span class="commandname">entropy  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>entropy
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes the entropy of the loaded image on the displayed layer, only in the selected area if one has been selected or in the whole image. The entropy is one way of measuring the noise or the details in an image</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="epf"><span class="commandname">epf  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>epf [-guided] [-d=] [-si=] [-ss=] [-mod=] [-guideimage=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies an edge preserving filter. By default a bilateral filter is applied; a guided filter can be specified using the argument <strong>-guided</strong>. The filter diameter defaults to 3 and can be set using <strong>-d=</strong>. Be careful with values of d greater than 20 as the algorithm can be computationally expensive.</div>
<div class="line"><br /></div>
<div class="line">The intensity filtering sigma value can be set using <strong>-si=</strong> and the spatial sigma value can be set using <strong>-ss=</strong>. Sigma values represent the difference in pixel values over which the filter acts strongly: for 32-bit images the value should be between 0 and 1.0, whereas for 16-bit images it should be between 0 and 65535. The defaults if not specified are for both to be set to 11. If <strong>-d=0</strong> is set then the filter diameter will be set automatically based on the value of <strong>-ss</strong>. <em>Note that when applying a guided filter, only</em> <strong>-sc</strong> <em>applies.</em></div>
<div class="line"><br /></div>
<div class="line">When specifying a guided filter, a guide image may be set using <strong>-guideimage=</strong>. The default if no guide image is specified is to perform a self-guided filter. <em>Note: the guide image must have the same dimensions as the image to be filtered!</em></div>
<div class="line"><br /></div>
<div class="line">The strength of the filter can be modulated using the <strong>-mod=</strong> argument. If mod = 1.0 the full effect of the filter will be applied; for mod less than 1.0 a proportion of the original image will be mixed with the result, and for mod = 0.0 no filtering will be applied</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="exit"><span class="commandname">exit  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>exit
</pre></div>
</div>
<div class="line-block">
<div class="line">Quits the application</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="extract"><span class="commandname">extract  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>extract NbPlans
</pre></div>
</div>
<div class="line-block">
<div class="line">Extracts <strong>NbPlans</strong> planes of wavelet domain of the loaded image.</div>
<div class="line">See also WAVELET and WRECONS. For color extraction, see SPLIT</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#wavelet"><span class="std std-ref">wavelet</span></a>, <a class="reference internal" href="#wrecons"><span class="std std-ref">wrecons</span></a>, <a class="reference internal" href="#split"><span class="std std-ref">split</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="extract_Green"><span class="commandname">extract_Green  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>extract_Green
</pre></div>
</div>
<div class="line-block">
<div class="line">Extracts green signal from the loaded CFA image. It reads the Bayer matrix information from the image or the preferences and exports only the averaged green filter data as a new half-sized FITS file. A new file is created, its name is prefixed with &quot;Green_&quot;</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="extract_Ha"><span class="commandname">extract_Ha  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>extract_Ha [-upscale]
</pre></div>
</div>
<div class="line-block">
<div class="line">Extracts H-Alpha signal from the loaded CFA image. It reads the Bayer matrix information from the image or the preferences and exports only the red filter data as a new half-sized FITS file. If the argument <strong>-upscale</strong> is provided, the output will be upscaled x2 to match the full sensor resolution, for example to match other images produced by the same family of sensors. A new file is created, its name is prefixed with &quot;Ha_&quot;</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="extract_HaOIII"><span class="commandname">extract_HaOIII  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>extract_HaOIII [-resample=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Extracts H-Alpha and O-III signals from the loaded CFA image. It reads the Bayer matrix information from the image or the preferences and exports only the red filter data for H-Alpha as a new half-sized FITS file (like EXTRACTHA) and keeps the three others for O-III with an interpolated replacement for the red pixel. The output files names start with the prefix &quot;Ha_&quot; and &quot;OIII_&quot;</div>
<div class="line"><br /></div>
<div class="line">The optional argument <strong>-resample={ha|oiii}</strong> sets whether to upsample the Ha image or downsample the OIII image to have images the same size. If this argument is not provided, no resampling will be carried out and the OIII image will have twice the height and width of the Ha image</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="fdiv"><span class="commandname">fdiv  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fdiv filename scalar
</pre></div>
</div>
<div class="line-block">
<div class="line">Divides the loaded image by the image given in argument. The resulting image is multiplied by the value of the <strong>scalar</strong> argument. See also IDIV</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#idiv"><span class="std std-ref">idiv</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="ffill"><span class="commandname">ffill  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>ffill value [x y width height]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as FILL but this is a symmetric fill of a region defined by the mouse or with BOXSELECT. Used to process an image in the Fourier (FFT) domain</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#fill"><span class="std std-ref">fill</span></a>, <a class="reference internal" href="#boxselect"><span class="std std-ref">boxselect</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="fftd"><span class="commandname">fftd  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fftd modulus phase
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies a Fast Fourier Transform to the loaded image. <strong>modulus</strong> and <strong>phase</strong> given in argument are the names of the saved in FITS files</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="ffti"><span class="commandname">ffti  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>ffti modulus phase
</pre></div>
</div>
<div class="line-block">
<div class="line">Retrieves corrected image applying an inverse transformation. The <strong>modulus</strong> and <strong>phase</strong> arguments are the input file names, the result will be the new loaded image</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="fill"><span class="commandname">fill  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fill value [x y width height]
</pre></div>
</div>
<div class="line-block">
<div class="line">Fills the loaded image entirely or only the selection if there is one with pixels having the <strong>value</strong> intensity expressed in ADU</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="find_cosme"><span class="commandname">find_cosme  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>find_cosme cold_sigma hot_sigma
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies an automatic detection and replacement of cold and hot pixels in the loaded image, with the thresholds passed in arguments in sigma units</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="find_cosme_cfa"><span class="commandname">find_cosme_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>find_cosme_cfa cold_sigma hot_sigma
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as FIND_COSME but for CFA images</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#find_cosme"><span class="std std-ref">find_cosme</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="find_hot"><span class="commandname">find_hot  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>find_hot filename cold_sigma hot_sigma
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves a list file <strong>filename</strong> (text format) in the working directory which contains the coordinates of the pixels which have an intensity <strong>hot_sigma</strong> times higher and <strong>cold_sigma</strong> lower than standard deviation, extracted from the loaded image. We generally use this command on a master-dark file. The COSME command can apply this list of bad pixels to a loaded image, see also SEQCOSME to apply it to a sequence</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#cosme"><span class="std std-ref">cosme</span></a>, <a class="reference internal" href="#seqcosme"><span class="std std-ref">seqcosme</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
<div class="line">Lines <code class="docutils literal notranslate"><span class="pre">P</span> <span class="pre">x</span> <span class="pre">y</span> <span class="pre">type</span></code> will fix the pixel at coordinates (x, y) type is an optional character (C or H) specifying to Siril if the current pixel is cold or hot. This line is created by the command FIND_HOT but you also can add some lines manually:</div>
<div class="line">Lines <code class="docutils literal notranslate"><span class="pre">C</span> <span class="pre">x</span> <span class="pre">0</span> <span class="pre">type</span></code> will fix the bad column at coordinates x.</div>
<div class="line">Lines <code class="docutils literal notranslate"><span class="pre">L</span> <span class="pre">y</span> <span class="pre">0</span> <span class="pre">type</span></code> will fix the bad line at coordinates y.</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="findcompstars"><span class="commandname">findcompstars  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>findcompstars star_name [-narrow|-wide] [-catalog={nomad|apass}] [-dvmag=3] [-dbv=0.5] [-emag=0.03] [-out=nina_file.csv]
</pre></div>
</div>
<div class="line-block">
<div class="line">Automatically finds comparison stars in the field of the plate solved loaded image, for photometric analysis of a star's light curve according to</div>
<div class="line">- the provided name of the star</div>
<div class="line">- the field of view of the image, reduced to a diameter of its height if <strong>-narrow</strong> is passed, avoiding stars in the corners</div>
<div class="line">- the chosen catalog (APASS by default), can be changed with <strong>-catalog={NOMAD|APASS}</strong></div>
<div class="line">- the difference in visual magnitude from the variable star, in the range [0, 6] with a default of 3, changed with <strong>-dvmag=</strong></div>
<div class="line">- the difference in color with the variable star, in the range [0.0, 0.7] of their B-V indices with a default of 0.5, changed with <strong>-dbv=</strong></div>
<div class="line">- the maximum allowed error on Vmag in the range [0.0, 0.1] with a default of 0.03, changed with <strong>-emag=</strong>.</div>
<div class="line"><br /></div>
<div class="line">The list can optionally be saved as a CSV file compatible with the NINA comparison stars list, specifying the file name with <strong>-out=</strong>. If the provided name is the special value <strong>auto</strong>, it is generated using the input parameters</div>
<div class="line"><br /></div>
<div class="line">See also LIGHT_CURVE</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#light_curve"><span class="std std-ref">light_curve</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="findstar"><span class="commandname">findstar  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>findstar [-out=] [-layer=] [-maxstars=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Detects stars in the currently loaded image, having a level greater than a threshold computed by Siril.</div>
<div class="line">After that, a PSF is applied and Siril rejects all detected structures that don't fulfill a set of prescribed detection criteria, that can be tuned with command SETFINDSTAR.</div>
<div class="line">Finally, an ellipse is drawn around detected stars.</div>
<div class="line"><br /></div>
<div class="line">Optional parameter <strong>-out=</strong> allows the results to be saved to the given path.</div>
<div class="line">Option <strong>-layer=</strong> specifies the layer onto which the detection is performed (for color images only).</div>
<div class="line">You can also limit the maximum number of stars detected by passing a value to option <strong>-maxstars=</strong>.</div>
<div class="line"><br /></div>
<div class="line"><br /></div>
<div class="line">See also CLEARSTAR</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#setfindstar"><span class="std std-ref">setfindstar</span></a>, <a class="reference internal" href="#clearstar"><span class="std std-ref">clearstar</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="fix_xtrans"><span class="commandname">fix_xtrans  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fix_xtrans
</pre></div>
</div>
<div class="line-block">
<div class="line">Fixes the Fujifilm X-Trans Auto Focus pixels in the loaded image.</div>
<div class="line"><br /></div>
<div class="line">Indeed, because of the phase detection auto focus system, the photosites used for auto focus get a little less light than the surrounding photosites. The camera compensates for this and increases the values from these specific photosites giving a visible square in the middle of the dark/bias frames</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="fixbanding"><span class="commandname">fixbanding  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fixbanding amount sigma [-vertical]
</pre></div>
</div>
<div class="line-block">
<div class="line">Tries to remove the horizontal or vertical banding in the loaded image.</div>
<div class="line"><strong>amount</strong> defines the amount of correction, between 0 and 4.</div>
<div class="line"><strong>sigma</strong> defines the highlight protection level of the algorithm, higher sigma gives higher protection, between 0 and 5. Values of 1 and 1 are often good enough.</div>
<div class="line"><strong>-vertical</strong> option enables to perform vertical banding removal, horizontal is the default</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="fmedian"><span class="commandname">fmedian  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fmedian ksize modulation
</pre></div>
</div>
<div class="line-block">
<div class="line">Performs a median filter of size <strong>ksize</strong> x <strong>ksize</strong> (<strong>ksize</strong> MUST be odd) to the loaded image with a modulation parameter <strong>modulation</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output pixel is computed as : out=mod x m + (1 − mod) x in, where m is the median-filtered pixel value. A modulation's value of 1 will apply no modulation</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="fmul"><span class="commandname">fmul  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fmul scalar
</pre></div>
</div>
<div class="line-block">
<div class="line">Multiplies the loaded image by the <strong>scalar</strong> given in argument</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="gauss"><span class="commandname">gauss  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>gauss sigma
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies to the loaded image a Gaussian blur with the given <strong>sigma</strong>.</div>
<div class="line"><br /></div>
<div class="line">See also UNSHARP, the same with a blending parameter</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#unsharp"><span class="std std-ref">unsharp</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="get"><span class="commandname">get  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>get { -a | -A | variable }
</pre></div>
</div>
<div class="line-block">
<div class="line">Gets a value from the settings using its name, or list all with <strong>-a</strong> (name and value list) or with <strong>-A</strong> (detailed list)</div>
<div class="line"><br /></div>
<div class="line">See also SET to update values</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#set"><span class="std std-ref">set</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="getref"><span class="commandname">getref  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>getref sequencename
</pre></div>
</div>
<div class="line-block">
<div class="line">Prints information about the reference image of the sequence given in argument. First image has index 0</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="ght"><span class="commandname">ght  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>ght -D= [-B=] [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels]
</pre></div>
</div>
<div class="line-block">
<div class="line">Generalised hyperbolic stretch based on the work of the ghsastro.co.uk team.</div>
<div class="line"><br /></div>
<div class="line">The argument <strong>-D=</strong> defines the strength of the stretch, between 0 and 10. This is the only mandatory argument. The following optional arguments further tailor the stretch:</div>
<div class="line"><strong>B</strong> defines the intensity of the stretch near the focal point, between -5 and 15;</div>
<div class="line"><strong>LP</strong> defines a shadow preserving range between 0 and SP where the stretch will be linear, preserving shadow detail;</div>
<div class="line"><strong>SP</strong> defines the symmetry point of the stretch, between 0 and 1, which is the point at which the stretch will be most intense;</div>
<div class="line"><strong>HP</strong> defines a region between HP and 1 where the stretch is linear, preserving highlight details and preventing star bloat.</div>
<div class="line">If omitted B, LP and SP default to 0.0 ad HP defaults to 1.0.</div>
<div class="line">An optional argument (either <strong>-human</strong>, <strong>-even</strong> or <strong>-independent</strong>) can be passed to select either human-weighted or even-weighted luminance or independent colour channels for colour stretches. The argument is ignored for mono images. Alternatively, the argument <strong>-sat</strong> specifies that the stretch is performed on image saturation - the image must be color and all channels must be selected for this to work.</div>
<div class="line">Optionally the parameter <strong>[channels]</strong> may be used to specify the channels to apply the stretch to: this may be R, G, B, RG, RB or GB. The default is all channels. The clip mode can be set using the argument <strong>-clipmode=</strong>: values <strong>clip</strong>, <strong>rescale</strong>, <strong>rgbblend</strong> or <strong>globalrescale</strong> are accepted and the default is rgbblend</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="grey_flat"><span class="commandname">grey_flat  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>grey_flat
</pre></div>
</div>
<div class="line-block">
<div class="line">Equalizes the mean intensity of RGB layers in the loaded CFA image. This is the same process used on flats during calibration when the option equalize CFA is used</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="help"><span class="commandname">help  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>help [command]
</pre></div>
</div>
<div class="line-block">
<div class="line">Lists the available commands or help for one command</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="histo"><span class="commandname">histo  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>histo channel (channel=0, 1, 2 with 0: red, 1: green, 2: blue)
</pre></div>
</div>
<div class="line-block">
<div class="line">Calculates the histogram of the <strong>layer</strong> of the loaded image and produces file histo_[channel name].dat in the working directory.</div>
<div class="line">layer = 0, 1 or 2 with 0=red, 1=green and 2=blue</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="iadd"><span class="commandname">iadd  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>iadd filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Adds the image <strong>filename</strong> to the loaded image.</div>
<div class="line">Result will be in 32 bits per channel if allowed in the preferences</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="icc_assign"><span class="commandname">icc_assign  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>icc_assign profile
</pre></div>
</div>
<div class="line-block">
<div class="line">Assigns the ICC profile specified in the argument to the current image.</div>
<div class="line">One of the following special arguments may be provided to use the respective built-in profiles: <strong>sRGB</strong>, <strong>sRGBlinear</strong>, <strong>Rec2020</strong>, <strong>Rec2020linear</strong>, <strong>working</strong> to set the working mono or RGB color profile, (for mono images only) <strong>linear</strong>, or the path to an ICC profile file may be provided. If a built-in profile is specified with a monochrome image loaded, the Gray profile with the corresponding TRC will be used</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="icc_convert_to"><span class="commandname">icc_convert_to  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>icc_convert_to profile [intent]
</pre></div>
</div>
<div class="line-block">
<div class="line">Converts the current image to the specified ICC profile.</div>
<div class="line">One of the following special arguments may be provided to use the respective built-in profiles: <strong>sRGB</strong>, <strong>sRGBlinear</strong>, <strong>Rec2020</strong>, <strong>Rec2020linear</strong>, <strong>graysrgb</strong>, <strong>grayrec2020</strong>, <strong>graylinear</strong> or <strong>working</strong> to set the working mono or RGB color profile, (for mono images only) <strong>linear</strong>, or the path to an ICC profile file may be provided. If a built-in profile is specified with a monochrome image loaded, the Gray profile with the corresponding TRC will be used.</div>
<div class="line"><br /></div>
<div class="line">A second argument may be provided to specify the color transform intent: this should be one of <strong>perceptual</strong>, <strong>relative</strong> (for relative colorimetric), <strong>saturation</strong> or <strong>absolute</strong> (for absolute colorimetric)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="icc_remove"><span class="commandname">icc_remove  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>icc_remove
</pre></div>
</div>
<div class="line-block">
<div class="line">Removes the ICC profile from the current image, if it has one</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="idiv"><span class="commandname">idiv  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>idiv filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Divides the loaded image by the image <strong>filename</strong>.</div>
<div class="line">Result will be in 32 bits per channel if allowed in the preferences.</div>
<div class="line"><br /></div>
<div class="line">See also FDIV</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#fdiv"><span class="std std-ref">fdiv</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="imul"><span class="commandname">imul  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>imul filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Multiplies image <strong>filename</strong> by the loaded image.</div>
<div class="line">Result will be in 32 bits per channel if allowed in the preferences</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="inspector"><span class="commandname">inspector  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>inspector
</pre></div>
</div>
<div class="line-block">
<div class="line">Splits the loaded image in a nine-panel mosaic showing the image corners and the center for a closer inspection (GUI only)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="invght"><span class="commandname">invght  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>invght -D= [-B=] [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels]
</pre></div>
</div>
<div class="line-block">
<div class="line">Inverts a generalised hyperbolic stretch. It provides the inverse transformation of GHT, if provided with the same parameters, undoes a GHT command, possibly returning to a linear image. It can also work the same way as GHT but for images in negative</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#ght"><span class="std std-ref">ght</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="invmodasinh"><span class="commandname">invmodasinh  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>invmodasinh -D= [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels]
</pre></div>
</div>
<div class="line-block">
<div class="line">Inverts a modified arcsinh stretch. It provides the inverse transformation of MODASINH, if provided with the same parameters, undoes a MODASINH command, possibly returning to a linear image. It can also work the same way as MODASINH but for images in negative</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#modasinh"><span class="std std-ref">modasinh</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="invmtf"><span class="commandname">invmtf  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>invmtf low mid high [channels]
</pre></div>
</div>
<div class="line-block">
<div class="line">Inverts a midtones transfer function. It provides the inverse transformation of MTF, if provided with the same parameters, undoes a MTF command, possibly returning to a linear image. It can also work the same way as MTF but for images in negative</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#mtf"><span class="std std-ref">mtf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="isub"><span class="commandname">isub  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>isub filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Subtracts the loaded image by the image <strong>filename</strong>.</div>
<div class="line">Result will be in 32 bits per channel if allowed in the preferences, so capable of storing negative values. To clip negative value, use 16 bit mode or use the THRESHLO command</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#threshlo"><span class="std std-ref">threshlo</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="jsonmetadata"><span class="commandname">jsonmetadata  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>jsonmetadata FITS_file [-stats_from_loaded] [-nostats] [-out=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Dumps metadata and statistics of the currently loaded image in JSON form. The file name is required, even if the image is already loaded. Image data may not be read from the file if it is the current loaded image and if the <strong>-stats_from_loaded</strong> option is passed. Statistics can be disabled by providing the <strong>-nostats</strong> option. A file containing the JSON data is created with default file name '$(FITS_file_without_ext).json' and can be changed with the <strong>-out=</strong> option</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="light_curve"><span class="commandname">light_curve  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>light_curve sequencename channel [-autoring] { -at=x,y | -wcs=ra,dec } { -refat=x,y | -refwcs=ra,dec } ...
light_curve sequencename channel [-autoring] -ninastars=file
</pre></div>
</div>
<div class="line-block">
<div class="line">Analyses several stars with aperture photometry in a sequence of images and produces a light curve for one, calibrated by the others. The first coordinates, in pixels if <strong>-at=</strong> is used or in degrees if <strong>-wcs=</strong> is used, are for the star whose light will be plotted, the others for the comparison stars.</div>
<div class="line">Alternatively, a list of target and reference stars can be passed in the format of the NINA exoplanet plugin star list, with the <strong>-ninastars=</strong> option. Siril will verify that all reference stars can be used before actually using them. A data file is created in the current directory named light_curve.dat, Siril plots the result to a PNG image if available</div>
<div class="line">The ring radii for the annulus can either be configured in the settings or set to a factor of the reference image's FWHM if <strong>-autoring</strong> is passed. These autoring sizes are 4.2 time and 6.3 times the FWHM for the inner and outer radii, respectively.</div>
<div class="line"><br /></div>
<div class="line">See also the <strong>setphot</strong> command to set the same way the aperture radius size.</div>
<div class="line"><br /></div>
<div class="line">See also SEQPSF for operations on single star</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#seqpsf"><span class="std std-ref">seqpsf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="limit"><span class="commandname">limit  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>limit { -clip | -posrescale | -rescale }
</pre></div>
</div>
<div class="line-block">
<div class="line">Limits pixel values in 32-bit images to the range 0.0 to 1.0. This command does not apply to 16-bit images as there cannot be out-of-range values. Range limiting can be done in one of the following ways:</div>
<div class="line"><br /></div>
<div class="line"><strong>-clip</strong>: this option simply clips all negative pixels to 0.0 and all pixels with a value &gt; 1.0 to 1.0.</div>
<div class="line"><strong>-posrescale</strong>: this option scales all positive pixel values so that the maximum value is 1.0, clipping any negative pixels to 0.0. For 3-channel images the same scaling factor is applied to all channels. If the maximum pixel value is already &lt;= 1.0 negative pixels will still be clipped but no scaling factor will be applied to positive pixels.</div>
<div class="line"><strong>-rescale</strong>: using this option, if there are any negative pixel values the image will have a constant value added to all pixel values so that the minimum value is 0.0. Then if the maximum pixel value is &gt; 1.0, a scaling factor is applied so that the maximum pixel value is scaled to 1.0.</div>
<div class="line"><br /></div>
<div class="line">Note that if there are one or more extreme outliers (for example as a result of bad pixels) the <strong>-rescale</strong> and <strong>-posrescale</strong> options may produce an unexpected result. This can be mitigated by applying cosmetic correction to the image first</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="linear_match"><span class="commandname">linear_match  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>linear_match reference low high
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes and applies a linear function between a <strong>reference</strong> image and the loaded image.</div>
<div class="line"><br /></div>
<div class="line">The algorithm will ignore all reference pixels whose values are outside of the [<strong>low</strong>, <strong>high</strong>] range</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="link"><span class="commandname">link  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>link basename [-date] [-start=index] [-out=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same as CONVERT but converts only FITS files found in the current working directory. This is useful to avoid conversions of JPEG results or other files that may end up in the directory. The additional argument <strong>-date</strong> enables sorting files with their DATE-OBS value instead of with their name alphanumerically</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#convert"><span class="std std-ref">convert</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="linstretch"><span class="commandname">linstretch  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>linstretch -BP= [-sat] [-clipmode=] [channels] [-clipmode=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Stretches the image linearly to a new black point BP.</div>
<div class="line">The argument <strong>[channels]</strong> may optionally be used to specify the channels to apply the stretch to: this may be R, G, B, RG, RB or GB. The default is all channels.</div>
<div class="line">Optionally the parameter <strong>-sat</strong> may be used to apply the linear stretch to the image saturation channel. This argument only works if all channels are selected. The clip mode can be set using the argument <strong>-clipmode=</strong>: values <strong>clip</strong>, <strong>rescale</strong>, <strong>rgbblend</strong> or <strong>globalrescale</strong> are accepted and the default is rgbblend</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="livestack"><span class="commandname">livestack  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>livestack filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Process the provided image for live stacking. Only possible after START_LS. The process involves calibrating the incoming file if configured in START_LS, demosaicing if it's an OSC image, registering and stacking. The temporary result will be in the file live_stack_00001.fit until a new option to change it is added</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#start_ls"><span class="std std-ref">start_ls</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Note that the live stacking commands put Siril in a state in which it's not
able to process other commands. After START_LS, only LIVESTACK, STOP_LS and
EXIT can be called until STOP_LS is called to return Siril in its normal,
non-live-stacking, state.</p>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="load"><span class="commandname">load  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>load filename[.ext]
</pre></div>
</div>
<div class="line-block">
<div class="line">Loads the image <strong>filename</strong> from the current working directory, which becomes the 'currently loaded image' used in many of the single-image commands.</div>
<div class="line">It first attempts to load <strong>filename</strong>, then <strong>filename</strong>.fit, <strong>filename</strong>.fits and finally all supported formats.</div>
<div class="line">This scheme is applicable to every Siril command that involves reading files</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="load_seq"><span class="commandname">load_seq  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>load_seq sequencename[.ext]
</pre></div>
</div>
<div class="line-block">
<div class="line">Loads the sequence <strong>sequencename</strong> from the current working directory, which becomes the 'currently loaded sequence'. While Siril sequence commands require the sequence name to be specified, it is necessary to load a sequence in order to read its metadata using Python scripting</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="log"><span class="commandname">log  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>log
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes and applies a logarithmic scale to the loaded image, using the following formula: log(1 - (value - min) / (max - min)), with min and max being the minimum and maximum pixel value for the channel</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="ls"><span class="commandname">ls  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>ls
</pre></div>
</div>
<div class="line-block">
<div class="line">Lists files and directories in the working directory</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
<div class="line">This command is only available on Unix-like Systems, for the equivalent command on Microsoft Windows, see <a class="reference internal" href="#dir"><span class="std std-ref">dir</span></a>.</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="makepsf"><span class="commandname">makepsf  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>makepsf clear
makepsf load filename
makepsf save [filename]
makepsf blind [-l0] [-si] [-multiscale] [-lambda=] [-comp=] [-ks=] [-savepsf=]
makepsf stars [-sym] [-ks=] [-savepsf=]
makepsf manual { -gaussian | -moffat | -disc | -airy } [-fwhm=] [-angle=] [-ratio=] [-beta=] [-dia=] [-fl=] [-wl=] [-pixelsize=] [-obstruct=] [-ks=] [-savepsf=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Generates a PSF for use with deconvolution, any of the three methods exposed by RL, SB or WIENER commands. One of the following must be given as the first argument: <strong>clear</strong> (clears the existing PSF), <strong>load</strong> (loads a PSF from a file), <strong>save</strong> (saves the current PSF), <strong>blind</strong> (blind estimate of tke PSF), <strong>stars</strong> (generates a PSF based on measured stars from the image) or <strong>manual</strong> (generates a PSF manually based on a function and parameters).</div>
<div class="line"><br /></div>
<div class="line">No additional arguments are required when using the <strong>clear</strong> argument.</div>
<div class="line"><br /></div>
<div class="line">To load a previously saved PSF the <strong>load</strong> argument requires the PSF <em>filename</em> as a second argument. This may be in any format that Siril has been compiled with support for, but it must be square and should ideally be odd.</div>
<div class="line"><br /></div>
<div class="line">To save a previously generated PSF the argument <strong>save</strong> is used. Optionally, a filename may be provided (this must have one of the extensions &quot;.fit&quot;, &quot;.fits&quot;, &quot;.fts&quot; or &quot;.tif&quot;) but if none is provided the PSF will be named based on the name of the open file or sequence.</div>
<div class="line"><br /></div>
<div class="line">For <strong>blind</strong>, the following optional arguments may be provided: <strong>-l0</strong> uses the l0 descent method, <strong>-si</strong> uses the spectral irregularity method, <strong>-multiscale</strong> configures the l0 method to do a multi-scale PSF estimate, <strong>-lambda=</strong> provides the regularization constant.</div>
<div class="line"><br /></div>
<div class="line">For PSF from detected <strong>stars</strong> the only optional parameter is <strong>-sym</strong>, which configures the PSF to be symmetric.</div>
<div class="line"><br /></div>
<div class="line">For a <strong>manual</strong> PSF, one of <strong>-gaussian</strong>, <strong>-moffat</strong>, <strong>-disc</strong> or <strong>-airy</strong> can be provided to specify the PSF function, Gaussian by default. For Gaussian or Moffat PSFs the optional arguments <strong>-fwhm=</strong>, <strong>-angle=</strong> and <strong>-ratio=</strong> may be provided. For Moffat PSFs the optional argument <strong>-beta=</strong> may also be provided. If these values are omitted, they default to the same values as in the deconvolution dialog. For disc PSFs only the argument <strong>-fwhm=</strong> is required, which for this function is used to set the <em>diameter</em> of the PSF. For Airy PSFs the following arguments may be provided: <strong>-dia=</strong> (sets the telescope diameter), <strong>-fl=</strong> (sets the telescope focal length), <strong>-wl=</strong> (sets the wavelength to calculate the Airy diffraction pattern for), <strong>-pixelsize=</strong> (sets the sensor pixel size), <strong>-obstruct=</strong> (sets the central obstruction as a percentage of the overall aperture area). If these parameters are not provided, wavelength will default to 525nm and central obstruction will default to 0%. Siril will attempt to read the others from the open image, but some imaging software may not provide all of them in which case you will get bad results, and note the metadata may not be populated for SER format videos. You will learn from experience which are safe to omit for your particular imaging setup.</div>
<div class="line"><br /></div>
<div class="line">For any of the above PSF generation options the optional argument <strong>-ks=</strong> may be provided to set the PSF dimension, and the optional argument <strong>-savepsf=filename</strong> may be used to save the generated PSF: a filename must be provided and the same filename extension requirements apply as for <strong>makepsf save filename</strong></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#rl"><span class="std std-ref">rl</span></a>, <a class="reference internal" href="#sb"><span class="std std-ref">sb</span></a>, <a class="reference internal" href="#wiener"><span class="std std-ref">wiener</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="merge"><span class="commandname">merge  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>merge sequence1 sequence2 [sequence3 ...] output_sequence
</pre></div>
</div>
<div class="line-block">
<div class="line">Merges several sequences of the same type (FITS images, FITS sequence or SER) and same image properties into a new sequence with base name <strong>newseq</strong> created in the current working directory, with the same type. The input sequences can be in different directories, can specified either in absolute or relative path, with the exact .seq name or with only the base name with or without the trailing '_'</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="merge_cfa"><span class="commandname">merge_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>merge_cfa file_CFA0 file_CFA1 file_CFA2 file_CFA3 bayerpattern
</pre></div>
</div>
<div class="line-block">
<div class="line">Builds a Bayer masked color image from 4 separate images containing the data from Bayer subchannels CFA0, CFA1, CFA2 and CFA3. (The corresponding command to split the CFA pattern into subchannels is <strong>split_cfa</strong>.) This function can be used as part of a workflow applying some processing to the individual Bayer subchannels prior to demosaicing. The fifth parameter <strong>bayerpattern</strong> specifies the Bayer matrix pattern to recreate: <strong>bayerpattern</strong> should be one of 'RGGB', 'BGGR', 'GRBG' or 'GBRG'</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="mirrorx"><span class="commandname">mirrorx  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>mirrorx [-bottomup]
</pre></div>
</div>
<div class="line-block">
<div class="line">Flips the loaded image about the horizontal axis. Option <strong>-bottomup</strong> will only flip it if it's not already bottom-up</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="mirrorx_single"><span class="commandname">mirrorx_single  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>mirrorx_single image
</pre></div>
</div>
<div class="line-block">
<div class="line">Flips the image about the horizontal axis, only if needed (if it's not already bottom-up). It takes the image file name as argument, allowing it to avoid reading image data entirely if no flip is required. Image is overwritten if a flip is made</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="mirrory"><span class="commandname">mirrory  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>mirrory
</pre></div>
</div>
<div class="line-block">
<div class="line">Flips the image about the vertical axis</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="modasinh"><span class="commandname">modasinh  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>modasinh -D= [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels]
</pre></div>
</div>
<div class="line-block">
<div class="line">Modified arcsinh stretch based on the work of the ghsastro.co.uk team.</div>
<div class="line"><br /></div>
<div class="line">The argument <strong>-D=</strong> defines the strength of the stretch, between 0 and 10. This is the only mandatory argument. The following optional arguments further tailor the stretch:</div>
<div class="line"><strong>LP</strong> defines a shadow preserving range between 0 and SP where the stretch will be linear, preserving shadow detail;</div>
<div class="line"><strong>SP</strong> defines the symmetry point of the stretch, between 0 and 1, which is the point at which the stretch will be most intense;</div>
<div class="line"><strong>HP</strong> defines a region between HP and 1 where the stretch is linear, preserving highlight details and preventing star bloat.</div>
<div class="line">If omitted LP and SP default to 0.0 ad HP defaults to 1.0.</div>
<div class="line">An optional argument (either <strong>-human</strong>, <strong>-even</strong> or <strong>-independent</strong>) can be passed to select either human-weighted or even-weighted luminance or independent colour channels for colour stretches. The argument is ignored for mono images. Alternatively, the argument <strong>-sat</strong> specifies that the stretch is performed on image saturation - the image must be color and all channels must be selected for this to work.</div>
<div class="line">Optionally the parameter <strong>[channels]</strong> may be used to specify the channels to apply the stretch to: this may be R, G, B, RG, RB or GB. The default is all channels. The clip mode can be set using the argument <strong>-clipmode=</strong>: values <strong>clip</strong>, <strong>rescale</strong>, <strong>rgbblend</strong> or <strong>globalrescale</strong> are accepted and the default is rgbblend</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="mtf"><span class="commandname">mtf  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>mtf low mid high [channels]
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies midtones transfer function to the current loaded image.</div>
<div class="line"><br /></div>
<div class="line">Three parameters are needed, <strong>low</strong>, <strong>midtones</strong> and <strong>high</strong> where midtones balance parameter defines a nonlinear histogram stretch in the [0,1] range. For an automatic determination of the parameters, see AUTOSTRETCH.</div>
<div class="line">Optionally the parameter <strong>[channels]</strong> may be used to specify the channels to apply the stretch to: this may be R, G, B, RG, RB or GB. The default is all channels</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#autostretch"><span class="std std-ref">autostretch</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="neg"><span class="commandname">neg  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>neg
</pre></div>
</div>
<div class="line-block">
<div class="line">Changes pixel values of the currently loaded image to a negative view, like 1-value for 32 bits, 65535-value for 16 bits. This does not change the display mode</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="new"><span class="commandname">new  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>new width height nb_channel [filename]
</pre></div>
</div>
<div class="line-block">
<div class="line">Creates a new image filled with zeros with a size of <strong>width</strong> x <strong>height</strong>.</div>
<div class="line">Optionally the parameter <strong>[filename]</strong> may be used to specify the name of the new file.</div>
<div class="line"><br /></div>
<div class="line">The image is in 32-bit format, and it contains <strong>nb_channel</strong> channels, <strong>nb_channel</strong> being 1 or 3. It is not saved, but becomes the loaded image and it is displayed and can be saved afterwards</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="nozero"><span class="commandname">nozero  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>nozero level
</pre></div>
</div>
<div class="line-block">
<div class="line">Replaces null values by <strong>level</strong> values. Useful before an idiv or fdiv operation, mostly for 16-bit images</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="offline"><span class="commandname">offline  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>offline
</pre></div>
</div>
<div class="line-block">
<div class="line">Sets Siril to offline mode. In this mode networking functions such as remote catalogue lookups, update of git repositories etc. are unavailable. Cached data is still accessible</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="offset"><span class="commandname">offset  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>offset value
</pre></div>
</div>
<div class="line-block">
<div class="line">Adds the constant <strong>value</strong> (specified in ADU) to the current image. This constant can take a negative value.</div>
<div class="line"><br /></div>
<div class="line">In 16-bit mode, values of pixels that fall outside of [0, 65535] are clipped. In 32-bit mode, no clipping occurs</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="online"><span class="commandname">online  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>online
</pre></div>
</div>
<div class="line-block">
<div class="line">Sets Siril to online mode. In this mode networking functions such as remote catalogue lookups, update of git repositories etc. is allowed</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="parse"><span class="commandname">parse  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>parse str [-r]
</pre></div>
</div>
<div class="line-block">
<div class="line">Parses the string <strong>str</strong> using the information contained in the header of the image currently loaded. Main purpose of this command is to debug path parsing of header keys which can be used in other commands.</div>
<div class="line">Option <strong>-r</strong> specifies the string is to be interpreted in read mode. In read mode, all wildcards defined in string <strong>str</strong> are used to find a file name matching the pattern. Otherwise, default mode is write mode and wildcards, if any, are removed from the string to be parsed.</div>
<div class="line"><br /></div>
<div class="line">If <strong>str</strong> starts with <em>$def</em> prefix, it will be recognized as a reserved keyword and looked for in the strings stored in gui_prepro.dark_lib, gui_prepro.flat_lib, gui_prepro.bias_lib or gui_prepro.stack_default for <em>$defdark</em>, <em>$defflat</em>, <em>$defbias</em> or <em>$defstack</em> respectively.</div>
<div class="line">The keyword <em>$seqname$</em> can also be used when a sequence is loaded</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="pcc"><span class="commandname">pcc  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>pcc [-limitmag=[+-]] [-catalog=] [-bgtol=lower,upper]
</pre></div>
</div>
<div class="line-block">
<div class="line">Run the Photometric Color Correction on the loaded plate-solved image.</div>
<div class="line"><br /></div>
<div class="line">The limit magnitude of stars is automatically computed from the size of the field of view, but can be altered by passing a +offset or -offset value to <strong>-limitmag=</strong>, or simply an absolute positive value for the limit magnitude.</div>
<div class="line">The star catalog used is NOMAD by default, it can be changed by providing <strong>-catalog=apass</strong>, <strong>-catalog=localgaia</strong> or <strong>-catalog=gaia</strong>. If installed locally, the remote NOMAD (the complete version) can be forced by providing <strong>-catalog=nomad</strong></div>
<div class="line">Background reference outlier tolerance can be specified in sigma units using <strong>-bgtol=lower,upper</strong>: these default to -2.8 and +2.0</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="platesolve"><span class="commandname">platesolve  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>platesolve [-force] [image_center_coords] [-focal=] [-pixelsize=]
platesolve ... [-noflip] [-downscale] [-order=] [-radius=] [-disto=]
platesolve ... [-limitmag=[+-]] [-catalog=] [-nocrop]
platesolve ... [-localasnet [-blindpos] [-blindres]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Plate solve the loaded image.</div>
<div class="line">If the image has already been plate solved nothing will be done, unless the <strong>-force</strong> argument is passed to force a new solve. If WCS or other image metadata is erroneous or missing, arguments must be passed:</div>
<div class="line">the approximate image center coordinates can be provided in decimal degrees or degree/hour minute second values (J2000 with colon separators), with right ascension and declination values separated by a comma or a space (not mandatory for astrometry.net).</div>
<div class="line">focal length and pixel size can be passed with <strong>-focal=</strong> (in mm) and <strong>-pixelsize=</strong> (in microns), overriding values from image and settings. See also options to solve blindly with local Astrometry.net</div>
<div class="line"><br /></div>
<div class="line">Unless <strong>-noflip</strong> is specified, if the image is detected as being upside-down, it will be flipped.</div>
<div class="line">For faster star detection in big images, downsampling the image is possible with <strong>-downscale</strong>.</div>
<div class="line">The solve can account for distortions using SIP convention with polynomials up to order 5. Default value is taken form the astrometry preferences. This can be changed with the option <strong>-order=</strong> giving a value between 1 and 5.</div>
<div class="line">When using Siril solver local catalogues or with local Astrometry.net, if the initial solve is not successful, the solver will search for a solution within a cone of radius specified with <strong>-radius=</strong> option. If no value is passed, the search radius is taken from the astrometry preferences. Siril near search can be disabled by passing a value of 0. (cannot be disabled for Astrometry.net).</div>
<div class="line">You can save the current solution as a distortion file with the option <strong>-disto=</strong>.</div>
<div class="line"><br /></div>
<div class="line">Images can be either plate solved by Siril using a star catalog and the global registration algorithm or by astrometry.net's local solve-field command (enabled with <strong>-localasnet</strong>).</div>
<div class="line"><br /></div>
<div class="line"><strong>Siril platesolver options:</strong></div>
<div class="line">The limit magnitude of stars used for plate solving is automatically computed from the size of the field of view, but can be altered by passing a +offset or -offset value to <strong>-limitmag=</strong>, or simply an absolute positive value for the limit magnitude.</div>
<div class="line">The choice of the star catalog is automatic unless the <strong>-catalog=</strong> option is passed: if local catalogs are installed, they are used, otherwise the choice is based on the field of view and limit magnitude. If the option is passed, it forces the use of the catalog given in argument, with possible values: tycho2, nomad, localgaia, gaia, ppmxl, brightstars, apass.</div>
<div class="line">If the computed field of view is larger than 5 degrees, star detection will be bounded to a cropped area around the center of the image unless <strong>-nocrop</strong> option is passed.</div>
<div class="line"><br /></div>
<div class="line"><strong>Astrometry.net solver options:</strong></div>
<div class="line">Passing options <strong>-blindpos</strong> and/or <strong>-blindres</strong> enables to solve blindly for position and for resolution respectively. You can use these when solving an image with a completely unknown location and sampling</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="pm"><span class="commandname">pm  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>pm &quot;expression&quot; [-rescale [low] [high]] [-nosum]
</pre></div>
</div>
<div class="line-block">
<div class="line">This command evaluates the expression given in argument as in PixelMath tool. The full expression must be between double quotes and variables (that are image names, without extension, located in the working directory in that case) must be surrounded by the token $, e.g. &quot;$image1$ * 0.5 + $image2$ * 0.5&quot;. A maximum of 10 images can be used in the expression.</div>
<div class="line">Image can be rescaled with the option <strong>-rescale</strong> followed by <strong>low</strong> and <strong>high</strong> values in the range [0, 1]. If no low and high values are provided, default values are set to 0 and 1. Another optional argument, <strong>-nosum</strong> tells Siril not to sum exposure times. This impacts FITS keywords such as LIVETIME and STACKCNT</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="profile"><span class="commandname">profile  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>profile -from=x,y -to=x,y [-tri] [-cfa] [-arcsec] { [-savedat] | [-filename=] } [-layer=] [-width=] [-spacing=] [&quot;-title=My Plot&quot;]
</pre></div>
</div>
<div class="line-block">
<div class="line">Generates an intensity profile plot between 2 points in the image, also known as a <em>cut</em>. The arguments may be provided in any order. The arguments <strong>-to=x,y</strong> and <strong>-from=x,y</strong> are mandatory.</div>
<div class="line"><br /></div>
<div class="line">The argument <strong>-layer={red | green | blue | lum | col}</strong> specifies which channel (or luminance or colour) to plot if the image is color. It may also be used with the <strong>-tri</strong> option, which generates 3 parallel equispaced profiles each separated by <strong>-spacing=</strong> pixels, but note that for tri profiles the <strong>col</strong> option will be treated the same as <strong>lum</strong>.</div>
<div class="line"><br /></div>
<div class="line">The option <strong>-cfa</strong> selects CFA mode, which generates 4 profiles: 1 for each CFA channel in a Bayer patterned image. This option cannot be used with color images or mono images with no Bayer pattern, and cannot be used at the same time as the <strong>-tri</strong> option.</div>
<div class="line"><br /></div>
<div class="line">The option <strong>-arcsec</strong> causes the x axis to display distance in arcsec, if the necessary metadata is available. If not provided or if metadata is not available, distance will be shown in pixel units.</div>
<div class="line"><br /></div>
<div class="line">The argument <strong>-savedat</strong> will cause the data files to be saved: the filename will be written to the log. Alternatively the argument <strong>-filename=</strong> can be used to specify a filename to write the data file to. (The <strong>-filename=</strong> option implies <strong>-savedat</strong>.)</div>
<div class="line"><br /></div>
<div class="line">The argument <strong>&quot;-title=My Title&quot;</strong> sets a custom title &quot;My Title&quot;</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="psf"><span class="commandname">psf  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>psf [channel]
</pre></div>
</div>
<div class="line-block">
<div class="line">Performs a PSF (Point Spread Function) on the selected star and display the results. For headless operation, the selection can be given in pixels using BOXSELECT. If provided, the <strong>channel</strong> argument selects the image channel on which the star will be analyzed. It can be omitted for monochrome images or when run from the GUI with one of the channels active in the view</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#boxselect"><span class="std std-ref">boxselect</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="pwd"><span class="commandname">pwd  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>pwd
</pre></div>
</div>
<div class="line-block">
<div class="line">Prints the current working directory</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="pyscript"><span class="commandname">pyscript  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>pyscript scriptname.py [script_argv]
</pre></div>
</div>
<div class="line-block">
<div class="line">Executes a Siril python script</div>
<div class="line"><br /></div>
<div class="line">The script name must be provided as the first argument. If it is not found in the current working directory, the user-defined script paths specified in Preferences and the local siril-scripts repository will be searched. All subsequent arguments will be treated as script arguments and passed to the script as its argument vector. Note that the specific script must incorporate support for reading input from the argument vector</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="register"><span class="commandname">register  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>register sequencename [-2pass] [-selected] [-prefix=] [-scale=]
register sequencename ... [-layer=] [-transf=] [-minpairs=] [-maxstars=] [-nostarlist] [-disto=]
register sequencename ... [-interp=] [-noclamp]
register sequencename ... [-drizzle [-pixfrac=] [-kernel=] [-flat=]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Finds and optionally performs geometric transforms on images of the sequence given in argument so that they may be superimposed on the reference image. Using stars for registration, this algorithm only works with deep sky images. Star detection options can be changed using <strong>SETFINDSTAR</strong> or the <em>Dynamic PSF</em> dialog.</div>
<div class="line"><br /></div>
<div class="line">All images of the sequence will be registered unless the option <strong>-selected</strong> is passed, in that case the excluded images will not be processed.</div>
<div class="line">The <strong>-2pass</strong> option will only compute the transforms but not generate the transformed images, <strong>-2pass</strong> adds a preliminary pass to the algorithm to find a good reference image before computing the transforms, based on image quality and framing. To generate transformed images after this pass, use SEQAPPLYREG.</div>
<div class="line">If created, the output sequence name will start with the prefix &quot;r_&quot; unless otherwise specified with <strong>-prefix=</strong> option. The output images can be rescaled by passing a <strong>-scale=</strong> argument with a float value between 0.1 and 3.</div>
<div class="line"><br /></div>
<div class="line"><strong>Image transformation options:</strong></div>
<div class="line"><br /></div>
<div class="line">The detection is done on the green layer for colour images, unless specified by the <strong>-layer=</strong> option with an argument ranging from 0 to 2 for red to blue.</div>
<div class="line"><strong>-transf=</strong> specifies the use of either <strong>shift</strong>, <strong>similarity</strong>, <strong>affine</strong> or <strong>homography</strong> (default) transformations respectively.</div>
<div class="line"><strong>-minpairs=</strong> will specify the minimum number of star pairs a frame must have with the reference frame, otherwise the frame will be dropped and excluded from the sequence.</div>
<div class="line"><strong>-maxstars=</strong> will specify the maximum number of stars to find within each frame (must be between 100 and 2000). With more stars, a more accurate registration can be computed, but will take more time to run.</div>
<div class="line"><strong>-nostarlist</strong> disables saving the star lists to disk.</div>
<div class="line"><strong>-disto=</strong> uses distortion terms from a previous platesolve solution (with a SIP order &gt; 1). It takes as parameter either <strong>image</strong> to use the solution contained in the currently loaded image, <strong>file</strong> followed by the path to the image containing the solution or <strong>master</strong> to load automatically the matching distortion master corresponding to each image. When using this option, the polynomials are used both to correct star positions before computing the transformation and to undistort the images when output images are exported.</div>
<div class="line"><br /></div>
<div class="line"><strong>Image interpolation options:</strong></div>
<div class="line"><br /></div>
<div class="line">By default, transformations are applied to register the images by using interpolation.</div>
<div class="line">The pixel interpolation method can be specified with the <strong>-interp=</strong> argument followed by one of the methods in the list <strong>no</strong>[ne], <strong>ne</strong>[arest], <strong>cu</strong>[bic], <strong>la</strong>[nczos4], <strong>li</strong>[near], <strong>ar</strong>[ea]}. If <strong>none</strong> is passed, the transformation is forced to shift and a pixel-wise shift is applied to each image without any interpolation.</div>
<div class="line">Clamping of the bicubic and lanczos4 interpolation methods is the default, to avoid artefacts, but can be disabled with the <strong>-noclamp</strong> argument.</div>
<div class="line"><br /></div>
<div class="line"><strong>Image drizzle options:</strong></div>
<div class="line"><br /></div>
<div class="line">Otherwise, the images can be exported using HST drizzle algorithm by passing the argument <strong>-drizzle</strong> which can take the additional options:</div>
<div class="line"><strong>-pixfrac=</strong> sets the pixel fraction (default = 1.0).</div>
<div class="line">The <strong>-kernel=</strong> argument sets the drizzle kernel and must be followed by one of <strong>point</strong>, <strong>turbo</strong>, <strong>square</strong>, <strong>gaussian</strong>, <strong>lanczos2</strong> or <strong>lanczos3</strong>. The default is <strong>square</strong>.</div>
<div class="line">The <strong>-flat=</strong> argument specifies a master flat to weight the drizzled input pixels (default is no flat).</div>
<div class="line"><br /></div>
<div class="line">Note: when using <strong>-drizzle</strong> on images taken with a color camera, the input images must not be debayered. In that case, star detection will always occur on the green pixels</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#setfindstar"><span class="std std-ref">setfindstar</span></a>, <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#seqapplyreg"><span class="std std-ref">seqapplyreg</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="reloadscripts"><span class="commandname">reloadscripts  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>reloadscripts
</pre></div>
</div>
<div class="line-block">
<div class="line">Rescans the scripts folders and updates the Scripts menu. Note that this command may not be used headless (i.e. from siril-cli) and also that the update will happen asynchronously (i.e. the command will trigger the update but will not wait for the update to complete)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="requires"><span class="commandname">requires  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>requires min_version [obsolete_version]
</pre></div>
</div>
<div class="line-block">
<div class="line">Returns an error if the version of Siril is older than the minimum required version passed in the first argument. Optionally, takes a second argument for the Siril version at which the script is obsolete: returns an error if the version of Siril is <strong>newer than or equal to</strong> the one passed in the second argument.</div>
<div class="line"><br /></div>
<div class="line">Example: <em>requires 1.2.0 1.4.0</em> allows the script to run for all of the 1.2.x series and 1.3.x series, but will not run for any versions earlier than 1.2.0 or for version 1.4.0 or any later versions</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="resample"><span class="commandname">resample  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>resample { factor | -width= | -height= | -maxdim= } [-interp=] [-noclamp]
</pre></div>
</div>
<div class="line-block">
<div class="line">Resamples the loaded image, either with a factor <strong>factor</strong> or for the target width or height provided by either of <strong>-width=</strong>, <strong>-height=</strong> or <strong>-maxdim=</strong>. This is generally used to resize images: a factor of 0.5 divides size by 2. The <strong>-maxdim</strong> argument can be used to resize the longest dimension of the image to a set size, which can be useful for optimizing images for certain websites, e.g. social media websites.</div>
<div class="line">In the graphical user interface, we can see that several interpolation algorithms are proposed.</div>
<div class="line"><br /></div>
<div class="line">The pixel interpolation method can be specified with the <strong>-interp=</strong> argument followed by one of the methods in the list <strong>no</strong>[ne], <strong>ne</strong>[arest], <strong>cu</strong>[bic], <strong>la</strong>[nczos4], <strong>li</strong>[near], <strong>ar</strong>[ea]}.</div>
<div class="line">Clamping of the bicubic and lanczos4 interpolation methods is the default, to avoid artefacts, but can be disabled with the <strong>-noclamp</strong> argument</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="rgbcomp"><span class="commandname">rgbcomp  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>rgbcomp red green blue [-out=result_filename] [-nosum]
rgbcomp -lum=image { rgb_image | red green blue } [-out=result_filename] [-nosum]
</pre></div>
</div>
<div class="line-block">
<div class="line">Creates an RGB composition using three independent images, or an LRGB composition using the optional luminance image and three monochrome images or a color image. Result image is called composed_rgb.fit or composed_lrgb.fit unless another name is provided in the optional argument. Another optional argument, <strong>-nosum</strong> tells Siril not to sum exposure times. This impacts FITS keywords such as LIVETIME and STACKCNT</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="rgradient"><span class="commandname">rgradient  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>rgradient xc yc dR dalpha
</pre></div>
</div>
<div class="line-block">
<div class="line">Creates two images, with a radial shift (<strong>dR</strong> in pixels) and a rotational shift (<strong>dalpha</strong> in degrees) with respect to the point (<strong>xc</strong>, <strong>yc</strong>).</div>
<div class="line"><br /></div>
<div class="line">Between these two images, the shifts have the same amplitude, but an opposite sign. The two images are then added to create the final image. This process is also called Larson Sekanina filter</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="rl"><span class="commandname">rl  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>rl [-loadpsf=] [-alpha=] [-iters=] [-stop=] [-gdstep=] [-tv] [-fh] [-mul]
</pre></div>
</div>
<div class="line-block">
<div class="line">Restores an image using the Richardson-Lucy method.</div>
<div class="line"><br /></div>
<div class="line">Optionally, a PSF may be loaded using the argument <strong>-loadpsf=filename</strong> (created with MAKEPSF).</div>
<div class="line"><br /></div>
<div class="line">The number of iterations is provide by <strong>-iters</strong> (the default is 10).</div>
<div class="line"><br /></div>
<div class="line">The type of regularization can be set with <strong>-tv</strong> for Total Variation, or <strong>-fh</strong> for the Frobenius norm of the Hessian matrix (the default is none) and <strong>-alpha=</strong> provides the regularization strength (lower value = more regularization, default = 3000).</div>
<div class="line"><br /></div>
<div class="line">By default the gradient descent method is used with a default step size of 0.0005, however the multiplicative method may be specified with <strong>-mul</strong>.</div>
<div class="line"><br /></div>
<div class="line">The stopping criterion may be activated by specifying a stopping limit with <strong>-stop=</strong></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#makepsf"><span class="std std-ref">makepsf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="rmgreen"><span class="commandname">rmgreen  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>rmgreen [-nopreserve] [type] [amount]
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies a chromatic noise reduction filter. It removes green tint in the current image. This filter is based on PixInsight's SCNR and it is also the same filter used by HLVG plugin in Photoshop.</div>
<div class="line">Lightness is preserved by default but this can be disabled with the <strong>-nopreserve</strong> switch.</div>
<div class="line"><br /></div>
<div class="line"><strong>Type</strong> can take values 0 for average neutral, 1 for maximum neutral, 2 for maximum mask, 3 for additive mask, defaulting to 0. The last two can take an <strong>amount</strong> argument, a value between 0 and 1, defaulting to 1</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="rotate"><span class="commandname">rotate  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>rotate degree [-nocrop] [-interp=] [-noclamp]
</pre></div>
</div>
<div class="line-block">
<div class="line">Rotates the loaded image by an angle of <strong>degree</strong> value. The option <strong>-nocrop</strong> can be added to avoid cropping to the image size (black borders will be added).</div>
<div class="line"><br /></div>
<div class="line">Note: if a selection is active, i.e. by using a command `boxselect` before `rotate`, the resulting image will be a rotated crop. In this particular case, the option <strong>-nocrop</strong> will be ignored if passed.</div>
<div class="line"><br /></div>
<div class="line">The pixel interpolation method can be specified with the <strong>-interp=</strong> argument followed by one of the methods in the list <strong>no</strong>[ne], <strong>ne</strong>[arest], <strong>cu</strong>[bic], <strong>la</strong>[nczos4], <strong>li</strong>[near], <strong>ar</strong>[ea]}. If <strong>none</strong> is passed, the transformation is forced to shift and a pixel-wise shift is applied to each image without any interpolation.</div>
<div class="line">Clamping of the bicubic and lanczos4 interpolation methods is the default, to avoid artefacts, but can be disabled with the <strong>-noclamp</strong> argument</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="rotatePi"><span class="commandname">rotatePi  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>rotatePi
</pre></div>
</div>
<div class="line-block">
<div class="line">Rotates the loaded image of an angle of 180° around its center. This is equivalent to the command &quot;ROTATE 180&quot; or &quot;ROTATE -180&quot;</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#rotate"><span class="std std-ref">rotate</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="satu"><span class="commandname">satu  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>satu amount [background_factor [hue_range_index]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Enhances the color saturation of the loaded image. Try iteratively to obtain best results.</div>
<div class="line"><strong>amount</strong> can be a positive number to increase color saturation, negative to decrease it, 0 would do nothing, 1 would increase it by 100%</div>
<div class="line"><strong>background_factor</strong> is a factor to (median + sigma) used to set a threshold for which only pixels above it would be modified. This allows background noise to not be color saturated, if chosen carefully. Defaults to 1. Setting 0 disables the threshold.</div>
<div class="line"><strong>hue_range_index</strong> can be [0, 6], meaning: 0 for pink to orange, 1 for orange to yellow, 2 for yellow to cyan, 3 for cyan, 4 for cyan to magenta, 5 for magenta to pink, 6 for all (default)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="save"><span class="commandname">save  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>save filename [-chksum]
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves current image to <strong>filename</strong>.fit (or .fits, depending on your preferences, see SETEXT) in the current working directory. The image remains loaded. <strong>filename</strong> can contain a path as long as the directory already exists. The <strong>-chksum</strong> option stores checksum keywords (CHECKSUM and DATASUM) in the FITS header</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#setext"><span class="std std-ref">setext</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savebmp"><span class="commandname">savebmp  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savebmp filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves current image under the form of a bitmap file with 8-bit per channel: <strong>filename</strong>.bmp (BMP 24-bit)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savejpg"><span class="commandname">savejpg  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savejpg filename [quality]
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves current image into a JPG file: <strong>filename</strong>.jpg.</div>
<div class="line"><br /></div>
<div class="line">The compression quality can be adjusted using the optional <strong>quality</strong> value, 100 being the best and default, while a lower value increases the compression ratio</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savejxl"><span class="commandname">savejxl  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savejxl filename [-effort=] [-quality=] [-8bit]
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves current image into a JPG XL file: <strong>filename</strong>.jxl.</div>
<div class="line"><br /></div>
<div class="line">All other arguments are optional. The quality setting expresses a maximum permissible distance between the original and the compressed image: the <strong>-quality=</strong> argument may be provided and must be specified as a floating point number between 0.0 and 10.0. A higher quality means better quality, but larger file size. Quality = 10.0 is mathematically lossless, quality = 9.0 is visually lossless and quality = 0 is visually poor but gives very small file sizes. The default value is 9.0; typical values range from 7.0 to 10.0. The compression effort can be adjusted using the optional <strong>-effort=</strong> value, 9 being the most effort but very slow, while a lower value increases the compression ratio. Values above 7 are not recommended as they can be very slow and produce little if any benefit to file size, in fact sometimes effort = 9 can produce larger files. If this argument is omitted the default value of 7 is used. An option <strong>-8bit</strong> may be provided to force output to be 8 bits per pixel</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savepng"><span class="commandname">savepng  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savepng filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves current image into a PNG file: <strong>filename</strong>.png, with 16 bits per channel if the loaded image is 16 or 32 bits, and 8 bits per channel if the loaded image is 8 bits</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savepnm"><span class="commandname">savepnm  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savepnm filename
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves current image under the form of a NetPBM file format with 16-bit per channel.</div>
<div class="line"><br /></div>
<div class="line">The extension of the output will be <strong>filename</strong>.ppm for RGB image and <strong>filename</strong>.pgm for gray-level image</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savetif"><span class="commandname">savetif  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savetif filename [-astro] [-deflate]
</pre></div>
</div>
<div class="line-block">
<div class="line">Saves current image under the form of a uncompressed TIFF file with 16-bit per channel: <strong>filename</strong>.tif. The option <strong>-astro</strong> allows saving in Astro-TIFF format, while <strong>-deflate</strong> enables compression.</div>
<div class="line"><br /></div>
<div class="line">See also SAVETIF32 and SAVETIF8</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savetif32"><span class="commandname">savetif32  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savetif32 filename [-astro] [-deflate]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as SAVETIF but the output file is saved in 32-bit per channel: <strong>filename</strong>.tif. The option <strong>-astro</strong> allows saving in Astro-TIFF format, while <strong>-deflate</strong> enables compression</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#savetif"><span class="std std-ref">savetif</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="savetif8"><span class="commandname">savetif8  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>savetif8 filename [-astro] [-deflate]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as SAVETIF but the output file is saved in 8-bit per channel: <strong>filename</strong>.tif. The option <strong>-astro</strong> allows saving in Astro-TIFF format, while <strong>-deflate</strong> enables compression</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#savetif"><span class="std std-ref">savetif</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="sb"><span class="commandname">sb  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>sb [-loadpsf=] [-alpha=] [-iters=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Restores an image using the Split Bregman method.</div>
<div class="line"><br /></div>
<div class="line">Optionally, a PSF may be loaded using the argument <strong>-loadpsf=filename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The number of iterations is provide by <strong>-iters</strong> (the default is 1).</div>
<div class="line"><br /></div>
<div class="line">The regularization factor <strong>-alpha=</strong> provides the regularization strength (lower value = more regularization, default = 3000)</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="select"><span class="commandname">select  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>select sequencename from to
</pre></div>
</div>
<div class="line-block">
<div class="line">This command allows easy mass selection of images in the sequence <strong>sequencename</strong> (from <strong>from</strong> to <strong>to</strong> included). This is a selection for later processing.</div>
<div class="line">See also UNSELECT</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#unselect"><span class="std std-ref">unselect</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
<div class="line">Examples:</div>
<div class="line"><br /></div>
<div class="line"><cite>select . 0 0</cite></div>
<div class="line">selects the first of the currently loaded sequence</div>
<div class="line"><br /></div>
<div class="line"><cite>select sequencename 1000 1200</cite></div>
<div class="line">selects 201 images starting from number 1000 in sequence named sequencename</div>
<div class="line"><br /></div>
<div class="line">The second number can be greater than the number of images to just go up to the end.</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqapplyreg"><span class="commandname">seqapplyreg  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqapplyreg sequencename [-prefix=] [-scale=] [-layer=] [-framing=]
seqapplyreg sequencename ... [-interp=] [-noclamp]
seqapplyreg sequencename ... [-drizzle [-pixfrac=] [-kernel=] [-flat=]]
seqapplyreg sequencename ... [-filter-fwhm=value[%|k]] [-filter-wfwhm=value[%|k]] [-filter-round=value[%|k]] [-filter-bkg=value[%|k]] [-filter-nbstars=value[%|k]] [-filter-quality=value[%|k]] [-filter-incl[uded]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies geometric transforms on images of the sequence given in argument so that they may be superimposed on the reference image, using registration data previously computed (see REGISTER).</div>
<div class="line">The output sequence name starts with the prefix <strong>&quot;r_&quot;</strong> unless otherwise specified with <strong>-prefix=</strong> option.</div>
<div class="line">The registration is done on the first layer for which data exists for RGB images unless specified by <strong>-layer=</strong> option (0, 1 or 2 for R, G and B respectively).</div>
<div class="line">The output images can be rescaled by passing a <strong>-scale=</strong> argument with a float value between 0.1 and 3.</div>
<div class="line"><br /></div>
<div class="line">Automatic framing of the output sequence can be specified using <strong>-framing=</strong> keyword followed by one of the methods in the list { current | min | max | cog } :</div>
<div class="line"><strong>-framing=max</strong> (bounding box) will project each image and compute its shift wrt. reference image. The resulting sequence can then be stacked using option <strong>-maximize</strong> of STACK command which will create the full image encompassing all images of the sequence.</div>
<div class="line"><strong>-framing=min</strong> (common area) crops each image to the area it has in common with all images of the sequence.</div>
<div class="line"><strong>-framing=cog</strong> determines the best framing position as the center of gravity (cog) of all the images.</div>
<div class="line"><br /></div>
<div class="line"><strong>Image interpolation options:</strong></div>
<div class="line">By default, transformations are applied to register the images by using interpolation.</div>
<div class="line">The pixel interpolation method can be specified with the <strong>-interp=</strong> argument followed by one of the methods in the list <strong>no</strong>[ne], <strong>ne</strong>[arest], <strong>cu</strong>[bic], <strong>la</strong>[nczos4], <strong>li</strong>[near], <strong>ar</strong>[ea]}. If <strong>none</strong> is passed, the transformation is forced to shift and a pixel-wise shift is applied to each image without any interpolation.</div>
<div class="line">Clamping of the bicubic and lanczos4 interpolation methods is the default, to avoid artefacts, but can be disabled with the <strong>-noclamp</strong> argument.</div>
<div class="line"><br /></div>
<div class="line"><strong>Image drizzle options:</strong></div>
<div class="line">Otherwise, the images can be exported using HST drizzle algorithm by passing the argument <strong>-drizzle</strong> which can take the additional options:</div>
<div class="line"><strong>-pixfrac=</strong> sets the pixel fraction (default = 1.0).</div>
<div class="line">The <strong>-kernel=</strong> argument sets the drizzle kernel and must be followed by one of <strong>point</strong>, <strong>turbo</strong>, <strong>square</strong>, <strong>gaussian</strong>, <strong>lanczos2</strong> or <strong>lanczos3</strong>. The default is <strong>square</strong>.</div>
<div class="line">The <strong>-flat=</strong> argument specifies a master flat to weight the drizzled input pixels (default is no flat).</div>
<div class="line"><br /></div>
<div class="line"><strong>Filtering out images:</strong></div>
<div class="line">Images to be registered can be selected based on some filters, like those selected or with best FWHM, with some of the <strong>-filter-*</strong> options.</div>
<div class="line"><br /></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#register"><span class="std std-ref">register</span></a>, <a class="reference internal" href="#stack"><span class="std std-ref">stack</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
<div class="line">With filtering being some of these in no particular order or number:</div>
</div>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[-filter-fwhm=value[%|k]] [-filter-wfwhm=value[%|k]] [-filter-round=value[%|k]] [-filter-bkg=value[%|k]]
[-filter-nbstars=value[%|k]] [-filter-quality=value[%|k]] [-filter-incl[uded]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Best images from the sequence can be stacked by using the filtering arguments. Each of these arguments can remove bad images based on a property their name contains, taken from the registration data, with either of the three types of argument values:</div>
<div class="line">- a numeric value for the worse image to keep depending on the type of data used (between 0 and 1 for roundness and quality, absolute values otherwise),</div>
<div class="line">- a percentage of best images to keep if the number is followed by a % sign,</div>
<div class="line">- or a k value for the k.sigma of the worse image to keep if the number is followed by a k sign.</div>
<div class="line">It is also possible to use manually selected images, either previously from the GUI or with the select or unselect commands, using the <strong>-filter-included</strong> argument.</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqccm"><span class="commandname">seqccm  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqccm sequencename [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as CCM but for the the sequence <strong>sequencename</strong>. Only selected images in the sequence are processed.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;ccm&quot; unless otherwise specified with option <strong>-prefix=</strong></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#ccm"><span class="std std-ref">ccm</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqclean"><span class="commandname">seqclean  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqclean sequencename [-reg] [-stat] [-sel]
</pre></div>
</div>
<div class="line-block">
<div class="line">This command clears selection, registration and/or statistics data stored for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">You can specify to clear only registration, statistics and/or selection with <strong>-reg</strong>, <strong>-stat</strong> and <strong>-sel</strong> options respectively. All are cleared if no option is passed</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqcosme"><span class="commandname">seqcosme  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqcosme sequencename [filename].lst [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as COSME but for the the sequence <strong>sequencename</strong>. Only selected images in the sequence are processed.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;cosme_&quot; unless otherwise specified with option <strong>-prefix=</strong></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#cosme"><span class="std std-ref">cosme</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqcosme_cfa"><span class="commandname">seqcosme_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqcosme_cfa sequencename [filename].lst [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as COSME_CFA but for the the sequence <strong>sequencename</strong>. Only selected images in the sequence are processed.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;cosme_&quot; unless otherwise specified with option <strong>-prefix=</strong></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#cosme_cfa"><span class="std std-ref">cosme_cfa</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqcrop"><span class="commandname">seqcrop  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqcrop sequencename x y width height [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Crops the sequence given in argument <strong>sequencename</strong>. Only selected images in the sequence are processed.</div>
<div class="line"><br /></div>
<div class="line">The crop selection is specified by the upper left corner position <strong>x</strong> and <strong>y</strong> and the selection <strong>width</strong> and <strong>height</strong>, like for CROP.</div>
<div class="line">The output sequence name starts with the prefix &quot;cropped_&quot; unless otherwise specified with <strong>-prefix=</strong> option</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#crop"><span class="std std-ref">crop</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqextract_Green"><span class="commandname">seqextract_Green  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqextract_Green sequencename [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as EXTRACT_GREEN but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;Green_&quot; unless otherwise specified with option <strong>-prefix=</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqextract_Ha"><span class="commandname">seqextract_Ha  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqextract_Ha sequencename [-prefix=] [-upscale]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as EXTRACT_HA but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;Ha_&quot; unless otherwise specified with option <strong>-prefix=</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqextract_HaOIII"><span class="commandname">seqextract_HaOIII  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqextract_HaOIII sequencename [-resample=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as EXTRACT_HAOIII but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequences names start with the prefixes &quot;Ha_&quot; and &quot;OIII_&quot;</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqfind_cosme"><span class="commandname">seqfind_cosme  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqfind_cosme sequencename cold_sigma hot_sigma [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as FIND_COSME but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;cc_&quot; unless otherwise specified with <strong>-prefix=</strong> option</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#find_cosme"><span class="std std-ref">find_cosme</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqfind_cosme_cfa"><span class="commandname">seqfind_cosme_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqfind_cosme_cfa sequencename cold_sigma hot_sigma [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as FIND_COSME_CFA but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;cc_&quot; unless otherwise specified with <strong>-prefix=</strong> option</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#find_cosme_cfa"><span class="std std-ref">find_cosme_cfa</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqfindstar"><span class="commandname">seqfindstar  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqfindstar sequencename [-layer=] [-maxstars=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as FINDSTAR but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The option <strong>-out=</strong> is not available for this process as all the star list files are saved with the default name <em>seqname_seqnb.lst</em></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#findstar"><span class="std std-ref">findstar</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqfixbanding"><span class="commandname">seqfixbanding  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqfixbanding sequencename amount sigma [-prefix=] [-vertical]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as FIXBANDING but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;unband_&quot; unless otherwise specified with <strong>-prefix=</strong> option</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#fixbanding"><span class="std std-ref">fixbanding</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqght"><span class="commandname">seqght  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqght sequence -D= [-B=] [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as GHT but the sequence must be specified as the first argument. In addition, the optional argument <strong>-prefix=</strong> can be used to set a custom prefix</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#ght"><span class="std std-ref">ght</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqheader"><span class="commandname">seqheader  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqheader sequencename keyword [keyword2 ...] [-sel] [-out=file.csv]
</pre></div>
</div>
<div class="line-block">
<div class="line">Prints the FITS header value corresponding to the given keys for all images in the sequence. You can write several keys in a row, separated by a space. The <strong>-out=</strong> option, followed by a file name, allows you to print the output in a csv file. The <strong>-sel</strong> option limits the output to the images selected in the sequence</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqinvght"><span class="commandname">seqinvght  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqinvght sequence -D= [-B=] [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as INVGHT but the sequence must be specified as the first argument. In addition, the optional argument <strong>-prefix=</strong> can be used to set a custom prefix</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#invght"><span class="std std-ref">invght</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqinvmodasinh"><span class="commandname">seqinvmodasinh  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqinvmodasinh sequence -D= [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as INVMODASINH but the sequence must be specified as the first argument. In addition, the optional argument <strong>-prefix=</strong> can be used to set a custom prefix</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#invmodasinh"><span class="std std-ref">invmodasinh</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqlinstretch"><span class="commandname">seqlinstretch  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqlinstretch sequence -BP= [channels] [-sat] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as LINSTRETCH but the sequence must be specified as the first argument. In addition, the optional argument <strong>-prefix=</strong> can be used to set a custom prefix</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#linstretch"><span class="std std-ref">linstretch</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqmerge_cfa"><span class="commandname">seqmerge_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqmerge_cfa sequencename0 sequencename1 sequencename2 sequencename3 bayerpattern [-prefixout=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Merges 4 sequences of images to recombine the Bayer pattern. The sequences are specified in the arguments <strong>sequencename0</strong>, <strong>sequencename1</strong>, <strong>sequencename2</strong> and <strong>sequencename3</strong>.</div>
<div class="line"><br /></div>
<div class="line">The Bayer pattern to be reconstructed must be provided as the second argument as one of RGGB, BGGR, GBRG or GRBG (the order of the Bayer channels must match the order of the specified sequences).</div>
<div class="line"><br /></div>
<div class="line">Note: all 4 input sequences <strong>must</strong> be present and have the same dimensions, bit depth and number of images.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;mCFA_&quot; and a number unless otherwise specified with <strong>-prefixout=</strong> option</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqmodasinh"><span class="commandname">seqmodasinh  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqmodasinh sequence -D= [-LP=] [-SP=] [-HP=] [-clipmode=] [-human | -even | -independent | -sat] [channels] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as MODASINH but the sequence must be specified as the first argument. In addition, the optional argument <strong>-prefix=</strong> can be used to set a custom prefix</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#modasinh"><span class="std std-ref">modasinh</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqmtf"><span class="commandname">seqmtf  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqmtf sequencename low mid high [channels] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as MTF but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;mtf_&quot; unless otherwise specified with <strong>-prefix=</strong> option</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#mtf"><span class="std std-ref">mtf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqprofile"><span class="commandname">seqprofile  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqprofile sequence -from=x,y -to=x,y [-tri] [-cfa] [-arcsec] [-savedat] [-layer=] [-width=] [-spacing=] [ {-xaxis=wavelength | -xaxis=wavenumber } ] [{-wavenumber1= | -wavelength1=} -wn1at=x,y {-wavenumber2= | -wavelength2=} -wn2at=x,y] [&quot;-title=My Plot&quot;]
</pre></div>
</div>
<div class="line-block">
<div class="line">Generates an intensity profile plot between 2 points in each image in the sequence. After the mandatory first argument stating the sequence to process, the other arguments are the same as for the <strong>profile</strong> command. If processing a sequence and it is desired to have the current image number and total number of images displayed in the format &quot;My Sequence (1 / 5)&quot;, the given title should end with () (e.g. &quot;My Sequence ()&quot; and the numbers will be populated automatically)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqpsf"><span class="commandname">seqpsf  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqpsf sequencename [channel] [{ -at=x,y | -wcs=ra,dec }] [-followstar]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as PSF but runs on sequences. This is similar to the one-star registration, except results can be used for photometry analysis rather than aligning images and the coordinates of the star can be provided by options.</div>
<div class="line">This command is what is called internally by the menu that appears on right click in the image, with the PSF for the sequence entry. If registration data already exist for the sequence, they will can be used to shift the search window in each image. If there is no registration data and if there is significant shift between images in the sequence, the default settings will fail to find stars in the initial position of the search area.</div>
<div class="line">The follow star option can then be activated with the argument <strong>-followstar</strong>.</div>
<div class="line"><br /></div>
<div class="line">Results will be displayed in the Plot tab, from which they can also be exported to a comma-separated values (CSV) file for external analysis.</div>
<div class="line"><br /></div>
<div class="line">When creating a light curve, the first star for which seqpsf has been run, marked 'V' in the display, will be considered as the variable star. All others are averaged to create a reference light curve subtracted to the light curve of the variable star.</div>
<div class="line"><br /></div>
<div class="line">Currently, in headless operation, the command prints some analysed data in the console, another command allows several stars to be analysed and plotted as a light curve: LIGHT_CURVE. Arguments are mandatory: the sequence name must be provided (&quot;.&quot; may be used to indicate the currently loaded sequence) and when headless it is mandatory to provide the coordinates of the star, with -at= allowing coordinates in pixels to be provided for the target star of -wcs= allowing J2000 equatorial coordinates to be provided</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#light_curve"><span class="std std-ref">light_curve</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqplatesolve"><span class="commandname">seqplatesolve  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqplatesolve sequencename [image_center_coords] [-focal=] [-pixelsize=]
seqplatesolve sequencename ... [-downscale] [-order=] [-radius=] [-force] [-noreg] [-disto=]
seqplatesolve sequencename ... [-limitmag=[+-]] [-catalog=] [-nocrop] [-nocache]
seqplatesolve sequencename ... [-localasnet [-blindpos] [-blindres]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Plate solve a sequence. A new sequence will be created with the prefix &quot;ps_&quot; if the input sequence is SER, otherwise, the images headers will be updated. In case of SER, providing the metadata is mandatory and the output sequence will be in the FITS cube format, as SER cannot store WCS data.</div>
<div class="line">If WCS or other image metadata are erroneous or missing, arguments must be passed:</div>
<div class="line">the approximate image center coordinates can be provided in decimal degrees or degree/hour minute second values (J2000 with colon separators), with right ascension and declination values separated by a comma or a space (not mandatory for astrometry.net).</div>
<div class="line">focal length and pixel size can be passed with <strong>-focal=</strong> (in mm) and <strong>-pixelsize=</strong> (in microns), overriding values from images and settings. See also options to solve blindly with local Astrometry.net</div>
<div class="line"><br /></div>
<div class="line">For faster star detection in big images, downsampling the image is possible with <strong>-downscale</strong>.</div>
<div class="line">The solve can account for distortions using SIP convention with polynomials up to order 5. Default value is taken form the astrometry preferences. This can be changed with the option <strong>-order=</strong> giving a value between 1 and 5.</div>
<div class="line">When using Siril solver local catalogues or with local Astrometry.net, if the initial solve is not successful, the solver will search for a solution within a cone of radius specified with <strong>-radius=</strong> option. If no value is passed, the search radius is taken from the astrometry preferences. Siril near search can be disabled by passing a value of 0. (cannot be disabled for Astrometry.net).</div>
<div class="line">Images already solved will be skipped by default. This can be disabled by passing the option <strong>-force</strong>.</div>
<div class="line">Using this command will update registration data unless the option <strong>-noreg</strong> is passed.</div>
<div class="line">You can save the current solution as a distortion file with the option <strong>-disto=</strong>.</div>
<div class="line"><br /></div>
<div class="line">Images can be either plate solved by Siril using a star catalogue and the global registration algorithm or by astrometry.net's local solve-field command (enabled with <strong>-localasnet</strong>).</div>
<div class="line"><br /></div>
<div class="line"><strong>Siril platesolver options:</strong></div>
<div class="line">The limit magnitude of stars used for plate solving is automatically computed from the size of the field of view, but can be altered by passing a +offset or -offset value to <strong>-limitmag=</strong>, or simply an absolute positive value for the limit magnitude.</div>
<div class="line">The choice of the star catalog is automatic unless the <strong>-catalog=</strong> option is passed: if local catalogs are installed, they are used, otherwise the choice is based on the field of view and limit magnitude. If the option is passed, it forces the use of the remote catalog given in argument, with possible values: tycho2, nomad, gaia, ppmxl, brightstars, apass.</div>
<div class="line">If the computed field of view is larger than 5 degrees, star detection will be bounded to a cropped area around the center of the image unless <strong>-nocrop</strong> option is passed.</div>
<div class="line">When using online catalogues, a single catalogue extraction will be done for the entire sequence. If there is a lot of drift or different sampling, that may not succeed for all images. This can be disabled by passing the argument <strong>-nocache</strong>, in which case metadata from each image will be used (except for the forced values like center coordinates, pixel size and/or focal length).</div>
<div class="line"><br /></div>
<div class="line"><strong>Astrometry.net solver options:</strong></div>
<div class="line">Passing options <strong>-blindpos</strong> and/or <strong>-blindres</strong> enables to solve blindly for position and for resolution respectively. You can use these when solving an image with a completely unknown location and sampling</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqresample"><span class="commandname">seqresample  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqresample sequencename { -scale= | -width= | -height= } [-interp=] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Scales the sequence given in argument <strong>sequencename</strong>. Only selected images in the sequence are processed.</div>
<div class="line"><br /></div>
<div class="line">The scale factor is specified either by the <strong>-scale=</strong> argument or by setting the output width, height or maximum dimension using the <strong>-width=</strong>, <strong>-height=</strong> or <strong>-maxdim=</strong> options.</div>
<div class="line"><br /></div>
<div class="line">An interpolation method may be specified using the <strong>-interp=</strong> argument followed by one of the methods in the list <strong>ne</strong>[arest], <strong>cu</strong>[bic], <strong>la</strong>[nczos4], <strong>li</strong>[near], <strong>ar</strong>[ea]}.. Clamping is applied for cubic and lanczos interpolation.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;scaled_&quot; unless otherwise specified with <strong>-prefix=</strong> option</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqrl"><span class="commandname">seqrl  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqrl sequencename [-loadpsf=] [-alpha=] [-iters=] [-stop=] [-gdstep=] [-tv] [-fh] [-mul]
</pre></div>
</div>
<div class="line-block">
<div class="line">The same as the RL command, but applies to a sequence which must be specified as the first argument</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#rl"><span class="std std-ref">rl</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqsb"><span class="commandname">seqsb  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqsb sequencename [-loadpsf=] [-alpha=] [-iters=]
</pre></div>
</div>
<div class="line-block">
<div class="line">The same as the SB command, but applies to a sequence which must be specified as the first argument</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#sb"><span class="std std-ref">sb</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqsetmag"><span class="commandname">seqsetmag  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqsetmag magnitude
</pre></div>
</div>
<div class="line-block">
<div class="line">Same as SETMAG command but for the loaded sequence.</div>
<div class="line"><br /></div>
<div class="line">This command is only valid after having run SEQPSF or its graphical counterpart (select the area around a star and launch the PSF analysis for the sequence, it will appear in the graphs).</div>
<div class="line">This command has the same goal as SETMAG but recomputes the reference magnitude for each image of the sequence where the reference star has been found.</div>
<div class="line">When running the command, the last star that has been analysed will be considered as the reference star. Displaying the magnitude plot before typing the command makes it easy to understand.</div>
<div class="line">To reset the reference star and magnitude offset, see SEQUNSETMAG</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#setmag"><span class="std std-ref">setmag</span></a>, <a class="reference internal" href="#seqpsf"><span class="std std-ref">seqpsf</span></a>, <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#sequnsetmag"><span class="std std-ref">sequnsetmag</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqsplit_cfa"><span class="commandname">seqsplit_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqsplit_cfa sequencename [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as SPLIT_CFA but for the sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The output sequences names start with the prefix &quot;CFA_&quot; and a number unless otherwise specified with <strong>-prefix=</strong> option.</div>
<div class="line"><em>Limitation:</em> the sequence always outputs a sequence of FITS files, no matter the type of input sequence</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#split_cfa"><span class="std std-ref">split_cfa</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqstarnet"><span class="commandname">seqstarnet  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqstarnet sequencename [-stretch] [-upscale] [-stride=value] [-nostarmask]
</pre></div>
</div>
<div class="line-block">
<div class="line">This command calls <a class="reference external" href="https://www.starnetastro.com/">Starnet++</a> to remove stars from the sequence <strong>sequencename</strong>. See STARNET</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#starnet"><span class="std std-ref">starnet</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqstat"><span class="commandname">seqstat  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqstat sequencename output_file [option] [-cfa]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as STAT for sequence <strong>sequencename</strong>.</div>
<div class="line"><br /></div>
<div class="line">Data is saved as a csv file <strong>output_file</strong>.</div>
<div class="line">The optional parameter defines the number of statistical values computed: <strong>basic</strong>, <strong>main</strong> (default) or <strong>full</strong> (more detailed but longer to compute).</div>
<div class="line">\t<strong>basic</strong> includes mean, median, sigma, bgnoise, min and max</div>
<div class="line">\t<strong>main</strong> includes basic with the addition of avgDev, MAD and the square root of BWMV</div>
<div class="line">\t<strong>full</strong> includes main with the addition of location and scale.</div>
<div class="line"><br /></div>
<div class="line">If <strong>-cfa</strong> is passed and the images are CFA, statistics are made on per-filter extractions</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#stat"><span class="std std-ref">stat</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqsubsky"><span class="commandname">seqsubsky  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqsubsky sequencename { -rbf | degree } [-nodither] [-samples=20] [-tolerance=1.0] [-smooth=0.5] [-prefix=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as SUBSKY but for the sequence <strong>sequencename</strong>.</div>
<div class="line">Dithering, required for low dynamic gradients, can be disabled with <strong>-nodither</strong>. Note that the <strong>-existing</strong> option is not available for sequence background removal, as the frames of a sequence are not necessarily always aligned.</div>
<div class="line"><br /></div>
<div class="line">The output sequence name starts with the prefix &quot;bkg_&quot; unless otherwise specified with <strong>-prefix=</strong> option. Only selected images in the sequence are processed</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#subsky"><span class="std std-ref">subsky</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqtilt"><span class="commandname">seqtilt  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>seqtilt sequencename
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as TILT but for the sequence <strong>sequencename</strong>. It generally gives better results</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#tilt"><span class="std std-ref">tilt</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="sequnsetmag"><span class="commandname">sequnsetmag  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>sequnsetmag
</pre></div>
</div>
<div class="line-block">
<div class="line">Resets the magnitude calibration and reference star for the sequence. See SEQSETMAG</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#seqsetmag"><span class="std std-ref">seqsetmag</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="sequpdate_key"><span class="commandname">sequpdate_key  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>sequpdate_key sequencename key value [keycomment]
sequpdate_key sequencename -delete key
sequpdate_key sequencename -modify key newkey
sequpdate_key sequencename -comment comment
</pre></div>
</div>
<div class="line-block">
<div class="line">Same command as UPDATE_KEY but for the sequence <strong>sequencename</strong>. However, this command won't work on SER sequence</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#update_key"><span class="std std-ref">update_key</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="seqwiener"><span class="commandname">seqwiener  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>wiener sequencename [-loadpsf=] [-alpha=]
</pre></div>
</div>
<div class="line-block">
<div class="line">The same as the <strong>WIENER</strong> command, but applies to a sequence which must be specified as the first argument</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#wiener"><span class="std std-ref">wiener</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="set"><span class="commandname">set  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>set { -import=inifilepath | variable=value }
</pre></div>
</div>
<div class="line-block">
<div class="line">Updates a setting value, using its variable name, with the given value, or a set of values using an existing ini file with <strong>-import=</strong> option.</div>
<div class="line">See GET to get values or the list of variables</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#get"><span class="std std-ref">get</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="set16bits"><span class="commandname">set16bits  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>set16bits
</pre></div>
</div>
<div class="line-block">
<div class="line">Forbids images to be saved with 32 bits per channel on processing, use 16 bits instead</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="set32bits"><span class="commandname">set32bits  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>set32bits
</pre></div>
</div>
<div class="line-block">
<div class="line">Allows images to be saved with 32 bits per channel on processing</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setcompress"><span class="commandname">setcompress  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setcompress 0/1 [-type=] [q]
</pre></div>
</div>
<div class="line-block">
<div class="line">Defines if images are compressed or not.</div>
<div class="line"><br /></div>
<div class="line"><strong>0</strong> means no compression while <strong>1</strong> enables compression.</div>
<div class="line">If compression is enabled, the type must be explicitly written in the option <strong>-type=</strong> (&quot;rice&quot;, &quot;gzip1&quot;, &quot;gzip2&quot;).</div>
<div class="line">Associated to the compression, the quantization value must be within [0, 256] range.</div>
<div class="line"><br /></div>
<div class="line">For example, &quot;setcompress 1 -type=rice 16&quot; sets the rice compression with a quantization of 16</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setcpu"><span class="commandname">setcpu  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setcpu number
</pre></div>
</div>
<div class="line-block">
<div class="line">Defines the number of processing threads used for calculation.</div>
<div class="line"><br /></div>
<div class="line">Can be as high as the number of virtual threads existing on the system, which is the number of CPU cores or twice this number if hyperthreading (Intel HT) is available. The default value is the maximum number of threads available, so this should mostly be used to limit processing power. This is reset on every Siril run. See also SETMEM</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#setmem"><span class="std std-ref">setmem</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setext"><span class="commandname">setext  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setext extension
</pre></div>
</div>
<div class="line-block">
<div class="line">Sets the extension used and recognized by sequences.</div>
<div class="line"><br /></div>
<div class="line">The argument <strong>extension</strong> can be &quot;fit&quot;, &quot;fts&quot; or &quot;fits&quot;</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setfindstar"><span class="commandname">setfindstar  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setfindstar [reset] [-radius=] [-sigma=] [-roundness=] [-focal=] [-pixelsize=] [-convergence=] [ [-gaussian] | [-moffat] ] [-minbeta=] [-relax=on|off] [-minA=] [-maxA=] [-maxR=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Defines stars detection parameters for FINDSTAR and REGISTER commands.</div>
<div class="line"><br /></div>
<div class="line">Passing no parameter lists the current values.</div>
<div class="line">Passing <strong>reset</strong> resets all values to defaults. You can then still pass values after this keyword.</div>
<div class="line"><br /></div>
<div class="line">Configurable values:</div>
<div class="line"><br /></div>
<div class="line"><strong>-radius=</strong> defines the radius of the initial search box and must be between 3 and 50.</div>
<div class="line"><strong>-sigma=</strong> defines the threshold above noise and must be greater than or equal to 0.05.</div>
<div class="line"><strong>-roundness=</strong> defines minimum star roundness and must between 0 and 0.95. <strong>-maxR</strong> allows an upper bound to roundness to be set, to visualize only the areas where stars are significantly elongated, do not change for registration.</div>
<div class="line"><strong>-minA</strong> and <strong>-maxA</strong> define limits for the minimum and maximum amplitude of stars to keep, normalized between 0 and 1.</div>
<div class="line"><strong>-focal=</strong> defines the focal length of the telescope.</div>
<div class="line"><strong>-pixelsize=</strong> defines the pixel size of the sensor.</div>
<div class="line"><strong>-gaussian</strong> and <strong>-moffat</strong> configure the solver model to be used (Gaussian is the default).</div>
<div class="line">If Moffat is selected, <strong>-minbeta=</strong> defines the minimum value of beta for which candidate stars will be accepted and must be greater than or equal to 0.0 and less than 10.0.</div>
<div class="line"><strong>-convergence=</strong> defines the number of iterations performed to fit PSF and should be set between 1 and 3 (more tolerant).</div>
<div class="line"><strong>-relax=</strong> relaxes the checks that are done on star candidates to assess if they are stars or not, to allow objects not shaped like stars to still be accepted (off by default)</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#findstar"><span class="std std-ref">findstar</span></a>, <a class="reference internal" href="#register"><span class="std std-ref">register</span></a>, <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a></div>
</div>
<p>The threshold for star detection is computed as the median of the image (which
represents in general the background level) plus k times sigma, sigma being the
standard deviation of the image (which is a good indication of the noise
amplitude). If you have many stars in your images and a good signal/noise
ratio, it may be a good idea to increase this value to speed-up the detection
and false positives.</p>
<p>It is recommended to test the values used for a sequence with Siril's GUI,
available in the dynamic PSF toolbox from the analysis menu. It may improve
registration quality to increase the parameters, but it is also important to be
able to detect several tens of stars in each image.</p>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setmag"><span class="commandname">setmag  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setmag magnitude
</pre></div>
</div>
<div class="line-block">
<div class="line">Calibrates the magnitudes by selecting a star and giving the known apparent magnitude.</div>
<div class="line"><br /></div>
<div class="line">All PSF computations will return the calibrated apparent magnitude afterwards, instead of an apparent magnitude relative to ADU values. Note that the provided value must match the magnitude for the observation filter to be meaningful.</div>
<div class="line">To reset the magnitude constant see UNSETMAG</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#unsetmag"><span class="std std-ref">unsetmag</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setmem"><span class="commandname">setmem  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setmem ratio
</pre></div>
</div>
<div class="line-block">
<div class="line">Sets a new ratio of used memory on free memory.</div>
<div class="line"><br /></div>
<div class="line"><strong>Ratio</strong> value should be between 0.05 and 2, depending on other activities of the machine. A higher ratio should allow siril to process faster, but setting the ratio of used memory above 1 will require the use of on-disk memory, which is very slow and unrecommended, even sometimes not supported, leading to system crash. A fixed amount of memory can also be set in the generic settings, with SET, instead of a ratio</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#set"><span class="std std-ref">set</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setphot"><span class="commandname">setphot  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setphot [-inner=20] [-outer=30] [-aperture=10] [-dyn_ratio=4.0] [-gain=2.3] [-min_val=0] [-max_val=60000]
</pre></div>
</div>
<div class="line-block">
<div class="line">Gets or sets photometry settings, mostly used by SEQPSF. If arguments are provided, they will update the settings. None are mandatory, any can be provided, default values are shown in the command's syntax. At the end of the command, the active configuration will be printed.</div>
<div class="line"><br /></div>
<div class="line">The Aperture size is dynamic unless it is forced. If so, the <strong>aperture</strong> value from the settings is used. If dynamic, the radius of the aperture is defined by the supplied dynamic ratio (&quot;radius/half-FWHM&quot;).</div>
<div class="line">Allowed values for the argument <strong>-dyn_ratio</strong> are in the range [1.0, 5.0]. A value outside this range will automatically set the aperture to the fixed value <strong>-aperture</strong>.</div>
<div class="line"><br /></div>
<div class="line">Gain is used only if not available from the FITS header</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#seqpsf"><span class="std std-ref">seqpsf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="setref"><span class="commandname">setref  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>setref sequencename image_number
</pre></div>
</div>
<div class="line-block">
<div class="line">Sets the reference image of the sequence given in first argument. <strong>image_number</strong> is the sequential number of the image in the sequence, not the number in the filename, starting at 1</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="show"><span class="commandname">show  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>show [-clear] [{ -list=file.csv | [name] RA Dec }] [-nolog] [-notag]
</pre></div>
</div>
<div class="line-block">
<div class="line">Shows a point on the loaded plate solved image using the temporary user annotations catalogue, based on its equatorial coordinates. The <strong>-clear</strong> option clears this catalogue first and can be used alone.</div>
<div class="line">Several points can be passed using a CSV file with the option <strong>-list=</strong> containing at least ra and dec columns. If the passed file also contains a column name, names will be used as tags in the image and listed in the Console, unless toggled off with the options <strong>-notag</strong> and <strong>-nolog</strong>.</div>
<div class="line"><br /></div>
<div class="line">This is only available from the GUI of Siril</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="spcc"><span class="commandname">spcc  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>spcc [-limitmag=[+-]] [ { -monosensor= [ -rfilter= ] [-gfilter=] [-bfilter=] | -oscsensor= [-oscfilter=] [-osclpf=] } ] [-whiteref=] [ -narrowband [-rwl=] [-gwl=] [-bwl=] [-rbw=] [-gbw=] [-bbw=] ] [-bgtol=lower,upper] [ -atmos [-obsheight=] { [-pressure=] | [-slp=] } ]
</pre></div>
</div>
<div class="line-block">
<div class="line">Run the Spectrophotometric Color Correction on the loaded platesolved image.</div>
<div class="line"><br /></div>
<div class="line">The limit magnitude of stars is automatically computed from the size of the field of view, but can be altered by passing a +offset or -offset value to <strong>-limitmag=</strong>, or simply an absolute positive value for the limit magnitude.</div>
<div class="line">The star catalog used for SPCC is always Gaia DR3: by default the local Gaia DR3 xp_sampled catalog will be used if available but this can be overridden with <strong>-catalog={gaia | localgaia}</strong>.</div>
<div class="line"><br /></div>
<div class="line">The names of sensors and filters can be specified using the following options: <strong>-monosensor=</strong>, <strong>-rfilter=</strong>, <strong>-gfilter=</strong>, <strong>-bfilter=</strong> or <strong>-oscsensor=</strong>, <strong>-oscfilter=</strong>, <strong>-osclpf=</strong>; the name of the white reference can be specified using the <strong>-whiteref=</strong> option. In all cases the name must be provided exactly as it is in the combo boxes in the SPCC tool. Note that sensor, filter and white reference names may contain spaces: in this case when using them as arguments to the <strong>spcc</strong> command, the entire argument must be enclosed in quotation marks, for example &quot;-whiteref=Average Spiral Galaxy&quot;.</div>
<div class="line"><br /></div>
<div class="line">Narrowband mode can be selected using the argument <strong>-narrowband</strong>, in which case the previous filter arguments are ignored and NB filter wavelengths and bandwidths can be provided using <strong>-rwl=</strong>, <strong>-rbw=</strong>, <strong>-gwl=</strong>, <strong>-gbw=</strong>, <strong>-bwl=</strong> and <strong>-bbw=</strong>.</div>
<div class="line"><br /></div>
<div class="line">If one of the spectral data argument is omitted, the previously used value will be used.</div>
<div class="line"><br /></div>
<div class="line">Background reference outlier tolerance can be specified in sigma units using <strong>-bgtol=lower,upper</strong>: these default to -2.8 and +2.0.</div>
<div class="line"><br /></div>
<div class="line">Atmospheric correction can be applied by passing <strong>-atmos</strong>. In this case the following optional arguments apply: <strong>-obsheight=</strong> specifies the observer's height above sea level in metres (default 10), <strong>-pressure=</strong> specifies local atmospheric pressure at the observing site in hPa, or <strong>-slp=</strong> specifies sea-level atmospheric pressure in hPa (default pressure is 1013.25 hPa at sea level)</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="spcc_list"><span class="commandname">spcc_list  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>spcc_list { oscsensor | monosensor | redfilter | greenfilter | bluefilter | oscfilter | osclpf | whiteref }
</pre></div>
</div>
<div class="line-block">
<div class="line">Print a list of SPCC names available for use to define sensors, filters or white references using the <strong>spcc</strong> command. This command requires an argument to set which list is printed: the options are <strong>oscsensor</strong>, <strong>monosensor</strong>, <strong>redfilter</strong>, <strong>greenfilter</strong>, <strong>bluefilter</strong>, <strong>oscfilter</strong>, <strong>osclpf</strong> or <strong>whiteref</strong>.</div>
<div class="line">Note that sensor, filter and white reference names may contain spaces: in this case when using them as arguments to the <strong>spcc</strong> command, the entire argument must be enclosed in quotation marks, for example &quot;-whiteref=Average Spiral Galaxy&quot;</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#spcc"><span class="std std-ref">spcc</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="split"><span class="commandname">split  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>split file1 file2 file3 [-hsl | -hsv | -lab]
</pre></div>
</div>
<div class="line-block">
<div class="line">Splits the loaded color image into three distinct files (one for each color) and saves them in <strong>file1</strong>.fit, <strong>file2</strong>.fit and <strong>file3</strong>.fit files. A last argument can optionally be supplied, <strong>-hsl</strong>, <strong>-hsv</strong> or <strong>lab</strong> to perform an HSL, HSV or CieLAB extraction. If no option are provided, the extraction is of RGB type, meaning no conversion is done</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="split_cfa"><span class="commandname">split_cfa  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>split_cfa
</pre></div>
</div>
<div class="line-block">
<div class="line">Splits the loaded CFA image into four distinct files (one for each channel) and saves them in files</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="stack"><span class="commandname">stack  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>stack seqfilename
stack seqfilename { sum | min | max } [-output_norm] [-out=filename] [-maximize] [-upscale] [-32b]
stack seqfilename { med | median } [-nonorm, -norm=] [-fastnorm] [-rgb_equal] [-output_norm] [-out=filename] [-32b]
stack seqfilename { rej | mean } [rejection type] [sigma_low sigma_high]  [-rejmap[s]] [-nonorm, -norm=] [-fastnorm] [-overlap_norm] [-weight={noise|wfwhm|nbstars|nbstack}] [-feather=] [-rgb_equal] [-output_norm] [-out=filename] [-maximize] [-upscale] [-32b]
</pre></div>
</div>
<div class="line-block">
<div class="line">Stacks the <strong>sequencename</strong> sequence, using options.</div>
<div class="line"><br /></div>
<div class="line">Rejection type:</div>
<div class="line">The allowed types are: <strong>sum</strong>, <strong>max</strong>, <strong>min</strong>, <strong>med</strong> (or <strong>median</strong>) and <strong>rej</strong> (or <strong>mean</strong>). If no argument other than the sequence name is provided, sum stacking is assumed.</div>
<div class="line"><br /></div>
<div class="line">Stacking with rejection:</div>
<div class="line">Types <strong>rej</strong> or <strong>mean</strong> require the use of additional arguments for rejection type and values. The rejection type is one of <strong>n[one], p[ercentile], s[igma], m[edian], w[insorized], l[inear], g[eneralized], [m]a[d]</strong> for Percentile, Sigma, Median, Winsorized, Linear-Fit, Generalized Extreme Studentized Deviate Test or k-MAD clipping. If omitted, the default Winsorized is used.</div>
<div class="line">The <strong>sigma low</strong> and <strong>sigma high</strong> parameters of rejection are mandatory unless <strong>none</strong> is selected.</div>
<div class="line">Optionally, rejection maps can be created, showing where pixels were rejected in one (<strong>-rejmap</strong>) or two (<strong>-rejmaps</strong>, for low and high rejections) newly created images.</div>
<div class="line"><br /></div>
<div class="line">Normalization of input images:</div>
<div class="line">For <strong>med</strong> (or <strong>median</strong>) and <strong>rej</strong> (or <strong>mean</strong>) stacking types, different types of normalization are allowed: <strong>-norm=add</strong> for additive, <strong>-norm=mul</strong> for multiplicative. Options <strong>-norm=addscale</strong> and <strong>-norm=mulscale</strong> apply same normalization but with scale operations. <strong>-nonorm</strong> is the option to disable normalization. Otherwise addtive with scale method is applied by default.</div>
<div class="line"><strong>-fastnorm</strong> option specifies to use faster estimators for location and scale than the default IKSS.</div>
<div class="line"><strong>-overlap_norm</strong>, if passed, will compute normalization coeffcients on images overlaps instead of whole images (allowed only if <strong>-maximize</strong> is passed).</div>
<div class="line"><br /></div>
<div class="line">Other options for rejection stacking:</div>
<div class="line">Weighting can be applied to the images of the sequences using the option <strong>-weight=</strong> followed by:</div>
<div class="line"><strong>noise</strong> to add larger weights to frames with lower background noise.</div>
<div class="line"><strong>nbstack</strong> to weight input images based on how many images were used to create them, useful for live stacking.</div>
<div class="line"><strong>nbstars</strong> or <strong>wfwhm</strong> to weight input images based on number of stars or wFWHM computed during registration step.</div>
<div class="line"><strong>-feather=</strong> option will apply a feathering mask on each image borders over the distance (in pixels) given in argument.</div>
<div class="line"><br /></div>
<div class="line">Outputs:</div>
<div class="line">Result image name can be set with the <strong>-out=</strong> option. Otherwise, it will be named as <strong>sequencename</strong>_stacked.fit.</div>
<div class="line"><strong>-output_norm</strong> applies a normalization to rescale result in the [0, 1] range (median and mean stacking only).</div>
<div class="line"><strong>-maximize</strong> option will use registration data from the sequence to create a stacked image that encompasses all the images of the sequence (applicable to all methods except median stacking).</div>
<div class="line"><strong>-upscale</strong> option will upscale the sequence by a factor 2 prior to stacking using the registration data (applicable to all methods except median stacking).</div>
<div class="line"><strong>-rgb_equal</strong> will use normalization to equalize color image backgrounds, useful if PCC/SPCC or unlinked AUTOSTRETCH will not be used.</div>
<div class="line"><strong>-32b</strong> will override the bitdepth set in Preferences and save the stacked image in 32b.</div>
<div class="line"><br /></div>
<div class="line"><br /></div>
<div class="line">Filtering out images:</div>
<div class="line">Images to be stacked can be selected based on some filters, like manual selection or best FWHM, with some of the <strong>-filter-*</strong> options.</div>
<div class="line"><br /></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#pcc"><span class="std std-ref">pcc</span></a>, <a class="reference internal" href="#spcc"><span class="std std-ref">spcc</span></a>, <a class="reference internal" href="#autostretch"><span class="std std-ref">autostretch</span></a></div>
</div>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>[-filter-fwhm=value[%|k]] [-filter-wfwhm=value[%|k]] [-filter-round=value[%|k]] [-filter-bkg=value[%|k]]
[-filter-nbstars=value[%|k]] [-filter-quality=value[%|k]] [-filter-incl[uded]]
</pre></div>
</div>
<div class="line-block">
<div class="line">Best images from the sequence can be stacked by using the filtering arguments. Each of these arguments can remove bad images based on a property their name contains, taken from the registration data, with either of the three types of argument values:</div>
<div class="line">- a numeric value for the worse image to keep depending on the type of data used (between 0 and 1 for roundness and quality, absolute values otherwise),</div>
<div class="line">- a percentage of best images to keep if the number is followed by a % sign,</div>
<div class="line">- or a k value for the k.sigma of the worse image to keep if the number is followed by a k sign.</div>
<div class="line">It is also possible to use manually selected images, either previously from the GUI or with the select or unselect commands, using the <strong>-filter-included</strong> argument.</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="stackall"><span class="commandname">stackall  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>stackall
stackall { sum | min | max } [-maximize] [-upscale] [-32b]
stackall { med | median } [-nonorm, norm=] [-32b]
stackall { rej | mean } [rejection type] [sigma_low sigma_high] [-nonorm, norm=] [-overlap_norm] [-weight={noise|wfwhm|nbstars|nbstack}] [-feather=] [-rgb_equal] [-out=filename] [-maximize] [-upscale] [-32b]
</pre></div>
</div>
<div class="line-block">
<div class="line">Opens all sequences in the current directory and stacks them with the optionally specified stacking type and filtering or with sum stacking. See STACK command for options description</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#stack"><span class="std std-ref">stack</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="starnet"><span class="commandname">starnet  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>starnet [-stretch] [-upscale] [-stride=value] [-nostarmask]
</pre></div>
</div>
<div class="line-block">
<div class="line">Calls <a class="reference external" href="https://www.starnetastro.com/">StarNet</a> to remove stars from the loaded image.</div>
<div class="line"><br /></div>
<div class="line"><strong>Prerequisite:</strong> StarNet is an external program, with no affiliation with Siril, and must be installed correctly prior the first use of this command, with the path to its CLI version installation correctly set in Preferences / Miscellaneous.</div>
<div class="line"><br /></div>
<div class="line">The starless image is loaded on completion, and a star mask image is created in the working directory unless the optional parameter <strong>-nostarmask</strong> is provided.</div>
<div class="line"><br /></div>
<div class="line">Optionally, parameters may be passed to the command:</div>
<div class="line">- The option <strong>-stretch</strong> is for use with linear images and will apply a pre-stretch before running StarNet and the inverse stretch to the generated starless and starmask images.</div>
<div class="line">- To improve star removal on images with very tight stars, the parameter <strong>-upscale</strong> may be provided. This will upsample the image by a factor of 2 prior to StarNet processing and rescale it to the original size afterwards, at the expense of more processing time.</div>
<div class="line">- The optional parameter <strong>-stride=value</strong> may be provided, however the author of StarNet <em>strongly</em> recommends that the default stride of 256 be used</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="start_ls"><span class="commandname">start_ls  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>start_ls [-dark=filename] [-flat=filename] [-rotate] [-32bits]
</pre></div>
</div>
<div class="line-block">
<div class="line">Initializes a livestacking session, using the optional calibration files and waits for input files to be provided by the LIVESTACK command until STOP_LS is called. Default processing will use shift-only registration and 16-bit processing because it's faster, it can be changed to rotation with <strong>-rotate</strong> and <strong>-32bits</strong></div>
<div class="line"><br /></div>
<div class="line"><em>Note that the live stacking commands put Siril in a state in which it's not able to process other commands. After START_LS, only LIVESTACK, STOP_LS and EXIT can be called until STOP_LS is called to return Siril in its normal, non-live-stacking, state</em></div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#livestack"><span class="std std-ref">livestack</span></a>, <a class="reference internal" href="#stop_ls"><span class="std std-ref">stop_ls</span></a>, <a class="reference internal" href="#exit"><span class="std std-ref">exit</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="stat"><span class="commandname">stat  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>stat [-cfa] [main]
</pre></div>
</div>
<div class="line-block">
<div class="line">Returns statistics of the current image, the basic list by default or the main list if <strong>main</strong> is passed. If a selection is made, statistics are computed within the selection. If <strong>-cfa</strong> is passed and the image is CFA, statistics are made on per-filter extractions</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="stop_ls"><span class="commandname">stop_ls  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>stop_ls
</pre></div>
</div>
<div class="line-block">
<div class="line">Stops the live stacking session. Only possible after START_LS</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#start_ls"><span class="std std-ref">start_ls</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="subsky"><span class="commandname">subsky  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>subsky { -rbf | degree } [-dither] [-samples=20] [-tolerance=1.0] [-smooth=0.5] [-existing]
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes a synthetic background gradient using either the polynomial function model of <strong>degree</strong> degrees or the RBF model (if <strong>-rbf</strong> is provided instead) and subtracts it from the image.</div>
<div class="line">The number of samples per horizontal line and the tolerance to exclude brighter areas can be adjusted with the optional arguments. Tolerance is in MAD units: median + tolerance * mad.</div>
<div class="line">Dithering, required for low dynamic gradients, can be enabled with <strong>-dither</strong>.</div>
<div class="line">For RBF, the additional smoothing parameter is also available. To use pre-existing background samples (e.g. if you have set background samples using a Python script) the <strong>-existing</strong> argument must be used</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="synthstar"><span class="commandname">synthstar  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>synthstar
</pre></div>
</div>
<div class="line-block">
<div class="line">Fixes imperfect stars from the loaded image. No matter how much coma, tracking drift or other distortion your stars have, if Siril's star finder routine can detect it, synthstar will fix it. To use intensive care, you may wish to manually detect all the stars you wish to fix. This can be done using the findstar console command or the Dynamic PSF dialog. If you have not run star detection, it will be run automatically with default settings.</div>
<div class="line"><br /></div>
<div class="line">For best results synthstar should be run before stretching.</div>
<div class="line"><br /></div>
<div class="line">The output of synthstar is a fully corrected synthetic star mask comprising perfectly round star PSFs (Moffat or Gaussian profiles depending on star saturation) computed to match the intensity, FWHM, hue and saturation measured for each star detected in the input image. This can then be recombined with the starless image to produce an image with perfect stars.</div>
<div class="line"><br /></div>
<div class="line">No parameters are required for this command</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="threshlo"><span class="commandname">threshlo  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>threshlo level
</pre></div>
</div>
<div class="line-block">
<div class="line">Replaces values below <strong>level</strong> in the loaded image with <strong>level</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="threshhi"><span class="commandname">threshhi  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>threshi level
</pre></div>
</div>
<div class="line-block">
<div class="line">Replaces values above <strong>level</strong> in the loaded image with <strong>level</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="thresh"><span class="commandname">thresh  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>thresh lo hi
</pre></div>
</div>
<div class="line-block">
<div class="line">Replaces values below <strong>level</strong> in the loaded image with <strong>level</strong></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="tilt"><span class="commandname">tilt  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>tilt [clear]
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes the sensor tilt as the FWHM difference between the best and worst corner truncated mean values. The <strong>clear</strong> option allows to clear the drawing</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="trixel"><span class="commandname">trixel  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>trixel [-p]
</pre></div>
</div>
<div class="line-block">
<div class="line">For developers.</div>
<div class="line"><br /></div>
<div class="line">Without any argument, lists all the trixels of level 3 visible in the plate-solved image. The stars from each trixel can then be shown with command CONESEARCH using <strong>-trix=</strong> followed by a visible trixel number</div>
<div class="line"><br /></div>
<div class="line">With argument <strong>-p</strong>, prints out all the valid stars from all the 512 level3 trixels to file &quot;trixels.csv&quot;</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#conesearch"><span class="std std-ref">conesearch</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="unclipstars"><span class="commandname">unclipstars  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>unclipstars
</pre></div>
</div>
<div class="line-block">
<div class="line">Re-profiles clipped stars of the loaded image to desaturate them, scaling the output so that all pixel values are &lt;= 1.0</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="unpurple"><span class="commandname">unpurple  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>unpurple [-starmask] [-blue=value] [-thresh=value]
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies a cosmetic filter to reduce effects of purple fringing on stars.</div>
<div class="line"><br /></div>
<div class="line">If the <strong>-starmask</strong> parameter is given, a star mask will be used to identify areas of the image to affect. If a Dynamic PSF has already been run, this will be used for the starmask, otherwise one will be created automatically. The <strong>-mod=</strong> parameter should be given a value somewhere around 0.14 to reduce the amount of purple. The <strong>-thresh=</strong> will specify the size modifier for each star in the starmask and should be large enough to cause the stars to be entirely processed without remaining purple fringing. The value should between 0 and 1, typically around 0.5.</div>
<div class="line">If the <strong>-starmask</strong> parameter is not given, the purple reduction will be applied across the entire image for any purple pixels with a luminance value higher than the given <strong>-thresh=</strong>. In this case, the <strong>-thresh=</strong> value should be reasonably low. This mode is useful for starmasks or other images without nebula or galaxy</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="unselect"><span class="commandname">unselect  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>unselect sequencename from to
</pre></div>
</div>
<div class="line-block">
<div class="line">Allows easy mass unselection of images in the sequence <strong>sequencename</strong> (from <strong>from</strong> to <strong>to</strong> included). See SELECT</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#select"><span class="std std-ref">select</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="unsetmag"><span class="commandname">unsetmag  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>unsetmag
</pre></div>
</div>
<div class="line-block">
<div class="line">Resets the magnitude calibration to 0. See SETMAG</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#setmag"><span class="std std-ref">setmag</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="unsharp"><span class="commandname">unsharp  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>unsharp sigma multi
</pre></div>
</div>
<div class="line-block">
<div class="line">Applies an unsharp mask, actually a Gaussian filtered image with sigma <strong>sigma</strong> and a blend with the parameter <strong>amount</strong> used as such: out = in * (1 + amount) + filtered * (-amount).</div>
<div class="line"><br /></div>
<div class="line">See also GAUSS, the same without blending</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#gauss"><span class="std std-ref">gauss</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="update_key"><span class="commandname">update_key  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>update_key key value [keycomment]
update_key -delete key
update_key -modify key newkey
update_key -comment comment
</pre></div>
</div>
<div class="line-block">
<div class="line">Updates FITS keyword. Please note that the validity of <strong>value</strong> is not checked. This verification is the responsibility of the user. It is also possible to delete a key with the <strong>-delete</strong> option in front of the name of the key to be deleted, or to modify the key with the <strong>-modify</strong> option. The latter must be followed by the key to be modified and the new key name. Finally, the <strong>-comment</strong> option, followed by text, adds a comment to the FITS header. Please note that any text containing spaces must be enclosed in double quotation marks</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="visu"><span class="commandname">visu  <img alt="Non scriptable" src="_images/nonscriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>visu low high
</pre></div>
</div>
<div class="line-block">
<div class="line">Displays the loaded image with <strong>low</strong> and <strong>high</strong> as the low and high threshold, GUI only</div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="wavelet"><span class="commandname">wavelet  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>wavelet nbr_layers type
</pre></div>
</div>
<div class="line-block">
<div class="line">Computes the wavelet transform of the loaded image on (<strong>nbr_layers</strong>=1...n) layer(s) using linear (<strong>type</strong>=1) or bspline (<strong>type</strong>=2) version of the 'à trous' algorithm. The result is stored in a file as a structure containing the layers, ready for weighted reconstruction with WRECONS.</div>
<div class="line"><br /></div>
<div class="line">See also EXTRACT</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#wrecons"><span class="std std-ref">wrecons</span></a>, <a class="reference internal" href="#extract"><span class="std std-ref">extract</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="wiener"><span class="commandname">wiener  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>wiener [-loadpsf=] [-alpha=]
</pre></div>
</div>
<div class="line-block">
<div class="line">Restores an image using the Wiener deconvolution method.</div>
<div class="line"><br /></div>
<div class="line">Optionally, a PSF created by MAKEPSF may be loaded using the argument <strong>-loadpsf=filename</strong>.</div>
<div class="line"><br /></div>
<div class="line">The parameter <strong>-alpha=</strong> provides the Gaussian noise modelled regularization factor</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#psf"><span class="std std-ref">psf</span></a>, <a class="reference internal" href="#makepsf"><span class="std std-ref">makepsf</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
<p id="wrecons"><span class="commandname">wrecons  <img alt="Scriptable" src="_images/scriptable.svg" /><a class="reference external" href="std-cmdindex.html"><img alt="Back to index" src="_images/index.svg" style="width: 20px;" /></a></span></p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>wrecons c1 c2 c3 ...
</pre></div>
</div>
<div class="line-block">
<div class="line">Reconstructs to current image from the layers previously computed with wavelets and weighted with coefficients <strong>c1</strong>, <strong>c2</strong>, ..., <strong>cn</strong> according to the number of layers used for wavelet transform, after the use of WAVELET</div>
<div class="line"><br /></div>
<div class="line">Links: <a class="reference internal" href="#wavelet"><span class="std std-ref">wavelet</span></a></div>
</div>
<div class="line-block">
<div class="line"><br /></div>
</div>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="Livestack.html" class="btn btn-neutral float-left" title="Livestacking" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="Python-API.html" class="btn btn-neutral float-right" title="Sirilpy Python Module API 1.0.0 Reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2025, Free-Astro Team.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
   

</body>
</html>