Public Member Functions
def	__init__
def	result
def	__call__
def	paramgui
def	defaults
def	check_params
def	description
def	itsdefault
Public Attributes
	parameters
Static Public Attributes
	rkey
	Handle globals or user over-ride of arguments.
	i_am_a_casapy_task
list	retval
	This function sets the default values but also will return the list of parameters or the default value of a given parameter.
string	valornotval
tuple	retval
Private Attributes
	__bases__
	__doc__
	__globals__
Static Private Attributes
string	__name__
dictionary	__async__

Detailed Description

Definition at line 18 of file sdflag_cli.py.

Constructor & Destructor Documentation

def sdflag_cli.sdflag_cli_.__init__ ( self )

Definition at line 26 of file sdflag_cli.py.

Member Function Documentation

def sdflag_cli.sdflag_cli_.__call__	(	self,
		infile = `None`,
		antenna = `None`,
		specunit = `None`,
		restfreq = `None`,
		frame = `None`,
		doppler = `None`,
		scanlist = `None`,
		field = `None`,
		iflist = `None`,
		pollist = `None`,
		maskflag = `None`,
		flagrow = `None`,
		clip = `None`,
		clipminmax = `None`,
		clipoutside = `None`,
		flagmode = `None`,
		interactive = `None`,
		showflagged = `None`,
		outfile = `None`,
		outform = `None`,
		overwrite = `None`,
		plotlevel = `None`,
		async = `None`
	)

ASAP SD spectral flagging task 
Keyword arguments:
infile -- name of input SD dataset
antenna -- antenna name or id (only effective for MS input). 
specunit -- units for spectral axis
options: (str) 'channel','km/s','GHz','MHz','kHz','Hz',''
default: '' (=current)
example: this will be the units for maskflag
    >>> specunit expandable parameters
 restfreq -- rest frequency
         available type includes float, int, string, list of float, 
         list of int, list of string, and list of dictionary. the 
         default unit of restfreq in case of float, int, or string 
         without unit is Hz. string input can be a value only 
         (treated as Hz) or a value followed by unit for which 'GHz',
         'MHz','kHz',and 'Hz' are available. 
         a list can be used to set different rest frequencies for 
         each IF. the length of list input must be nIF. dictionary 
         input should be a pair of molecule name and frequency with 
         keys of 'name' and 'value', respectively. values in the 
         dictionary input follows the same manner as for single 
         float or string input. 
         example: 345.796
                  '1420MHz'
                  [345.8, 347.0, 356.7]
                  ['345.8MHz', '347.0MHz', '356.7MHz']
                  [{'name':'CO','value':345}]
frame -- frequency frame for spectral axis
options: (str) 'LSRK','REST','TOPO','LSRD','BARY',
         'GEO','GALACTO','LGROUP','CMB'
default: currently set frame in scantable
WARNING: frame='REST' not yet implemented
doppler -- doppler mode
options: (str) 'RADIO','OPTICAL','Z','BETA','GAMMA'
default: currently set doppler in scantable
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, iflist, and pollist
iflist -- list of IF id numbers to select
default: [] (use all IFs)
example: [15]
this selection is in addition to scanlist, field, and pollist
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 
    Note, this parameter is ignored if one or more rows are 
    given in flagrow, or clip=True.
default: [] (entire spectrum)
example: [[1000,3000],[5000,7000]]
flagrow -- list of row numbers to apply flag/unflag
   Note, this parameter is effective only when one or more row 
   numbers are given explicitly and also clip=False
default: [] (no row selection)
example: [0, 2, 3]
clip -- flag data that are outside a specified range
options: (bool)True,False
default: False
     >>> clip expandable parameters
clipminmax -- range of data that will NOT be flagged
        default: [] means do not use clip option
        example: [0.0,1.5]
clipoutside -- clip OUTSIDE the range ?
        options: (bool)True,False
        default: True
        example: clipoutside=False means flag data WITHIN the range.
flagmode -- flag mode
default: 'flag'
options: 'flag','unflag'
interactive -- determines interactive flagging
options: (bool) True,False
default: False
     >>> interactive expandable parameters
showflagged -- show flagged data on plots
        default: False
outfile -- Name of output file
default: ''
Note: by default (outfile=''), actual output file name is set as follows: 
      (1) if overwrite=True (default), infile (input) will be overwritten.
      WARNING: If the formats of input and ouput files are different, 
               this causes complete loss of input file.
      (2) if overwrite=False, outfile will be <infile>_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.
