-
Notifications
You must be signed in to change notification settings - Fork 0
/
ddfacet_stimela_inputs_schema.yaml
965 lines (965 loc) · 32.4 KB
/
ddfacet_stimela_inputs_schema.yaml
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
Data:
MS:
info: Single MS name, or list of comma-separated MSs, or name of *.txt file listing
MSs. Note that each MS may also be specified as a glob pattern (e.g. *.MS),
and may be suffixed with "//Dx" and/or "//Fy" to select specific DATA_DESC_ID
and FIELD_IDs in the MS. "x" and "y" can take the form of a single number, a
Pythonic range (e.g. "0:16"), an inclusive range ("0~15"), or "*" to select
all. E.g. "foo.MS//D*//F0:2" selects all DDIDs, and fields 0 and 1 from foo.MS.
If D and/or F is not specified, --Selection-Field and --Selection-DDID is used
as the default.
required: false
dtype: List[MS]
policies:
repeat: ','
ColName:
info: 'MS column to image (Default: CORRECTED_DATA)'
required: false
dtype: str
ChunkHours:
info: 'Process data in chunks of <=N hours. Use 0 for no chunking. (Default: 0.0)'
required: false
dtype: float
Sort:
info: 'if True, data will be resorted by baseline-time order internally. This
usually speeds up processing. (Default: False)'
required: false
dtype: bool
Predict:
ColName:
info: MS column to write predict to. Can be empty to disable.
required: false
dtype: str
MaskSquare:
info: Use this field if you want to predict (in/out)side a square region. Syntax
is (MaskOutSide,NpixInside). For example setting (0,1000) will predict the outer
(1000x1000) square only
required: false
FromImage:
info: In --Image-Mode=Predict, will predict data from this image, rather than
--Data-InitDicoModel
required: false
dtype: str
InitDicoModel:
info: Resume deconvolution from given DicoModel
required: false
dtype: str
Overwrite:
info: 'Allow overwriting of predict column (Default: True)'
required: false
dtype: bool
Selection:
Field:
info: 'default FIELD_ID to read, if not specified in --Data-MS. (Default: 0)'
required: false
dtype: int
DDID:
info: 'default DATA_DESC_ID to read, if not specified in --Data-MS. (Default:
0)'
required: false
dtype: int
TaQL:
info: additional TaQL selection string
required: false
dtype: str
ChanStart:
info: 'First channel (Default: 0)'
required: false
dtype: int
ChanEnd:
info: 'Last channel+1, -1 means up and including last channel. (Default: -1)'
required: false
dtype: int
ChanStep:
info: 'Channel stepping (Default: 1)'
required: false
dtype: int
FlagAnts:
info: List of antennas to be flagged, e.g. "RS,CS017LBA"
required: false
UVRangeKm:
info: 'Select baseline range (Default: [0, 2000])'
required: false
TimeRange:
info: Select time range, in hours since starts of MS
required: false
DistMaxToCore:
info: Select antennas by specifying a maximum distance to core
required: false
Output:
Mode:
info: 'What to do. (Default: Clean)'
required: false
Clobber:
info: 'Allow overwriting of existing parset and images (can''t be specified via
parset!) (Default: False)'
required: false
dtype: bool
Name:
info: 'Base name of output images (Default: image)'
required: false
dtype: str
ShiftFacetsFile:
info: Astrometric correction per facet, when Image-Mode=RestoreAndShift
required: false
RestoringBeam:
info: ''
required: false
Also:
info: Save also these images (i.e. adds to the default set of --Output-Images)
required: false
dtype: str
Cubes:
info: Also save cube versions for these images (only MmRrIi codes recognized)
required: false
dtype: str
Images:
info: 'Combination of letter codes indicating what images to save. Uppercase for
intrinsic flux scale [D]irty, [M]odel, [C]onvolved model, [R]esiduals, restored
[I]mage; Lowercase for apparent flux scale [d]irty, [m]odel, [c]onvolved model,
[r]esiduals, restored [i]mage; Other images: [P]SF, [N]orm, [n]orm facets, [S]
flux scale, [A]lpha (spectral index), [X] mixed-scale (intrinsic model, apparent
residuals, i.e. Cyrils original output), [o] intermediate mOdels (Model_i),
[e] intermediate rEsiduals (Residual_i), [k] intermediate masK image, [z] intermediate
auto mask-related noiZe image, [g] intermediate dirty images (only if [Debugging]
SaveIntermediateDirtyImages is enabled). Use "all" to save all. (Default: DdPAMRIikem)'
required: false
StokesResidues:
info: 'After cleaning Stokes I, output specified residues if [r] or [R] is specified
in option Output-Images. Note that the imager does not perform deconvolution
on any Stokes products other than I - it only outputs residues. (Default: I)'
required: false
SPIMaps:
AlphaThreshold:
info: 'Multiple of the RMS in final residual which determines threshold for fitting
alpha map. (Default: 15)'
required: false
dtype: int
Image:
NPix:
info: 'Image size. (Default: 5000)'
required: false
dtype: int
Cell:
info: 'Cell size. (Default: 5.0)'
required: false
dtype: float
PhaseCenterRADEC:
info: Use non-default phase centre. If "align" is used, all MSs will be rephased
to the phase centre of the first MS. Otherwise, specify [HH:MM:SS,DD:MM:SS]
direction. If empty, no rephasing is done.
required: false
SidelobeSearchWindow:
info: 'Size of PSF subwindow (centred around the main lobe) to search for the
highest sidelobe when fitting the PSF size. (Default: 200)'
required: false
dtype: int
Facets:
NFacets:
info: 'Number of facets to use. (Default: 3)'
required: false
dtype: int
CatNodes:
info: ''
required: false
DiamMax:
info: 'Max facet size, for tessellations. Larger facets will be broken up. (Default:
180.0)'
required: false
dtype: float
DiamMin:
info: 'Min facet size, for tessellations. Smaller facets will be merged. (Default:
0.0)'
required: false
dtype: float
MixingWidth:
info: 'Sigma of the gaussian (in pixels) being used to mix the facets on their
edges (Default: 10)'
required: false
PSFOversize:
info: 'For cleaning, use oversize PSF relative to size of facet. (Default: 1.0)'
required: false
dtype: float
PSFFacets:
info: 'Number of PSF facets to make. 0: same as NFacets (one PSF per facet) 1:
one PSF for entire field. (Default: 0)'
required: false
dtype: int
Padding:
info: 'Facet padding factor. (Default: 1.7)'
required: false
dtype: float
Circumcision:
info: 'Set to non-0 to override NPixMin computation in FacetsToIm(). Debugging
option, really. (Default: 0)'
required: false
FluxPaddingAppModel:
info: For flux-dependent facet-padding, the apparant model image (or cube)
required: false
FluxPaddingScale:
info: 'The factor applied to the --Facets-Padding for the facet with the highest
flux (Default: 2.0)'
required: false
Weight:
ColName:
info: 'Read data weights from specified column. Use WEIGHT_SPECTRUM or WEIGHT,
more rarely IMAGING_WEIGHT. You can also specify a list of columns like using
--Weight-ColName=[WEIGHT_SPECTRUM,IMAGING_WEIGHT] (Default: WEIGHT_SPECTRUM)'
required: false
Mode:
info: 'Image weighting. (Default: Briggs)'
required: false
MFS:
info: 'If True, MFS uniform/Briggs weighting is used (all channels binned onto
one uv grid). If 0, binning is per-band. (Default: True)'
required: false
dtype: bool
Robust:
info: 'Briggs robustness parameter, from -2 to 2. (Default: 0.0)'
required: false
dtype: float
SuperUniform:
info: 'Super/subuniform weighting: FoV for weighting purposes is taken as X*Image_Size
(Default: 1.0)'
required: false
dtype: float
OutColName:
info: Save the internally computed weights into this column
required: false
dtype: str
RIME:
Precision:
info: 'Single or double precision gridding. DEPRECATED? (Default: S)'
required: false
PolMode:
info: '(DIRTY ONLY) Polarization mode. (Default: I)'
required: false
FFTMachine:
info: ' (Default: FFTW)'
required: false
ForwardMode:
info: 'Forward predict mode. (Default: BDA-degrid)'
required: false
BackwardMode:
info: 'Backward mode. (Default: BDA-grid)'
required: false
DecorrMode:
info: decorrelation mode
required: false
DecorrLocation:
info: 'where decorrelation is estimated (Default: Edge)'
required: false
CF:
OverS:
info: 'Oversampling factor. (Default: 11)'
required: false
dtype: int
Support:
info: 'CF support size. (Default: 7)'
required: false
dtype: int
Nw:
info: 'Number of w-planes. (Default: 100)'
required: false
dtype: int
wmax:
info: 'Maximum w coordinate. Visibilities with larger w will not be gridded. If
0, no maximum is imposed. (Default: 0.0)'
required: false
dtype: float
Comp:
GridDecorr:
info: 'Maximum BDA decorrelation factor (gridding) (Default: 0.02)'
required: false
dtype: float
GridFoV:
info: 'FoV over which decorrelation factor is computed (gridding) (Default: Facet)'
required: false
DegridDecorr:
info: 'Maximum BDA decorrelation factor (degridding) (Default: 0.02)'
required: false
dtype: float
DegridFoV:
info: 'FoV over which decorrelation factor is computed (degridding) (Default:
Facet)'
required: false
Sparsification:
info: 'apply sparsification compression to initial major cycles. Sparsification
refers to throwing away random visibilities. Supply a list of factors: e.g.
100,30,10 would mean only 1/100 of the data is used for the first major cycle,
1/30 for the second, 1/10 for the third, and full data for the fourth cycle
onwards. This can substantially accelerate deconvolution of deep observations,
since, in these regimes, very little sensitivity is required for model construction
in the initial cycles. (Default: 0)'
required: false
BDAMode:
info: 'BDA block computation mode. 1 for Cyril''s old mode, 2 for Oleg''s new
mode. 2 is faster but see issue #319. (Default: 1)'
required: false
BDAJones:
info: 'If disabled, gridders and degridders will apply a Jones terms per visibility.
If ''grid'', gridder will apply them per BDA block, if ''both'' so will the
degridder. This is faster but possibly less accurate, if you have rapidly evolving
Jones terms. (Default: 0)'
required: false
Parallel:
NCPU:
info: 'Number of CPUs to use in parallel mode. 0: use all available. 1: disable
parallelism. (Default: 0)'
required: false
dtype: int
Affinity:
info: 'pin processes to cores. -1/1/2 determines stepping used in selecting cores.
Alternatively specifies a list of length NCPU. Alternatively "disable" to disable
affinity settings Alternatively "enable_ht" uses stepping of 1 (equivalent to
Parallel.Affinity=1), will use all vthreads - the obvious exception is if HT
is disabled at BIOS level Alternatively "disable_ht" autodetects the NUMA layout
of the chip for Debian-based systems and dont use both vthreads per core Use
1 if unsure. (Default: 1)'
required: false
MainProcessAffinity:
info: 'this should be set to a core that is not used by forked processes, this
option is ignored when using option "disable or disable_ht" for Parallel.Affinity
(Default: 0)'
required: false
MotherNode:
info: ' (Default: localhost)'
required: false
Cache:
Reset:
info: 'Reset all caches (including PSF and dirty image) (Default: False)'
required: false
dtype: bool
SmoothBeam:
info: 'Reset cached smmoth beam (Default: auto)'
required: false
Weight:
info: 'Reset cached smmoth beam (Default: auto)'
required: false
PSF:
info: 'Cache PSF data. (Default: auto)'
required: false
Dirty:
info: 'Cache dirty image data. (Default: auto)'
required: false
VisData:
info: 'Cache visibility data and flags at runtime. (Default: auto)'
required: false
LastResidual:
info: 'Cache last residual data (at end of last minor cycle) (Default: True)'
required: false
dtype: bool
Dir:
info: Directory to store caches in. Default is to keep cache next to the MS, but
this can cause performance issues with e.g. NFS volumes. If you have fast local
storage, point to it. %metavar:DIR
required: false
DirWisdomFFTW:
info: 'Directory in which to store the FFTW wisdom files (Default: ~/.fftw_wisdom)'
required: false
ResetWisdom:
info: 'Reset Wisdom file (Default: False)'
required: false
dtype: bool
CF:
info: 'Cache convolution functions. With many CPUs, may be faster to recompute.
(Default: True)'
required: false
dtype: bool
HMP:
info: 'Cache HMP basis functions. With many CPUs, may be faster to recompute.
(Default: False)'
required: false
dtype: bool
Beam:
Model:
info: Beam model to use.
required: false
At:
info: 'when DDESolutions are enabled, compute beam per facet, or per larger solution
tessel (Default: facet)'
required: false
LOFARBeamMode:
info: 'LOFAR beam mode. (Default: AE)'
required: false
NBand:
info: 'Number of channels over which same beam value is used. 0 means use every
channel. (Default: 0)'
required: false
dtype: int
CenterNorm:
info: 'Normalize beam so that its amplitude at the centre is 1. (Default: True)'
required: false
dtype: bool
Smooth:
info: 'Compute the interpolated smooth beam (Default: False)'
required: false
SmoothNPix:
info: 'Number of pixels the beam is evaluated and smoothed (Default: 11)'
required: false
dtype: int
SmoothInterpMode:
info: 'Linear/Log (Default: Linear)'
required: false
FITSFile:
info: 'Beam FITS file pattern. A beam pattern consists of eight FITS files, i.e.
a real and imaginary part for each of the four Jones terms. The following substitutions
are performed to form up the eight filenames: $(corr) or $(xy) is replaced by
the Jones element label (e.g. "xx" or "rr"), $(reim) is replaced by "re" or
"im", $(realimag) is replaced by "real" or "imag". Uppercase variables are replaced
by uppercase values, e.g. $(REIM) by "RE" pr "IM". Use "unity" if you want to
apply a unity matrix for the E term (e.g. only want to do visibility derotations).
Correlation labels (XY or RL) are determined by reading the MS, but may be overridden
by the FITSFeed option. (Default: beam_$(corr)_$(reim).fits)'
required: false
FITSFeed:
info: If set, overrides correlation labels given by the measurement set.
required: false
FITSFeedSwap:
info: 'swap feed patterns (X to Y and R to L) (Default: False)'
required: false
dtype: bool
DtBeamMin:
info: 'change in minutes on which the beam is re-evaluated (Default: 5.0)'
required: false
dtype: float
FITSParAngleIncDeg:
info: 'increment in PA in degrees at which the beam is to be re-evaluated (on
top of DtBeamMin) (Default: 5.0)'
required: false
dtype: float
FITSLAxis:
info: 'L axis of FITS file. Minus sign indicates reverse coordinate convention.
(Default: -X)'
required: false
dtype: str
FITSMAxis:
info: 'M axis of FITS file. Minus sign indicates reverse coordinate convention.
(Default: Y)'
required: false
dtype: str
FITSVerbosity:
info: 'set to >0 to have verbose output from FITS interpolator classes. (Default:
0)'
required: false
dtype: int
FeedAngle:
info: 'offset feed angle to add to parallactic angle (Default: 0.0)'
required: false
dtype: float
ApplyPJones:
info: 'derotate visibility data (only when FITS beam is active and also time sampled).
If you have equatorial mounts this is not what you should be doing! (Default:
0)'
required: false
FlipVisibilityHands:
info: 'apply anti-diagonal matrix if FITS beam is enabled effectively swapping
X and Y or R and L and their respective hands (Default: 0)'
required: false
Freq:
BandMHz:
info: 'Gridding cube frequency step. If 0, --Freq-NBand is used instead. (Default:
0.0)'
required: false
dtype: float
FMinMHz:
info: 'Gridding cube frequency Min. If 0, is ignored. (Default: 0.0)'
required: false
dtype: float
FMaxMHz:
info: 'Gridding cube frequency Max. If 0, is ignored. (Default: 0.0)'
required: false
dtype: float
DegridBandMHz:
info: 'Degridding cube frequency step. If 0, --Freq-NDegridBand is used instead.
(Default: 0.0)'
required: false
dtype: float
NBand:
info: 'Number of image bands for gridding. (Default: 1)'
required: false
dtype: int
NDegridBand:
info: 'Number of image bands for degridding. 0 means degrid each channel. (Default:
0)'
required: false
dtype: int
DDESolutions:
DDSols:
info: Name of the DDE solution file
required: false
SolsDir:
info: Name of the directry of the DDE Solutions which contains <SolsDir>/<MSNames>/killMS.<SolsName>.sols.npz
required: false
GlobalNorm:
info: 'Option to normalise the Jones matrices (options: MeanAbs, MeanAbsAnt, BLBased
or SumBLBased). See code for more detail'
required: false
JonesNormList:
info: 'Deprecated? (Default: AP)'
required: false
JonesMode:
info: ' (Default: Full)'
required: false
DDModeGrid:
info: 'In the gridding step, apply Jones matrices Amplitude (A) or Phase (P) or
Amplitude&Phase (AP) (Default: AP)'
required: false
DDModeDeGrid:
info: 'In the degridding step, apply Jones matrices Amplitude (A) or Phase (P)
or Amplitude&Phase (AP) (Default: AP)'
required: false
ScaleAmpGrid:
info: 'Deprecated? (Default: 0)'
required: false
ScaleAmpDeGrid:
info: 'Deprecated? (Default: 0)'
required: false
CalibErr:
info: 'Deprecated? (Default: 10.0)'
required: false
Type:
info: 'Deprecated? (Default: Nearest)'
required: false
Scale:
info: 'Deprecated? (Default: 1.0)'
required: false
gamma:
info: 'Deprecated? (Default: 4.0)'
required: false
RestoreSub:
info: 'Deprecated? (Default: False)'
required: false
ReWeightSNR:
info: 'Deprecated? (Default: 0.0)'
required: false
PointingSolutions:
PointingSolsCSV:
info: Filename of CSV containing time-variable pointing solutions. None initializes
all antenna pointing offsets to 0, 0
required: false
InterpolationMode:
info: 'Interpolation mode (Default: LERP)'
required: false
Deconv:
Mode:
info: 'Deconvolution algorithm. (Default: HMP)'
required: false
MaxMajorIter:
info: 'Max number of major cycles. (Default: 20)'
required: false
dtype: int
MaxMinorIter:
info: 'Max number of (overall) minor cycle iterations (HMP, Hogbom). (Default:
20000)'
required: false
dtype: int
AllowNegative:
info: 'Allow negative components (HMP, Hogbom). (Default: True)'
required: false
dtype: bool
Gain:
info: 'Loop gain (HMP, Hogbom). (Default: 0.1)'
required: false
dtype: float
FluxThreshold:
info: 'Absolute flux threshold at which deconvolution is stopped (HMP, Hogbom,
SSD). (Default: 0.0)'
required: false
dtype: float
CycleFactor:
info: 'Cycle factor: used to set a minor cycle stopping threshold based on PSF
sidelobe level (HMP, Hogbom). Use 0 to disable, otherwise 2.5 is a reasonable
value, but may lead to very shallow minor cycle. (Default: 0.0)'
required: false
dtype: float
RMSFactor:
info: 'Set minor cycle stopping threshold to X*{residual RMS at start of major
cycle} (HMP, Hogbom, SSD). (Default: 3.0)'
required: false
dtype: float
PeakFactor:
info: 'Set minor cycle stopping threshold to X*{peak residual at start of major
cycle} (HMP, Hogbom, SSD). (Default: 0.01)'
required: false
dtype: float
PrevPeakFactor:
info: 'Set minor cycle stopping threshold to X*{peak residual at end of previous
major cycle} (HMP). (Default: 0.0)'
required: false
dtype: float
NumRMSSamples:
info: 'How many samples to draw for RMS computation. Use 0 to use all pixels (most
precise). (Default: 10000)'
required: false
dtype: int
ApproximatePSF:
info: 'when --Comp-Sparsification is on, use approximate (i.e. central facet)
PSF for cleaning while operating above the given sparsification factor (SF).
This speeds up HMP reinitialization in major cycles. A value of 1-10 is sensible.
Set to 0 to always use precise per-facet PSF. (Default: 0)'
required: false
PSFBox:
info: 'determines the size of the PSF subtraction box used in CLEAN-style deconvolution
(if appropriate). Use "auto" (or "sidelobe") for a Clark-CLEAN-style box taken
out to a certain sidelobe (faster). Use "full" to subtract the full PSF, Hogbom-style
(more accurate, can also combine with --Image-PSFOversize for maximum accuracy).
Use an integer number to set an explicit box radius, in pixels. (HMP) (Default:
auto)'
required: false
Mask:
External:
info: External clean mask image (FITS format).
required: false
Auto:
info: 'Do automatic masking (Default: False)'
required: false
SigTh:
info: 'set Threshold (in sigma) for automatic masking (Default: 10)'
required: false
FluxImageType:
info: 'If Auto enabled, does the cut of SigTh either on the ModelConv or the Restored
(Default: ModelConv)'
required: false
Noise:
MinStats:
info: 'The parameters to compute the noise-map-based mask for step i+1 from the
residual image at step i. Should be [box_size,box_step] (Default: [60, 2])'
required: false
BrutalHMP:
info: 'If noise map is computed, this option enabled, it first computes an image
plane deconvolution with a high gain value, and compute the noise-map-based
mask using the brutal-restored image (Default: True)'
required: false
HMP:
Alpha:
info: 'List of alphas to fit. (Default: [-1.0, 1.0, 11])'
required: false
Scales:
info: 'List of scales to use. (Default: [0])'
required: false
Ratios:
info: '@cyriltasse please document (Default: [''''])'
required: false
NTheta:
info: 'Number of PA steps to use. (Default: 6)'
required: false
SolverMode:
info: 'Solver mode: pseudoinverse, or non-negative least squares. (Default: PI)'
required: false
AllowResidIncrease:
info: 'Allow the maximum residual to increase by at most this much relative to
the lowest residual, before bailing out due to divergence. (Default: 0.1)'
required: false
MajorStallThreshold:
info: 'Major cycle stall threshold. If the residual at the beginning of a major
cycle is above X*residual at the beginning of the previous major cycle, then
we consider the deconvolution stalled and bail out. (Default: 0.8)'
required: false
dtype: float
Taper:
info: 'Weighting taper size for HMP fit. If 0, determined automatically. (Default:
0)'
required: false
dtype: int
Support:
info: 'Basis function support size. If 0, determined automatically. (Default:
0)'
required: false
dtype: int
PeakWeightImage:
info: weigh the peak finding by given image
required: false
Kappa:
info: 'Regularization parameter. If stddev of per-alpha solutions exceeds the
maximum solution amplitude divided by Kappa, forces a fully-regularized solution.
Use 0 for no such regularization. (Default: 0.0)'
required: false
dtype: float
OuterSpaceTh:
info: ' (Default: 2.0)'
required: false
FractionRandomPeak:
info: ''
required: false
Hogbom:
PolyFitOrder:
info: 'polynomial order for frequency fitting (Default: 4)'
required: false
WSCMS:
NumFreqBasisFuncs:
info: 'number of basis functions to use for the fit to the frequency axis (Default:
4)'
required: false
MultiScale:
info: 'whether to use multi-scale or not (recommended to use Hogbom if not using
multi-scale) (Default: True)'
required: false
MultiScaleBias:
info: 'scale bias parameter (smaller values give more weight to larger scales)
(Default: 0.55)'
required: false
ScaleBasis:
info: 'the kind of scale kernels to use (only Gauss available for now) (Default:
Gauss)'
required: false
Scales:
info: Scale sizes in pixels/FWHM eg. [0, 4, 8, 16] (if None determined automatically)
required: false
MaxScale:
info: 'The maximum FWHM of scale functions in pixels (Default: 100)'
required: false
NSubMinorIter:
info: 'Number of iterations for the sub minor loop (Default: 250)'
required: false
SubMinorPeakFact:
info: 'Peak factor of sub minor loop (Default: 0.85)'
required: false
MinorStallThreshold:
info: 'if the peak in the minor cycle decreases by less than this fraction it
has stalled and we go back to the major cycle (Default: 1e-07)'
required: false
MinorDivergenceFactor:
info: 'if the peak flux increases by more than this fraction between minor cycles
then it has diverged and we go back to a major cycle (Default: 1.3)'
required: false
AutoMask:
info: 'whether to use scale dependent auto-masking (Default: True)'
required: false
AutoMaskThreshold:
info: Threshold at which the scale dependent mask should be fixed.
required: false
AutoMaskRMSFactor:
info: 'Default multiple of RMS at which to start AutoMasking in case no (Default:
3)'
required: false
CacheSize:
info: 'the number of items to keep in the cache dict before spilling over to disk
(Default: 3)'
required: false
Montblanc:
TensorflowServerTarget:
info: URL for the TensorflowServer, e.g. grpc://tensorflow.server.com:8888/
required: false
dtype: str
LogFile:
info: None to dump as Output-Name.montblanc.log, otherwise user-specified filename
required: false
MemoryBudget:
info: 'Predictor memory budget in GiB (Default: 4.0)'
required: false
dtype: float
LogLevel:
info: 'Log level to write to console, rest of the messages goes to log file (Default:
WARNING)'
required: false
dtype: str
SolverDType:
info: 'Data type used in solver, (Default: double)'
required: false
dtype: str
DriverVersion:
info: 'Backend to use, (Default: tf)'
required: false
dtype: str
SSDClean:
Parallel:
info: 'Enable parallel mode. (Default: True)'
required: false
dtype: bool
IslandDeconvMode:
info: 'Moresane, GA, Sasir, ... (Default: GA)'
required: false
SSDSolvePars:
info: ' (Default: [''S'', ''Alpha''])'
required: false
SSDCostFunc:
info: ' (Default: [''Chi2'', ''MinFlux''])'
required: false
BICFactor:
info: ' (Default: 0.0)'
required: false
ArtifactRobust:
info: ' (Default: False)'
required: false
ConvFFTSwitch:
info: ' (Default: 1000)'
required: false
NEnlargePars:
info: ' (Default: 0)'
required: false
NEnlargeData:
info: ' (Default: 2)'
required: false
RestoreMetroSwitch:
info: ' (Default: 0)'
required: false
MinMaxGroupDistance:
info: ' (Default: [10, 50])'
required: false
MaxIslandSize:
info: ' (Default: 0)'
required: false
InitType:
info: ' (Default: HMP)'
required: false
SSD2:
PolyFreqOrder:
info: 'Add Polyi to --SSDClean-SSDSolvePars. (Default: 2)'
required: false
SolvePars:
info: ' (Default: [''Poly''])'
required: false
InitType:
info: ' (Default: [''HMP'', ''MultiSlice:Orieux''])'
required: false
NLastCyclesDeconvAll:
info: 'This parameter sets how many of the last cycles will deconvolve all islands.
If set to 0, SSD2 will use --Deconv-CycleFactor, --Deconv-PeakFactor, --Deconv-RMSFactor
to determine threshold above which islands are reestimated. If set to 2, in
the last 2 major cycle all islands are estimated. If -1: Always deconv all islands
regardless of the cycle number (Default: 1)'
required: false
MultiSliceDeconv:
Type:
info: 'MORESANE, Orieux, etc (Default: MORESANE)'
required: false
PolyFitOrder:
info: ' (Default: 2)'
required: false
GAClean:
NSourceKin:
info: ' (Default: 50)'
required: false
NMaxGen:
info: ' (Default: 50)'
required: false
MinSizeInit:
info: ' (Default: 10)'
required: false
AlphaInitHMP:
info: ' (Default: [-4.0, 1.0, 6])'
required: false
ScalesInitHMP:
info: ' (Default: [0, 1, 2, 4, 8, 16, 24, 32])'
required: false
GainInitHMP:
info: ' (Default: 0.1)'
required: false
RatiosInitHMP:
info: ' (Default: [''''])'
required: false
NThetaInitHMP:
info: ' (Default: 4)'
required: false
MaxMinorIterInitHMP:
info: ' (Default: 10000)'
required: false
AllowNegativeInitHMP:
info: ' (Default: False)'
required: false
RMSFactorInitHMP:
info: ' (Default: 3.0)'
required: false
ParallelInitHMP:
info: 'run island init in parallel. Serial mode may reduce RAM pressure, and could
be useful for debugging. (Default: True)'
required: false
dtype: bool
NCPU:
info: 'number of cores to use for parallel fitness calculations (in large-island
mode). Default of 0 means use as many as specified by --Parallel-NCPU. If you
find yourself running out of memory here, you might want to specify a small
number of cores for this step. (Default: 0)'
required: false
dtype: int
MORESANE:
NMajorIter:
info: 'Maximum number of iterations allowed in the major loop. Exit condition.
(Default: 200)'
required: false
NMinorIter:
info: 'Maximum number of iterations allowed in the minor loop. Serves as an exit
condition when the SNR is does not reach a maximum. (Default: 200)'
required: false
Gain:
info: 'Loop gain for the deconvolution. (Default: 0.1)'
required: false
ForcePositive:
info: 'Boolean specifier for whether or not a model must be strictly positive.
(Default: True)'
required: false
SigmaCutLevel:
info: 'Number of sigma at which thresholding is to be performed. (Default: 1)'
required: false
Log:
Memory:
info: 'log memory use (Default: False)'
required: false
dtype: bool
Boring:
info: 'disable progress bars and other pretty console output (Default: False)'
required: false
dtype: bool
Append:
info: 'append to log file if it exists (default truncates) (Default: False)'
required: false
dtype: bool
Debug:
PauseWorkers:
info: 'Pauses worker processes upon launch (with SIGSTOP). Useful to attach gdb
to workers. (Default: False)'
required: false
dtype: bool
FacetPhaseShift:
info: 'Shift in facet coordinates in arcseconds for l and m (this phase steers
the sky over the image plane). (Default: [0.0, 0.0])'
required: false
PrintMinorCycleRMS:
info: 'Compute and print RMS in minor cycle iterations. (Default: False)'
required: false
dtype: bool
DumpCleanSolutions:
info: 'Dump intermediate minor cycle solutions to a file. Use 0 or 1, or give
an explicit list of things to dump (Default: 0)'
required: false
DumpCleanPostageStamps:
info: Also dump postage stamps when cleaning within a radius R of X,Y. Implies
--Debug-DumpCleanSolutions.
required: false
CleanStallThreshold:
info: 'Throw an exception when a fitted CLEAN component is below this threshold
in flux. Useful for debugging. (Default: 0.0)'
required: false
dtype: float
MemoryGreedy:
info: 'Enable memory-greedy mode. Retain certain shared arrays in RAM as long
as possible. (Default: True)'
required: false
dtype: bool
APPVerbose:
info: 'Verbosity level for multiprocessing. (Default: 0)'
required: false
dtype: int
Pdb:
info: 'Invoke pdb on unexpected error conditions (rather than exit). If set to
''auto'', then invoke pdb only if --Log-Boring is 0. (Default: auto)'
required: false
Misc:
RandomSeed:
info: seed random number generator with explicit seed, if given. Useful for reproducibility
of the random-based optimizations (sparsification, etc.).
required: false
ParsetVersion:
info: 'parset version number, for migration purposes. Can''t be specified on command
line. (Default: 0.2)'
required: false
ConserveMemory:
info: 'if true, tries to minimize memory use at possible expense of runtime. (Default:
0)'
required: false
IgnoreDeprecationMarking:
info: 'if true, tries to run deprecated modes. Currently this means that deconvolution
machines are reset and reinitialized each major cycle. (Default: False)'
required: false
dtype: bool