Source
160
160
<param type="double" name="tbuff" subparam="true">
161
161
<shortdescription>Time buffer (sec) to pad flags</shortdescription>
162
162
<description>Time buffer (sec) to pad flags. Subparameter of
163
163
inpmode='xml'.
164
164
default: 0.0
165
165
</description>
166
166
<value>0.0</value>
167
167
</param>
168
168
169
169
<param type="string" name="ants" subparam="true">
170
-
<shortdescription>Allowed flag antenna names to select
171
-
by</shortdescription>
170
+
<shortdescription>Allowed flag antenna names to select by</shortdescription>
172
171
<description>Allowed flag antenna names to select by. Subparameter of
173
172
inpmode='xml'.
174
173
</description>
175
174
<value></value>
176
175
</param>
177
176
178
177
<param type="string" name="action">
179
-
<shortdescription>Action to perform in MS and/or in inpfile
180
-
(apply/unapply/list/plot/clear/extract)</shortdescription>
178
+
<shortdescription>Action to perform in MS and/or in inpfile (apply/unapply/list/plot/clear/extract)</shortdescription>
181
179
<description>Action to perform in MS and/or in inpfile
182
180
options: apply/unapply/list/plot/clear/extract
183
181
default: 'apply'
184
182
185
183
Examples:
186
184
-- action='apply': This operation will apply
187
185
the commands chosen by inpmode. If
188
186
inpmode='table' and inpfile='' then the
189
187
APPLIED column in FLAG_CMD will be set to
190
188
True.
232
230
<value>apply</value>
233
231
<value>unapply</value>
234
232
<value>list</value>
235
233
<value>plot</value>
236
234
<value>clear</value>
237
235
<value>extract</value>
238
236
</allowed>
239
237
</param>
240
238
241
239
<param type="bool" name="flagbackup" subparam="true">
242
-
<shortdescription>Automatically backup the FLAG column before
243
-
execution</shortdescription>
240
+
<shortdescription>Automatically backup the FLAG column before execution</shortdescription>
244
241
<description>Automatically backup the FLAG column before
245
242
execution. Subparameter of action='apply/unapply'.
246
243
options: True,False
247
244
default: True
248
245
</description>
249
246
<value>True</value>
250
247
</param>
251
248
252
249
<param type="bool" name="clearall" subparam="true">
253
250
<shortdescription>Delete all rows from FLAG_CMD</shortdescription>
287
284
<description>Name of output file to save plot
288
285
default: '' (plot to matplotlib window)
289
286
290
287
WARNING: will only reliably plot individual flags
291
288
per antenna and timerange (e.g. direct from xml)
292
289
</description>
293
290
<value></value>
294
291
</param>
295
292
296
293
<param type="bool" name="savepars">
297
-
<shortdescription>Save flag commands to the MS or to a
298
-
file</shortdescription>
294
+
<shortdescription>Save flag commands to the MS or file</shortdescription>
299
295
<description>Save the flag commands to the FLAG_CMD table of the MS or
300
296
to an output text file.
301
297
options: True/False
302
298
default: False
303
299
</description>
304
300
<value>False</value>
305
301
</param>
306
302
<param type="string" name="outfile" subparam="true">
307
-
<shortdescription>Name of output file to save
308
-
commands</shortdescription>
303
+
<shortdescription>Name of output file to save commands</shortdescription>
309
304
<description>Name of output file to save commands. Subparameter of
310
305
savepars=True.
311
306
default: ' '; it will save the commands in the
312
307
FLAG_CMD table of the MS.
313
308
314
309
example: outfile='flags.txt' will save the
315
310
parameters in a text file.
316
311
</description>
317
312
<value></value>
318
313
</param>
319
314
<param type="bool" name="overwrite" subparam="true">
320
-
<shortdescription>Overwrite an existing file to save the flag
321
-
commands</shortdescription>
315
+
<shortdescription>Overwrite an existing file to save the flag commands</shortdescription>
322
316
<description>Overwrite an existing file given in 'outfile' to save the
323
317
flag commands. Subparameter of savepars=True.
324
318
options: True/False
325
319
default: True; it will remove the existing file
326
320
given in 'outfile' and save the current flag
327
321
commands to a new file with the same name. When
328
322
set to False, the task will exit with an error
329
323
message if the file exist.
330
324
</description>
331
325
<value>True</value>
380
374
</input>
381
375
<returns type="void"/>
382
376
383
377
<example>
384
378
385
379
For more information, see the task pages of flagcmd in CASA Docs:
386
380
387
381
https://casa.nrao.edu/casadocs/
388
382
389
383
</example>
390
-
</task>
384
+
</task>
391
385
</casaxml>