WARNING: Be sure outform is same as the input file format when you 
         overwrite the input file by overwrite=True and outfile='' (default).
overwrite -- overwrite the output file if already exists
options: (bool) True,False
default: True
WARNING: input file is overwritten if overwrite=True and outfile='' (default). 
         This causes the complete loss of input file if the formats of
         input and ouput files are different.
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!

-------------------------------------------------------------------

DESCRIPTION:

Task sdflag performs both interactive and non-interactive channel/row 
based flagging on spectra.
Currently, the available ways of non-interactive flagging include: 
(1) channel based flagging by specifying a range of spectral values 
with clip=True, (2) row based flagging by specifying a list of row 
numbers to the flagrow parameter, and (3) channel based flagging by 
specifying regions in channel to the maskflag parameter. 
These three ways of flagging can not be executed simultaneously. 
If more than one parameter above are specified, the task looks for 
them in the above order and operates the first specified way of 
flagging operation.

Interactive flagging is available when interactive=True. 
The available ways of interactive flagging include: 
(1) row based flagging by selecting 'panel' and (2) channel
based flagging by selecting 'region's of channels on Flag plotter. 
Note that the Flag plotter is loaded after carrying out the 
non-interactive flag operation if any specified. See the cookbook for
details of how to select channel regions and spectra on the plotter.

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.
Please note that this task is still experimental.

WARNING for overwrite option:
Be sure 'outform' is the same as data format of input file when you
overwrite it. Since CASA 3.1, the default value of the option 'overwrite'
has been changed to True, thereby the current dataset (infile) is 
overwritten unless a different file name is set to outfile. 
There is a known issue in overwriting infile. If 'outform' differs to the
data format of infile, the data is overwritten with the new data format 
(specified by 'outform') and the data in the original format will be lost.

WARNING for the GBT raw SDFITS format data as input:
SDtasks are able to handle GBT raw SDFITS format data since the 
data filler is available. However, the functionality is not well 
tested yet, so that there may be unknown bugs.

Definition at line 46 of file sdflag_cli.py.

def sdflag_cli.sdflag_cli_.check_params	(	self,
		param = `None`,
		value = `None`,
		ipython_globals = `None`
	)

Definition at line 455 of file sdflag_cli.py.

def sdflag_cli.sdflag_cli_.defaults	(	self,
		param = `None`,
		ipython_globals = `None`,
		paramvalue = `None`,
		subparam = `None`
	)

Definition at line 377 of file sdflag_cli.py.

def sdflag_cli.sdflag_cli_.description	(	self,
		key = `'sdflag'`,
		subkey = `None`
	)

Definition at line 486 of file sdflag_cli.py.

def sdflag_cli.sdflag_cli_.itsdefault	(	self,
		paramname
	)

Definition at line 521 of file sdflag_cli.py.

