Commits

Ville Suoranta authored decc877adbd Merge
Merge pull request #926 in CASA/casa from CAS-12302 to master

* commit '5b05970fabccaae4513404f703467b0781d54dc6': Updates_final Updates_gaincal_and_clean XML_pull_corrections Fix accum test failure Revert to master version of flagdata.xml Reset flagmanager Updates XML v4 XML updates 3 Updates XML 4 Updates XML 3 updated XML files XML updates accor - bandpass

gcwrap/tasks/accor.xml

Modified
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <?xml-stylesheet type="text/xsl" ?>
3 3 <casaxml xmlns="http://casa.nrao.edu/schema/psetTypes.html"
4 4 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5 5 xsi:schemaLocation="http://casa.nrao.edu/schema/casa.xsd
6 6 file:///opt/casa/code/xmlcasa/xml/casa.xsd">
7 7
8 8 <task type="function" name="accor" category="calibration" visibility="experimental">
9 9 <shortdescription>Normalize visibilities based on auto-correlations</shortdescription>
10 10 <description>
11 11 Determines the amplitude corrections neede due to errors in sampler
12 -thresholds using measurements of auto-correlation spectra. This
12 +thresholds using measurements of auto-correlation spectra. This
13 13 correction is typically requiered for data correlated with the DiFX
14 14 correlator (such as VLBA data). Other correlators (such as the SFXC
15 15 correlator used to correlate EVN data at JIVE) already apply this
16 16 correction at the correlator. In this case, running this task is not
17 17 necessary.
18 18 </description>
19 19 <input>
20 20 <param type="string" name="vis" mustexist="true">
21 - <description>Name of input visibility file</description>
21 +<shortdescription>Name of input visibility file</shortdescription>
22 +<description>Name of input visibility file
23 + default: none
24 +
25 + example: vis='ngc5921.ms'
26 +</description>
22 27 <value></value>
23 28 </param>
24 29
25 30 <param type="string" name="caltable">
26 - <description>Name of output gain calibration table</description>
31 +<shortdescription>Name of output gain calibration table</shortdescription>
32 +<description>Name of output gain calibration table
33 + default: none
34 +
35 + example: caltable='ngc5921.gcal'
36 +</description>
27 37 <value></value>
28 38 </param>
29 39
30 40 <param type="string" name="field">
31 - <description>Select field using field id(s) or field name(s)</description>
41 +<shortdescription>Select field using field id(s) or field name(s)</shortdescription>
42 +<description>Select field using field id(s) or field name(s)
43 + default: '' --> all fields
44 +
45 + Use 'go listobs' to obtain the list id's or
46 + names. If field string is a non-negative integer,
47 + it is assumed a field index, otherwise, it is
48 + assumed a field name.
49 +
50 + Examples:
51 + field='0~2'; field ids 0,1,2
52 + field='0,4,5~7'; field ids 0,4,5,6,7
53 + field='3C286,3C295'; field named 3C286 and
54 + 3C295
55 + field = '3,4C*'; field id 3, all names
56 + starting with 4C
57 +
58 + Note: do not forget to include the flux density
59 + calibrator if you have one!
60 +</description>
32 61 <value></value>
33 62 </param>
34 63
35 64 <param type="string" name="spw">
36 - <description>Select spectral window/channels</description>
65 +<shortdescription>Select spectral window/channels</shortdescription>
66 +<description>Select spectral window/channels
67 +
68 + Examples:
69 + spw='0~2,4'; spectral windows 0,1,2,4 (all
70 + channels)
71 + spw='&lt;2'; spectral windows less than 2
72 + (i.e. 0,1)
73 + spw='0:5~61'; spw 0, channels 5 to 61,
74 + INCLUSIVE
75 + spw='*:5~61'; all spw with channels 5 to 61
76 + spw='0,10,3:3~45'; spw 0,10 all channels, spw
77 + 3, channels 3 to 45.
78 + spw='0~2:2~6'; spw 0,1,2 with channels 2
79 + through 6 in each.
80 + spw='0:0~10;15~60'; spectral window 0 with
81 + channels 0-10,15-60. (NOTE ';' to separate
82 + channel selections)
83 + spw='0:0~10^2,1:20~30^5'; spw 0, channels
84 + 0,2,4,6,8,10, spw 1, channels 20,25,30
85 + type 'help par.selection' for more examples.
86 +</description>
37 87 <value></value>
38 88 </param>
39 89
40 90 <param type="string" name="intent">
41 - <description>Select observing intent</description>
91 +<shortdescription>Select observing intent</shortdescription>
92 +<description>Select observing intent
93 + default: '' (no selection by intent)
94 +
95 + Example: intent='*BANDPASS*' (selects data
96 + labelled with BANDPASS intent)
97 +</description>
42 98 <value></value>
43 99 </param>
44 100
45 101 <param type="bool" name="selectdata">
46 - <description>Other data selection parameters</description>
102 +<shortdescription>Other data selection parameters</shortdescription>
103 +<description>Other data selection parameters
104 + default: True (Must set selectdata=True to select
105 + other selection parameters.)
106 +</description>
47 107 <value>True</value>
48 108 </param>
49 109
50 110 <param type="string" name="timerange" subparam="true">
51 - <description>Select data based on time range</description>
111 +<shortdescription>Select data based on time range</shortdescription>
112 +<description>Select data based on time range
113 + Subparameter of selectdata=True
114 + default = '' (all)
115 +
116 + Examples:
117 + timerange =
118 + 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
119 + (Note: if YYYY/MM/DD is missing date defaults
120 + to first day in data set.)
121 + timerange='09:14:0~09:54:0' picks 40 min on
122 + first day
123 + timerange= '25:00:00~27:30:00' picks 1 hr to 3
124 + hr 30min on NEXT day
125 + timerange='09:44:00' pick data within one
126 + integration of time
127 + timerange='>10:24:00' data after this time
128 +</description>
52 129 <value></value>
53 130 </param>
54 131
55 132 <param type="string" name="antenna" subparam="true">
56 - <description>Select data based on antenna/baseline</description>
133 +<shortdescription>Select data based on antenna/baseline</shortdescription>
134 +<description>Select data based on antenna/baseline
135 + Subparameter of selectdata=True
136 + default: '' (all)
137 +
138 + Examples:
139 + antenna='5&amp;6'; baseline between antenna
140 + index 5 and index 6.
141 + antenna='VA05&amp;VA06'; baseline between VLA
142 + antenna 5 and 6.
143 + antenna='5&amp;6;7&amp;8'; baselines with
144 + indices 5-6 and 7-8
145 + antenna='5'; all baselines with antenna index
146 + 5
147 + antenna='05'; all baselines with antenna
148 + number 05 (VLA old name)
149 + antenna='5,6,10'; all baselines with antennas
150 + 5,6,10 index numbers
151 +
152 + Note: just for antenna selection, an integer (or
153 + integer list) is converted to a string and
154 + matched against the antenna 'name' first. Only if
155 + that fails, the integer is matched with the
156 + antenna ID. The latter is the case for most
157 + observatories, where the antenna name is not
158 + strictly an integer.
159 + </description>
57 160 <value></value>
58 161 </param>
59 162
60 163 <param type="string" name="scan" subparam="true">
61 - <description>Scan number range</description>
164 +<shortdescription>Scan number range</shortdescription>
165 +<description>Scan number range
166 + Subparameter of selectdata=True
167 + default: '' = all
168 +
169 + Check 'go listobs' to insure the scan numbers are
170 + in order.
171 +</description>
62 172 <value></value>
63 173 </param>
64 174
65 175 <param type="any" name="observation" subparam="true">
66 - <description>Select by observation ID(s)</description>
176 +<shortdescription>Select by observation ID(s)</shortdescription>
177 +<description>Select by observation ID(s)
178 + Subparameter of selectdata=True
179 + default: '' = all
180 +
181 + Example: observation='0~2,4'
182 +</description>
67 183 <any type="variant" limittypes="string int"/>
68 184 <value type="string"></value>
69 185 </param>
70 186
71 187 <param type="string" name="msselect" subparam="true">
72 - <description>Optional complex data selection (ignore for now)</description>
188 +<shortdescription>Optional complex data selection (ignore for now)</shortdescription>
189 +<description>Optional complex data selection (ignore for now)
190 +</description>
73 191 <value></value>
74 192 </param>
75 193
76 194 <param type="any" name="solint">
77 - <description>Solution interval: egs. \'inf\', \'60s\' (see help)</description>
195 +<shortdescription>Solution interval: egs. \'inf\', \'60s\' (see help)</shortdescription>
196 +<description>Solution interval (units optional)
197 + default: 'inf' (~infinite, up to boundaries
198 + controlled by combine)
199 + Options: 'inf' (~infinite), 'int' (per
200 + integration), any float or integer value with or
201 + without units
202 +
203 + Examples: solint='1min'; solint='60s';
204 + solint=60 --> 1 minute
205 + solint='0s'; solint=0; solint='int' --> per
206 + integration
207 + solint-'-1s'; solint='inf' --> ~infinite, up
208 + to boundaries -interacts with combine
209 +</description>
78 210 <any type="variant"/>
79 211 <value type="string">inf</value>
80 212 </param>
81 213
82 214 <param type="string" name="combine">
83 - <description>Data axes which to combine for solve (obs, scan, spw, and/or field)</description>
215 +<shortdescription>Data axes which to combine for solve (obs, scan, spw, and/or field)</shortdescription>
216 +<description>Data axes which to combine for solve
217 + default: '' (solutions will break at obs, scan,
218 + field, and spw)
219 + Options: '','obs','scan','spw',field', or any
220 + comma-separated combination in a single string
221 +
222 + For gaintype='K', if combine includes 'spw',
223 + multi-band delays will be determined; otherwise,
224 + (per-spw) single-band delays will be determined.
225 +
226 + Example: combine='scan,spw' (extend solutions
227 + over scan boundaries)
228 +</description>
84 229 <value></value>
85 230 </param>
86 231
87 232 <param type="bool" name="append">
88 - <description>Append solutions to the (existing) table</description>
233 +<shortdescription>Append solutions to the (existing) table</shortdescription>
234 +<description>Append solutions to the (existing) table
235 + default: False (overwrite existing table or make
236 + new table)
237 +
238 + Appended solutions must be derived from the same
239 + MS as the existing caltable, and solution spws
240 + must have the same meta-info (according to spw
241 + selection and solint) or be non-overlapping.
242 +</description>
89 243 <value>False</value>
90 244 </param>
91 245
92 246 <param type="bool" name="docallib" >
93 - <description>Use callib or traditional cal apply parameters</description>
247 +<shortdescription>Use callib or traditional cal apply parameters</shortdescription>
248 +<description>Control means of specifying the caltables
249 + default: False --> Use gaintable, gainfield,
250 + interp, spwmap, calwt.
251 +
252 + If True, specify a file containing cal library in
253 + callib
254 +</description>
94 255 <value>False</value>
95 256 </param>
96 257
97 258 <param type="string" name="callib" subparam="true" >
98 - <description>Cal Library filename</description>
259 +<shortdescription>Cal Library filename</shortdescription>
260 +<description>Cal Library filename
261 + Subparameter of callib=True
262 +
263 + If docallib=True, specify a file containing cal
264 + library directives
265 +</description>
99 266 <value type="string"></value>
100 267 </param>
101 268
102 269 <param type="stringArray" name="gaintable" subparam="true">
103 - <description>Gain calibration table(s) to apply on the fly</description>
270 +<shortdescription>Gain calibration table(s) to apply on the fly</shortdescription>
271 +<description>Gain calibration table(s) to apply on the fly
272 + Subparameter of callib=False
273 + default: '' (none)
274 +
275 + Examples: gaintable='ngc5921.gcal'
276 + gaintable=['ngc5921.ampcal','ngc5921.phcal']
277 +</description>
104 278 <value></value>
105 279 </param>
106 280
107 281 <param type="stringArray" name="gainfield" subparam="true">
108 - <description>Select a subset of calibrators from gaintable(s)</description>
282 +<shortdescription>Select a subset of calibrators from gaintable(s)</shortdescription>
283 +<description>Select a subset of calibrators from gaintable(s)
284 + Subparameter of callib=False
285 + default:'' --> all sources in table
286 +
287 + gaintable='nearest' --> nearest (on sky)
288 + available field in table. Otherwise, same syntax
289 + as field
290 +
291 + Examples:
292 + gainfield='0~2,5' means use fields 0,1,2,5
293 + from gaintable
294 + gainfield=['0~3','4~6'] means use field 0
295 + through 3 from first gain file, field 4
296 + through 6 for second.
297 +</description>
109 298 <value></value>
110 299 </param>
111 300
112 301 <param type="stringArray" name="interp" subparam="true">
113 - <description>Temporal interpolation for each gaintable (''=linear)</description>
302 +<shortdescription>Temporal interpolation for each gaintable (''=linear)</shortdescription>
303 +<description>Interpolation type (in time[,freq]) to use for each
304 +gaintable.
305 + Subparameter of callib=False
306 + default: '' --> 'linear,linear' for all gaintable(s)
307 + Options: Time: 'nearest', 'linear'. Freq:
308 + 'nearest', 'linear', 'cubic', 'spline'
309 +
310 + When frequency interpolation is relevant (B, Df,
311 + Xf), separate time-dependent and freq-dependent
312 + interp types with a comma (freq _after_ the
313 + comma). Specifications for frequency are ignored
314 + when the calibration table has no
315 + channel-dependence. Time-dependent interp options
316 + ending in 'PD' enable a "phase delay" correction
317 + per spw for non-channel-dependent calibration
318 + types.
319 + For multi-obsId datasets, 'perobs' can be
320 + appended to the time-dependent interpolation
321 + specification to enforce obsId boundaries when
322 + interpolating in time.
323 +
324 + Examples:
325 + interp='nearest' (in time, freq-dep will be
326 + linear, if relevant)
327 + interp='linear,cubic' (linear in time, cubic
328 + in freq)
329 + interp='linearperobs,spline' (linear in time
330 + per obsId, spline in freq)
331 + interp=',spline' (spline in freq; linear in
332 + time by default)
333 + interp=['nearest,spline','linear'] (for
334 + multiple gaintables)
335 +</description>
114 336 <value></value>
115 337 </param>
116 338
117 339 <param type="intArray" name="spwmap" subparam="true">
118 - <description>Spectral windows combinations to form for gaintables(s)</description>
340 +<shortdescription>Spectral windows combinations to form for gaintables(s)</shortdescription>
341 +<description>Spectral windows combinations to form for gaintables(s)
342 + Subparameter of callib=False
343 + default: [] (apply solutions from each spw to
344 + that spw only)
345 +
346 + Examples:
347 + spwmap=[0,0,1,1] means apply the caltable
348 + solutions from spw = 0 to the spw 0,1 and spw
349 + 1 to spw 2,3.
350 + spwmap=[[0,0,1,1],[0,1,0,1]]
351 +</description>
119 352 <value></value>
120 353 </param>
121 354
122 355 <constraints>
123 356 <when param="selectdata">
124 357 <equals type="bool" value="True">
125 358 <default param="timerange"><value type="string"/></default>
126 359 <default param="antenna"><value type="string"/></default>
127 360 <default param="scan"><value type="string"/></default>
128 361 <default param="observation"><value type="string"/></default>
137 370 <default param="interp"><value type="stringArray"/></default>
138 371 <default param="spwmap"><value type="intArray"/></default>
139 372 </equals>
140 373 <equals type="bool" value="True">
141 374 <default param="callib"><value type="string"/></default>
142 375 </equals>
143 376 </when>
144 377 </constraints>
145 378 </input>
146 379 <example>
380 +For more information, see the task pages of accor in CASA Docs:
147 381
148 - Determines the amplitude corrections neede due to errors in sampler
149 - thresholds using measurements of auto-correlation spectra. This
150 - correction is typically requiered for data correlated with the DiFX
151 - correlator (such as VLBA data). Other correlators (such as the SFXC
152 - correlator used to correlate EVN data at JIVE) already apply this
153 - correction at the correlator. In this case, running this task is not
154 - necessary.
155 -
156 - Keyword arguments:
157 - vis -- Name of input visibility file
158 - default: none; example: vis='ngc5921.ms'
159 - caltable -- Name of output gain calibration table
160 - default: none; example: caltable='ngc5921.gcal'
161 -
162 - --- Data Selection (see help par.selectdata for more detailed information)
163 -
164 - field -- Select field using field id(s) or field name(s).
165 - ['go listobs' to obtain the list id's or names]
166 - default: ''=all fields
167 - If field string is a non-negative integer, it is assumed a
168 - field index, otherwise, it is assumed a field name
169 - field='0~2'; field ids 0,1,2
170 - field='0,4,5~7'; field ids 0,4,5,6,7
171 - field='3C286,3C295'; field named 3C286 and 3C295
172 - field = '3,4C*'; field id 3, all names starting with 4C
173 - DON'T FORGET TO INCLUDE THE FLUX DENSITY CALIBRATOR IF YOU HAVE ONE
174 - spw -- Select spectral window/channels
175 - type 'help par.selection' for more examples.
176 - spw='0~2,4'; spectral windows 0,1,2,4 (all channels)
177 - spw='&lt;2'; spectral windows less than 2 (i.e. 0,1)
178 - spw='0:5~61'; spw 0, channels 5 to 61, INCLUSIVE
179 - spw='*:5~61'; all spw with channels 5 to 61
180 - spw='0,10,3:3~45'; spw 0,10 all channels, spw 3, channels 3 to 45.
181 - spw='0~2:2~6'; spw 0,1,2 with channels 2 through 6 in each.
182 - spw='0:0~10;15~60'; spectral window 0 with channels 0-10,15-60
183 - NOTE ';' to separate channel selections
184 - spw='0:0~10^2,1:20~30^5'; spw 0, channels 0,2,4,6,8,10,
185 - spw 1, channels 20,25,30
186 - intent -- Select observing intent
187 - default: '' (no selection by intent)
188 - intent='*BANDPASS*' (selects data labelled with
189 - BANDPASS intent)
190 - selectdata -- Other data selection parameters
191 - default: True
192 -
193 - Must set selectdata=True to use the following selections:
194 -
195 - timerange -- Select data based on time range:
196 - default = '' (all); examples,
197 - timerange = 'YYYY/MM/DD/hh:mm:ss~YYYY/MM/DD/hh:mm:ss'
198 - Note: if YYYY/MM/DD is missing date defaults to first day in data set
199 - timerange='09:14:0~09:54:0' picks 40 min on first day
200 - timerange= '25:00:00~27:30:00' picks 1 hr to 3 hr 30min on NEXT day
201 - timerange='09:44:00' pick data within one integration of time
202 - timerange='&gt;10:24:00' data after this time
203 - antenna -- Select data based on antenna/baseline
204 - default: '' (all)
205 - If antenna string is a non-negative integer, it is assumed an
206 - antenna index, otherwise, it is assumed as an antenna name
207 - antenna='5&amp;6'; baseline between antenna index 5 and index 6.
208 - antenna='VA05&amp;VA06'; baseline between VLA antenna 5 and 6.
209 - antenna='5&amp;6;7&amp;8'; baselines with indices 5-6 and 7-8
210 - antenna='5'; all baselines with antenna index 5
211 - antenna='05'; all baselines with antenna number 05 (VLA old name)
212 - antenna='5,6,10'; all baselines with antennas 5,6,10 index numbers
213 - scan -- Scan number range.
214 - Check 'go listobs' to insure the scan numbers are in order.
215 - observation -- Observation ID(s).
216 - default: '' = all
217 - example: '0~2,4'
218 - msselect -- Optional complex data selection (ignore for now)
219 -
220 - --- Solution parameters
221 - solint -- Solution interval (units optional)
222 - default: 'inf' (~infinite, up to boundaries controlled by combine);
223 - Options: 'inf' (~infinite),
224 - 'int' (per integration)
225 - any float or integer value with or without units
226 - examples: solint='1min'; solint='60s'; solint=60 --> 1 minute
227 - solint='0s'; solint=0; solint='int' --> per integration
228 - solint-'-1s'; solint='inf' --> ~infinite, up to boundaries
229 - interacts with combine
230 - combine -- Data axes to combine for solving
231 - default: '' --&gt; solutions will break at obs, scan, field, and spw
232 - boundaries
233 - Options: '','obs','scan','spw',field', or any comma-separated
234 - combination in a single string
235 - For gaintype='K', if combine includes 'spw', multi-band
236 - delays will be determined; otherwise, (per-spw)
237 - single-band delays will be determined.
238 - example: combine='scan,spw' --&gt; extend solutions over scan boundaries
239 - (up to the solint), and combine spws for solving
240 - append -- Append solutions to the (existing) table. Appended solutions
241 - must be derived from the same MS as the existing
242 - caltable, and solution spws must have the same
243 - meta-info (according to spw selection and solint)
244 - or be non-overlapping.
245 - default: False; overwrite existing table or make new table
246 -
247 - --- Other calibrations to apply on the fly before determining accor solution
248 -
249 - docallib -- Control means of specifying the caltables:
250 - default: False ==&gt; Use gaintable,gainfield,interp,spwmap,calwt
251 - If True, specify a file containing cal library in callib
252 - callib -- If docallib=True, specify a file containing cal
253 - library directives
254 -
255 - gaintable -- Gain calibration table(s) to apply
256 - default: '' (none);
257 - examples: gaintable='ngc5921.gcal'
258 - gaintable=['ngc5921.ampcal','ngc5921.phcal']
259 - gainfield -- Select a subset of calibrators from gaintable(s) to apply
260 - default:'' ==&gt; all sources in table;
261 - 'nearest' ==&gt; nearest (on sky) available field in table
262 - otherwise, same syntax as field
263 - example: gainfield='0~2,5' means use fields 0,1,2,5 from gaintable
264 - gainfield=['0~3','4~6'] means use field 0 through 3
265 - from first gain file, field 4 through 6 for second.
266 - interp -- Interpolation type (in time[,freq]) to use for each gaintable.
267 - When frequency interpolation is relevant (B, Df, Xf),
268 - separate time-dependent and freq-dependent interp
269 - types with a comma (freq _after_ the comma).
270 - Specifications for frequency are ignored when the
271 - calibration table has no channel-dependence.
272 - Time-dependent interp options ending in 'PD' enable a
273 - "phase delay" correction per spw for non-channel-dependent
274 - calibration types.
275 - For multi-obsId datasets, 'perobs' can be appended to
276 - the time-dependent interpolation specification to
277 - enforce obsId boundaries when interpolating in time.
278 - default: '' --&gt; 'linear,linear' for all gaintable(s)
279 - example: interp='nearest' (in time, freq-dep will be
280 - linear, if relevant)
281 - interp='linear,cubic' (linear in time, cubic
282 - in freq)
283 - interp='linearperobs,spline' (linear in time
284 - per obsId,
285 - spline in freq)
286 - interp=',spline' (spline in freq; linear in
287 - time by default)
288 - interp=['nearest,spline','linear'] (for multiple gaintables)
289 - Options: Time: 'nearest', 'linear'
290 - Freq: 'nearest', 'linear', 'cubic', 'spline'
291 - spwmap -- Spectral windows combinations to form for gaintable(s)
292 - default: [] (apply solutions from each spw to that spw only)
293 - Example: spwmap=[0,0,1,1] means apply the caltable solutions
294 - from spw = 0 to the spw 0,1 and spw 1 to spw 2,3.
295 - spwmap=[[0,0,1,1],[0,1,0,1]]
296 - async -- Run asynchronously
297 - default = False; do not run asychronously
382 +https://casa.nrao.edu/casadocs/
298 383 </example>
299 384
300 385 </task>
301 386 </casaxml>

Everything looks good. We'll let you know here if there's anything you should know about.

Add shortcut