Inheritance diagram for __casac__.lightflagger.lightflagger:

Public Member Functions
def	__init__
def	open
def	setdata
def	getparameters
def	setparameters
def	run
def	done
def	saveflagversion
def	restoreflagversion
def	deleteflagversion
def	getflagversionlist
Public Attributes
	this
Static Private Attributes
dictionary	__swig_setmethods__
tuple	__setattr__
dictionary	__swig_getmethods__
tuple	__getattr__
	__repr__
	__swig_destroy__
	__del__

Detailed Description

Proxy of C++ casac::lightflagger class

Definition at line 70 of file lightflagger.py.

Constructor & Destructor Documentation

def __casac__.lightflagger.lightflagger.__init__ ( self )

__init__(self) -> lightflagger

Definition at line 77 of file lightflagger.py.

Member Function Documentation

def __casac__.lightflagger.lightflagger.deleteflagversion	(	self,
		args,
		kwargs
	)

deleteflagversion(self, versionname=std::vector< string >(1, "")) -> bool

Summary
*** n Delete a saved flag_version. 
                   ***

Input Parameters:
versionname      Version name 

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

Definition at line 228 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.done ( self )

done(self) -> bool

Summary
Destroys the flag tool
--------------------------------------------------------------------------------

Definition at line 176 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.getflagversionlist	(	self,
		printflags = `True`
	)

getflagversionlist(self, printflags=True) -> std::vector< std::string >

Summary
*** n Print out a list of saved flag_versions. 
                  ***

Input Parameters:
printflags       Print flagversions in logger? true 

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

Definition at line 244 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.getparameters	(	self,
		args,
		kwargs
	)

getparameters(self, algorithm=string("none")) -> record *

Summary
 Retrieve the current set of input parameters for a specified algorithm.
   n This returns a python dictionary of parameters and their values.
   

Input Parameters:
algorithm        Autoflag Algorithm name timemed freqmed none 

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

Definition at line 127 of file lightflagger.py.

Referenced by asap.asapfit.asapfit.__str__(), asap.asapfit.asapfit.as_dict(), and asap.asapfit.asapfit.save().

def __casac__.lightflagger.lightflagger.open	(	self,
		args,
		kwargs
	)

open(self, msname=string("")) -> bool

Summary
Attaches tool to a measurement set.

Input Parameters:
msname           Measurement set to be processed 

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

Definition at line 84 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.restoreflagversion	(	self,
		args,
		kwargs
	)

restoreflagversion(self, versionname=std::vector< string >(1, ""), merge=string("")) -> bool

Summary
*** n Restore flags from a saved flag_version. 
                n versionname : name of flag version to restore to main table
                n merge : Type of operation to perform during restoration.
                n        merge = replace  : replaces the main table flags.
                n        merge = and   : logical AND with main table flags
                n        merge = or    : logical OR with main table flags
                n        Default : replace.
                  n ***

Input Parameters:
versionname      Version name 
merge            merge type 

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

Definition at line 205 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.run	(	self,
		args,
		kwargs
	)

run(self, parameters=initialize_record("")) -> record *

Summary
Executes a flagging run

Input Parameters:
parameters       Generic parameters 

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

Definition at line 161 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.saveflagversion	(	self,
		args,
		kwargs
	)

saveflagversion(self, versionname=string(""), comment=string(""), merge=string("")) -> bool

Summary
*** n Save current flags with a version name.*** 
                

Input Parameters:
versionname      Version name 
comment          Comment for this flag table 
merge            merge type 

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

Definition at line 187 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.setdata	(	self,
		args,
		kwargs
	)

setdata(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""), 
    baseline=string(""), uvrange=string(""), time=string(""), correlation=string("")) -> bool

Summary
Set the data selection parameters to define a
   subset of the data on which to perform any further selections/operations.
 For unspecified parameters, the full data range is assumed.
All data selection parameters follow the ms-selection syntax.


Input Parameters:
field            Field indices or source names : example : '2,3C48' 
spw              Spectral Window Indices or names : example : '1,2' 
array            Array Indices or names : example : 'VLAA' 
feed             Feed index or name : example : '1,2' 
scan             Scan number : example : '1,2,3' 
baseline         Baseline number : example : '2-3,4-5,132 ????' 
uvrange          UV-distance range, with a unit : example : '2.0-3000.0 m' 
time             Time range, as MJDs or date strings : example : 'xx.x.x.x.x~yy.y.y.y.y' 
correlation      Correlations/polarizations : example : 'RR,LL,RL,LR,XX,YY,XY,YX' 

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

Definition at line 99 of file lightflagger.py.

def __casac__.lightflagger.lightflagger.setparameters	(	self,
		args,
		kwargs
	)

setparameters(self, algorithm=string("none"), parameters=initialize_record("")) -> bool

Summary
Setup an autoflag algorithm.
   

Input Parameters:
algorithm        Autoflag Algorithm name timemedian freqmedian spectralreject uvbin none 
parameters       Parameters for each autoflag algorithm. 

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

Definition at line 144 of file lightflagger.py.