| Version 1.9 Build 1556
|
|
Next: autoflag.summary - Function
Up: autoflag - Tool
Previous: autoflag.attach - Function
autoflag.run - Function
|
Package |
synthesis |
|
Module |
autoflag |
|
Tool |
autoflag |
Executes a flagging run
Synopsis
run(globparm, plotscr, plotdev, devfile, reset, trial)
Description
This function will perform a flagging run utilizing methods configured by prior
setmethod() calls. It has a number of optional parameters affecting
various aspects of the flagging process:
- Run will optionaly produce a graphical flagging report (plots
of flag density per baseline, antenna, time, etc.), both on-screen and in a
file. Either option may be turned on or off. To redirect hardcopy output,
the devfile argument may be set to a filename for PostScript output,
or to a full PGPlot device specification (``file/device'').
- The globparm argument allows you to set parameters that are ``global'' to
all methods. For example, using globparm=[hw=10,fignore=T] will cause
all methods to use the given values for the hw and fignore
parameters, unless another value was explicitly set in the setmethod()
call. In other words, globparm takes precedence over default values,
but not over setmethod() arguments.
- When using trial, flagging is performed and flagging reports are
generated without writing the results back into the measurement set.
- The reset option clears all pre-existing flags from the FLAG and
FLAGROW columns of the measurement set prior to running the methods. If trial is specified as well, the MS is not modified, but all methods run as if
all flags were clear to begin with (in fact, reset and trial together is
equivalent to globparm=[fignore=T].)
Arguments
globparm |
|
Record of global method parameters |
|
|
Allowed: |
Record |
|
|
Default: |
empty |
plotscr |
|
Number of plots per window for on-screen flagging
report, or default for no report |
|
|
Allowed: |
[nx, ny] |
|
|
Default: |
No report |
plotdev |
|
Number of plots per page in hardcopy flagging report,
or [] or F for no report |
|
|
Allowed: |
Boolean F or
[nx, ny] |
|
|
Default: |
F |
devfile |
|
File or PGPlot device for hardcopy report |
|
|
Allowed: |
String |
|
|
Default: |
flagreport.ps/ps |
reset |
|
Reset pre-existing flags before running |
|
|
Allowed: |
Boolean |
|
|
Default: |
F |
trial |
|
Do a trial run only |
|
|
Allowed: |
Boolean |
|
|
Default: |
F |
Returns
Boolean T, or a fail