nraonrao
 
NRAO Home > CASA > TaskRef

0.1.58 sdflag

Requires:

Synopsis ASAP SD spectral flagging task Description

ASAP SD spectral flagging task (based on the ALMATST5 recommendations):

Task Version 2008-01-31 TT

Arguments





Inputs

sdfile

name of input SD dataset

allowed:

string

Default:

scanlist

list of scans to use (e.g. [1,2,3,4])

allowed:

intArray

Default:

field

string for selection by source name

allowed:

string

Default:

iflist

list of IF ids to select (e.g. [0,1])

allowed:

intArray

Default:

pollist

list of polarization by ids or names to select (e.g. [0,1])

allowed:

any

Default:

variant

maskflag

list of mask regions to flag/unflag

allowed:

intArray

Default:

flagmode

flag mode (flag,unflag,restore)

allowed:

string

Default:

flag

outfile

name of output file

allowed:

string

Default:

outform

output file format (ASCII,MS,SDFITS,ASAP)

allowed:

string

Default:

ASAP

overwrite

overwrite the output file if already exists

allowed:

bool

Default:

False

plotlevel

control for plotting of results

allowed:

int

Default:

0

Returns
void

Example

 
        Keyword arguments:  
        sdfile -- name of input SD dataset  
        scanlist -- list of scan numbers to process  
                default: [] (use all scans)  
                example: [21,22,23,24]  
                         this selection is in addition to field  
                         and iflist  
        field -- selection string for selecting scans by name  
                default: ’’ (no name selection)  
                example: ’FLS3a*’  
                         this selection is in addition to scanlist  
                         and iflist  
        iflist -- list of IF id numbers to select  
                default: [] (use all IFs)  
                example: [15]  
                         this selection is in addition to scanlist  
                         and field  
        pollist -- list of polarization id numbers to select  
                default: [] (use all polarizations)  
                example: [1]  
                         this selection is in addition to scanlist,  
                         field, and iflist  
        maskflag -- list of mask regions to apply flag/unflag  
                default: [] (entire spectrum)  
                example: [[1000,3000],[5000,7000]]  
        flagmode -- flag mode  
                default: ’flag’  
                options: ’flag’,’unflag’,’restore’  
                         in ’restore’ mode, a history of flagging is  
                         displayed and current flag state is returned  
        outfile -- Name of output file  
                default: ’’ (<sdfile>_f)  
        outform -- format of output file  
                options: ’ASCII’,’SDFITS’,’MS’,’ASAP’  
                default: ’ASAP’  
                example: the ASAP format is easiest for further sd  
                         processing; use MS for CASA imaging.  
        overwrite -- overwrite the output file if already exists  
                options: (bool) True,False  
                default: False  
                WARNING: if outform=’ASCII’, this parameter is ignored  
        plotlevel -- control for plotting of results  
                options: (int) 0=none, 1=some, 2=more, <0=hardcopy  
                default: 0 (no plotting)  
                example: plotlevel<0 as abs(plotlevel), e.g.  
                         -1 => hardcopy of final plot (will be named  
                         <outfile>_flag.eps)  
                WARNING: be careful plotting in fsotf mode!  
 
        -------------------------------------------------------------------  
        Returns: Current values of maskflag for each spectrum as a list,  
                 only if flagmode is set to ’restore’. Note that the  
                 ’restore’ mode refers scanlist, iflist, and pollist.  
 
        DESCRIPTION:  
 
        Task sdflag performs simple channel based flagging on spectra.  
        The flag regions in channels can be specified in maskflag. This  
        is not interactive flagging. If plotlevel>=1, the task asks  
        you if you really apply the flags before it is actually written  
        to the data with a plot indicating flagged regions.  
        The flags are not written to the current (input) datasets unless  
        outfile=’none’.  
        Please note that this task is still experimental.  
 
 

Please send any comments or questions about CASA or AIPS++ to aips2-requests@nrao.edu

Copyright © 2008 Associated Universities Inc., Washington, D.C.

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


Home | Contact Us | Directories | Site Map | Help | Privacy Policy | Search

Updated daily during alpha development.