References accum_cli.accum_cli_.parameters, sdflag_cli.sdflag_cli_.parameters, sdfit_cli.sdfit_cli_.parameters, sdcoadd_cli.sdcoadd_cli_.parameters, sdcal_cli.sdcal_cli_.parameters, sdbaseline_cli.sdbaseline_cli_.parameters, rmtables_cli.rmtables_cli_.parameters, applycal_cli.applycal_cli_.parameters, predictcomp_cli.predictcomp_cli_.parameters, polcal_cli.polcal_cli_.parameters, plotxy_cli.plotxy_cli_.parameters, plotweather_cli.plotweather_cli_.parameters, plotuv_cli.plotuv_cli_.parameters, plotms_cli.plotms_cli_.parameters, plotcal_cli.plotcal_cli_.parameters, plotants_cli.plotants_cli_.parameters, peel_cli.peel_cli_.parameters, pclean_cli.pclean_cli_.parameters, partition_cli.partition_cli_.parameters, msview_cli.msview_cli_.parameters, msmoments_cli.msmoments_cli_.parameters, mosaic_cli.mosaic_cli_.parameters, makemask_cli.makemask_cli_.parameters, autoclean_cli.autoclean_cli_.parameters, listsdm_cli.listsdm_cli_.parameters, listpartition_cli.listpartition_cli_.parameters, listobs_cli.listobs_cli_.parameters, listhistory_cli.listhistory_cli_.parameters, listfits_cli.listfits_cli_.parameters, listcal_cli.listcal_cli_.parameters, imview_cli.imview_cli_.parameters, imval_cli.imval_cli_.parameters, imtrans_cli.imtrans_cli_.parameters, imsubimage_cli.imsubimage_cli_.parameters, imstat_cli.imstat_cli_.parameters, imsmooth_cli.imsmooth_cli_.parameters, imregrid_cli.imregrid_cli_.parameters, imreframe_cli.imreframe_cli_.parameters, importvla_cli.importvla_cli_.parameters, importuvfits_cli.importuvfits_cli_.parameters, importgmrt_cli.importgmrt_cli_.parameters, importfitsidi_cli.importfitsidi_cli_.parameters, importfits_cli.importfits_cli_.parameters, importevla_cli.importevla_cli_.parameters, importasdm_cli.importasdm_cli_.parameters, impbcor_cli.impbcor_cli_.parameters, immoments_cli.immoments_cli_.parameters, immath_cli.immath_cli_.parameters, imhead_cli.imhead_cli_.parameters, imfit_cli.imfit_cli_.parameters, imcontsub_cli.imcontsub_cli_.parameters, imcollapse_cli.imcollapse_cli_.parameters, hanningsmooth_cli.hanningsmooth_cli_.parameters, gencal_cli.gencal_cli_.parameters, gaincal_cli.gaincal_cli_.parameters, browsetable_cli.browsetable_cli_.parameters, fluxscale_cli.fluxscale_cli_.parameters, flagmanager_cli.flagmanager_cli_.parameters, flagdata_cli.flagdata_cli_.parameters, flagcmd_cli.flagcmd_cli_.parameters, fixvis_cli.fixvis_cli_.parameters, fixplanets_cli.fixplanets_cli_.parameters, find_cli.find_cli_.parameters, feather_cli.feather_cli_.parameters, exportuvfits_cli.exportuvfits_cli_.parameters, exportfits_cli.exportfits_cli_.parameters, exportasdm_cli.exportasdm_cli_.parameters, delmod_cli.delmod_cli_.parameters, deconvolve_cli.deconvolve_cli_.parameters, cvel_cli.cvel_cli_.parameters, csvclean_cli.csvclean_cli_.parameters, conjugatevis_cli.conjugatevis_cli_.parameters, concat_cli.concat_cli_.parameters, clearstat_cli.clearstat_cli_.parameters, clearplot_cli.clearplot_cli_.parameters, clearcal_cli.clearcal_cli_.parameters, clean_cli.clean_cli_.parameters, caltabconvert_cli.caltabconvert_cli_.parameters, calstat_cli.calstat_cli_.parameters, ft_cli.ft_cli_.parameters, boxit_cli.boxit_cli_.parameters, blcal_cli.blcal_cli_.parameters, bandpass_cli.bandpass_cli_.parameters, listvis_cli.listvis_cli_.parameters, asdmsummary_cli.asdmsummary_cli_.parameters, and recipes.almahelpers.SpwInfo.parameters.

Referenced by uvsub_cli.uvsub_cli_.defaults(), uvcontsub2_cli.uvcontsub2_cli_.defaults(), smoothcal_cli.smoothcal_cli_.defaults(), tclean_cli.tclean_cli_.defaults(), splattotable_cli.splattotable_cli_.defaults(), sdflagmanager_cli.sdflagmanager_cli_.defaults(), testconcat_cli.testconcat_cli_.defaults(), sdlist_cli.sdlist_cli_.defaults(), viewer_cli.viewer_cli_.defaults(), sdscale_cli.sdscale_cli_.defaults(), slsearch_cli.slsearch_cli_.defaults(), wvrgcal_cli.wvrgcal_cli_.defaults(), uvcontsub_cli.uvcontsub_cli_.defaults(), ssoflux_cli.ssoflux_cli_.defaults(), vishead_cli.vishead_cli_.defaults(), uvcontsub3_cli.uvcontsub3_cli_.defaults(), sdimprocess_cli.sdimprocess_cli_.defaults(), virtualconcat_cli.virtualconcat_cli_.defaults(), sdsmooth_cli.sdsmooth_cli_.defaults(), visstat_cli.visstat_cli_.defaults(), widebandpbcor_cli.widebandpbcor_cli_.defaults(), uvmodelfit_cli.uvmodelfit_cli_.defaults(), sdsave_cli.sdsave_cli_.defaults(), simanalyze_cli.simanalyze_cli_.defaults(), sdmath_cli.sdmath_cli_.defaults(), sdgrid_cli.sdgrid_cli_.defaults(), sdtpimaging_cli.sdtpimaging_cli_.defaults(), sdstat_cli.sdstat_cli_.defaults(), split_cli.split_cli_.defaults(), sdimaging_cli.sdimaging_cli_.defaults(), statwt_cli.statwt_cli_.defaults(), sdflag_cli.sdflag_cli_.defaults(), simalma_cli.simalma_cli_.defaults(), simobserve_cli.simobserve_cli_.defaults(), setjy_cli.setjy_cli_.defaults(), widefield_cli.widefield_cli_.defaults(), specfit_cli.specfit_cli_.defaults(), and sdreduce_cli.sdreduce_cli_.defaults().

