Command-based flagging using flagcmd

NRAO Home > CASA > CASA Cookbook and User Reference Manual

3.5 Command-based flagging using flagcmd

Alert: The flagcmd task is under development and active testing. If you need the flagcmd syntax of CASA 3.3. and older, please use the task oldflagcmd.

The task flagcmd will flag the visibility data set based on a specified set of flagging commands using a flagging syntax (see § 3.5.3). These commands can be input from the FLAG_CMD MS table, from a Flag.xml SDM table, from an ascii file, or from input python strings. Facilities for manipulation, listing, or plotting of these flags are also provided.

The inputs to flagcmd are:

#  flagcmd :: Flagging task based on batches of flag-commands
vis                 =         ’’        #  Name of MS file to flag
inpmode             =    ’table’        #  Input mode for flag commands(table/file/xml/cmd)
     inpfile        =         ’’        #  Source of flag commands
     tablerows      =         []        #  Rows of inpfile to read
     reason         =      ’any’        #  Select by REASON types
     useapplied     =      False        #  Select commands whose rows have APPLIED column set to
                                        #   True

action              =    ’apply’        #  Action to perform in MS and/or in inpfile
                                        #   (apply/unapply/list/plot/clear/extract)
     flagbackup     =       True        #  Automatically backup the FLAG column before execution

savepars            =      False        #  Save flag commands to the MS or to a file
async               =      False        #  If true the taskname must be started using flagcmd(...)

The default input mode is inpmode=’table’ which directs the task to input flag commands from the FLAG_CMD internal MS table. See § 3.5.1 for more options.

The default operation mode is action=’apply’ directing the task to apply relevant flagging commands to the MS data main table. See § 3.5.2 for more options.

See § 3.5.3 for a description of the flagging command syntax.

  3.5.1 Input modes inpmode
   3.5.1.1 Input mode ’table’
   3.5.1.2 Input flag mode ’xml’
   3.5.1.3 Input flag mode ’file’
   3.5.1.4 Input flag mode ’cmd’
  3.5.2 Operation types action
   3.5.2.1 Apply flags — optype option ’apply’
   3.5.2.2 Unapply flags — action option ’unapply’
   3.5.2.3 List flags — action=’list’
   3.5.2.4 Plot flags — action=’plot’
   3.5.2.5 Clear flags — action=’clear’
   3.5.2.6 Extract Flag Commands— action=’extract’
  3.5.3 Flagging command syntax

[next] [prev] [prev-tail] [front] [up]

More information about CASA may be found at the CASA web page

This code is available under the terms of the GNU General Public Lincense