Skip to content

Commit ec5f27c

Browse files
committed
add parameter info
1 parent 9d5d987 commit ec5f27c

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

cultcargo/tigger-convert.yml

+29-3
Original file line numberDiff line numberDiff line change
@@ -20,53 +20,79 @@ cabs:
2020
policies:
2121
positional: yes
2222
force:
23+
info: Overwrite output
2324
dtype: bool
2425
default: yes
2526
type:
27+
info: Input model type
2628
dtype: str
2729
choices: [Tigger, ASCII, BBS, NEWSTAR, AIPSCC, APSCCFITS, Gaul, auto]
2830
default: auto
31+
output-type:
32+
info: Output model type
33+
choices: [Tigger, ASCII, BBS, NEWSTAR, AIPSCC, APSCCFITS, Gaul, auto]
34+
default: auto
2935
append:
30-
dtype: File
36+
info: Append another model to input model. May be given multiple times.
37+
dtype: List[File]
38+
policies:
39+
repeat: repeat
3140
append-type:
41+
info: Append model type
3242
dtype: str
3343
choices: [Tigger, ASCII, BBS, NEWSTAR, AIPSCC, APSCCFITS, Gaul, auto]
3444
default: auto
3545
format:
46+
info: Input format, for ASCII or BBS tables. For BBS tables, the default format is specified in the file header.
3647
dtype: str
3748
append-format:
49+
info: Append model format
3850
dtype: str
3951
output-format:
52+
info: Output model format
4053
dtype: str
4154
app-to-int:
55+
info: Treat fluxes as apparent, and rescale them into intrinsic using the supplied primary beam model (see --primary-beam option).
4256
dtype: bool
4357
int-to-app:
58+
info: Treat fluxes as intrinsic, and rescale them into apparent using the supplied primary beam model (see --primary-beam option).
4459
dtype: bool
4560
primary-beam:
61+
info: "Apply a primary beam expression to estimate apparent fluxes. Any valid Python expression using the variables 'r' and 'fq' is accepted. Use 'refresh' to re-estimate fluxes using the current expression. Example (for the WSRT-like 25m dish PB): cos(min(65*fq*1e-9*r,1.0881))**6"
4662
dtype: str
4763
fits-l-axis:
64+
info: CTYPE for L axis in the FITS PB file. Note that our internal L points East (increasing RA), if the FITS beam axis points the opposite way, prefix the CTYPE with a '-'' character
4865
dtype: str
4966
default: X
5067
fits-m-axis:
68+
info: CTYPE for M axis in the FITS PB file. Note that our internal M points North (increasing Dec), if the FITS beam axis points the opposite way, prefix the CTYPE with a '-'' character
5169
dtype: str
5270
default: Y
5371
beam-clip:
72+
info: when using a FITS beam, clip (power) beam gains at this level to keep intrinsic source fluxes from blowing up. Sources below this beamgain will be tagged 'nobeam'.
5473
dtype: float
5574
default: 0.001
5675
beam-spi:
76+
info: perform a spectral index fit to each source based on a frequency dependent FITS beam, requires --primary-beam option to be used with a FITS file. Apply this spectral index to LSM sources. Must supply a bandwidth (in MHz) (centred on --beam-freq) over which the beam spi is estimated.
5777
dtype: float
5878
beam-diag:
79+
info: Use diagonal Jones terms only for beam mode
5980
dtype: bool
6081
pa-from-ms:
61-
dtype: MS
82+
info: Rotate the primary beam pattern through a range of parallactic angles as given by the MS and field ID (default 0) and take the average over time. This is more accurate than --pa-range.
83+
dtype: str
84+
metavar: "MS1[:FIELD1],MS2:[FIELD2],..."
6285
pa:
86+
info: Rotate the primary beam pattern through a parallactic angle (in degrees)
6387
dtype: float
6488
pa-range:
89+
info: Rotate the primary beam pattern through a range of parallactic angles (in degrees) and use the average value over PA
6590
dtype: str
6691
linear-pol:
92+
info: Use XY basis correlations for beam filenames and Mueller matrices. Default is RL
6793
dtype: bool
68-
default: yes
6994
center:
95+
info: Override coordinates of the nominal field center specified in the input model.
7096
dtype: str
7197
outputs:
7298
output-model:

0 commit comments

Comments
 (0)