def sdflag_cli.sdflag_cli_.paramgui	(	self,
		useGlobals = `True`,
		ipython_globals = `None`
	)

Opens a parameter GUI for this task.  If useGlobals is true, then any relevant global parameter settings are used.

Definition at line 353 of file sdflag_cli.py.

def sdflag_cli.sdflag_cli_.result	(	self,
		key = `None`
	)

Definition at line 33 of file sdflag_cli.py.

References accum_cli.accum_cli_.__async__, sdflag_cli.sdflag_cli_.__async__, sdfit_cli.sdfit_cli_.__async__, sdcoadd_cli.sdcoadd_cli_.__async__, sdcal_cli.sdcal_cli_.__async__, sdbaseline_cli.sdbaseline_cli_.__async__, rmtables_cli.rmtables_cli_.__async__, predictcomp_cli.predictcomp_cli_.__async__, polcal_cli.polcal_cli_.__async__, plotxy_cli.plotxy_cli_.__async__, plotweather_cli.plotweather_cli_.__async__, plotuv_cli.plotuv_cli_.__async__, plotms_cli.plotms_cli_.__async__, plotcal_cli.plotcal_cli_.__async__, plotants_cli.plotants_cli_.__async__, peel_cli.peel_cli_.__async__, pclean_cli.pclean_cli_.__async__, partition_cli.partition_cli_.__async__, msview_cli.msview_cli_.__async__, msmoments_cli.msmoments_cli_.__async__, mosaic_cli.mosaic_cli_.__async__, makemask_cli.makemask_cli_.__async__, listvis_cli.listvis_cli_.__async__, listsdm_cli.listsdm_cli_.__async__, listpartition_cli.listpartition_cli_.__async__, listobs_cli.listobs_cli_.__async__, listhistory_cli.listhistory_cli_.__async__, listfits_cli.listfits_cli_.__async__, listcal_cli.listcal_cli_.__async__, imview_cli.imview_cli_.__async__, imval_cli.imval_cli_.__async__, imtrans_cli.imtrans_cli_.__async__, imsubimage_cli.imsubimage_cli_.__async__, imstat_cli.imstat_cli_.__async__, imsmooth_cli.imsmooth_cli_.__async__, imregrid_cli.imregrid_cli_.__async__, imreframe_cli.imreframe_cli_.__async__, importvla_cli.importvla_cli_.__async__, importuvfits_cli.importuvfits_cli_.__async__, importgmrt_cli.importgmrt_cli_.__async__, importfitsidi_cli.importfitsidi_cli_.__async__, importfits_cli.importfits_cli_.__async__, importevla_cli.importevla_cli_.__async__, importasdm_cli.importasdm_cli_.__async__, impbcor_cli.impbcor_cli_.__async__, immoments_cli.immoments_cli_.__async__, immath_cli.immath_cli_.__async__, imhead_cli.imhead_cli_.__async__, imfit_cli.imfit_cli_.__async__, imcontsub_cli.imcontsub_cli_.__async__, imcollapse_cli.imcollapse_cli_.__async__, hanningsmooth_cli.hanningsmooth_cli_.__async__, gencal_cli.gencal_cli_.__async__, gaincal_cli.gaincal_cli_.__async__, ft_cli.ft_cli_.__async__, fluxscale_cli.fluxscale_cli_.__async__, flagmanager_cli.flagmanager_cli_.__async__, flagdata_cli.flagdata_cli_.__async__, flagcmd_cli.flagcmd_cli_.__async__, fixvis_cli.fixvis_cli_.__async__, fixplanets_cli.fixplanets_cli_.__async__, find_cli.find_cli_.__async__, feather_cli.feather_cli_.__async__, exportuvfits_cli.exportuvfits_cli_.__async__, exportfits_cli.exportfits_cli_.__async__, exportasdm_cli.exportasdm_cli_.__async__, delmod_cli.delmod_cli_.__async__, deconvolve_cli.deconvolve_cli_.__async__, cvel_cli.cvel_cli_.__async__, csvclean_cli.csvclean_cli_.__async__, conjugatevis_cli.conjugatevis_cli_.__async__, concat_cli.concat_cli_.__async__, clearstat_cli.clearstat_cli_.__async__, clearplot_cli.clearplot_cli_.__async__, clearcal_cli.clearcal_cli_.__async__, clean_cli.clean_cli_.__async__, caltabconvert_cli.caltabconvert_cli_.__async__, calstat_cli.calstat_cli_.__async__, browsetable_cli.browsetable_cli_.__async__, boxit_cli.boxit_cli_.__async__, blcal_cli.blcal_cli_.__async__, bandpass_cli.bandpass_cli_.__async__, autoclean_cli.autoclean_cli_.__async__, asdmsummary_cli.asdmsummary_cli_.__async__, and applycal_cli.applycal_cli_.__async__.

Member Data Documentation

dictionary sdflag_cli.sdflag_cli_.__async__ [static, private]

Definition at line 20 of file sdflag_cli.py.

Referenced by sdflag_cli.sdflag_cli_.result(), wvrgcal_cli.wvrgcal_cli_.result(), widefield_cli.widefield_cli_.result(), widebandpbcor_cli.widebandpbcor_cli_.result(), visstat_cli.visstat_cli_.result(), vishead_cli.vishead_cli_.result(), virtualconcat_cli.virtualconcat_cli_.result(), viewer_cli.viewer_cli_.result(), uvsub_cli.uvsub_cli_.result(), uvmodelfit_cli.uvmodelfit_cli_.result(), uvcontsub_cli.uvcontsub_cli_.result(), uvcontsub3_cli.uvcontsub3_cli_.result(), uvcontsub2_cli.uvcontsub2_cli_.result(), testconcat_cli.testconcat_cli_.result(), tclean_cli.tclean_cli_.result(), statwt_cli.statwt_cli_.result(), ssoflux_cli.ssoflux_cli_.result(), split_cli.split_cli_.result(), splattotable_cli.splattotable_cli_.result(), specfit_cli.specfit_cli_.result(), smoothcal_cli.smoothcal_cli_.result(), slsearch_cli.slsearch_cli_.result(), simobserve_cli.simobserve_cli_.result(), simanalyze_cli.simanalyze_cli_.result(), simalma_cli.simalma_cli_.result(), setjy_cli.setjy_cli_.result(), sdtpimaging_cli.sdtpimaging_cli_.result(), sdstat_cli.sdstat_cli_.result(), sdsmooth_cli.sdsmooth_cli_.result(), sdscale_cli.sdscale_cli_.result(), sdsave_cli.sdsave_cli_.result(), sdreduce_cli.sdreduce_cli_.result(), sdplot_cli.sdplot_cli_.result(), sdmath_cli.sdmath_cli_.result(), sdlist_cli.sdlist_cli_.result(), sdimprocess_cli.sdimprocess_cli_.result(), sdimaging_cli.sdimaging_cli_.result(), sdgrid_cli.sdgrid_cli_.result(), and sdflagmanager_cli.sdflagmanager_cli_.result().

sdflag_cli.sdflag_cli_.__bases__ [private]

Definition at line 27 of file sdflag_cli.py.

sdflag_cli.sdflag_cli_.__doc__ [private]

Definition at line 28 of file sdflag_cli.py.

sdflag_cli.sdflag_cli_.__globals__ [private]

Definition at line 202 of file sdflag_cli.py.

string sdflag_cli.sdflag_cli_.__name__ [static, private]

Definition at line 19 of file sdflag_cli.py.

sdflag_cli.sdflag_cli_.i_am_a_casapy_task [static]

Definition at line 22 of file sdflag_cli.py.

sdflag_cli.sdflag_cli_.parameters

Definition at line 30 of file sdflag_cli.py.

tuple sdflag_cli.sdflag_cli_.retval [static]

This function sets the default values but also will return the list of parameters or the default value of a given parameter.

Definition at line 434 of file sdflag_cli.py.

tuple sdflag_cli.sdflag_cli_.retval [static]

Definition at line 447 of file sdflag_cli.py.

sdflag_cli.sdflag_cli_.rkey [static]

Handle globals or user over-ride of arguments.

Definition at line 21 of file sdflag_cli.py.

string sdflag_cli.sdflag_cli_.valornotval [static]

Definition at line 437 of file sdflag_cli.py.

The documentation for this class was generated from the following file:

sdflag_cli.py

Public Member Functions

Public Attributes

Static Public Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation