Coverage for /wheeldirectory/casa-6.7.0-12-py3.10.el8/lib/py/lib/python3.10/site-packages/casatools/agentflagger.py: 80%
51 statements
« prev ^ index » next coverage.py v7.6.4, created at 2024-11-01 07:19 +0000
« prev ^ index » next coverage.py v7.6.4, created at 2024-11-01 07:19 +0000
1##################### generated by xml-casa (v2) from agentflagger.xml ##############
2##################### 5e2c98ee52cd9e0baec765091e60850b ##############################
3from __future__ import absolute_import
4from .__casac__.agentflagger import agentflagger as _agentflagger
6from .errors import create_error_string
7from .typecheck import CasaValidator as _validator
8_pc = _validator( )
9from .coercetype import coerce as _coerce
12class agentflagger:
13 _info_group_ = """agentflagger"""
14 _info_desc_ = """Tool for manual and automated flagging"""
15 ### self
16 def __init__(self, *args, **kwargs):
17 """Create a *agentflagger* tool, and initialize some variables.
18 """
19 self._swigobj = kwargs.get('swig_object',None)
20 if self._swigobj is None:
21 self._swigobj = _agentflagger()
23 def done(self):
24 """
25 """
26 return self._swigobj.done()
28 def open(self, msname='', ntime=float(0.0)):
29 """
30 """
31 return self._swigobj.open(msname, ntime)
33 def selectdata(self, config={ }, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', timerange='', correlation='', intent='', observation=''):
34 """
35 """
36 return self._swigobj.selectdata(config, field, spw, array, feed, scan, antenna, uvrange, timerange, correlation, intent, observation)
38 def parseagentparameters(self, aparams):
39 """The specific data selection parameters for the agent (flagging mode)
40 are parsed. These parameters are the data selection and mode-specific parameters.
41 See the example below:
42 """
43 return self._swigobj.parseagentparameters(aparams)
45 def init(self):
46 """This method will initialize the agents and create a list of agents
47 with their specific parameters. It takes no parameters.
48 """
49 return self._swigobj.init()
51 def run(self, writeflags=True, sequential=True):
52 """Execute a list of flagging agents and write or not to the MS/cal table. The parameter
53 writeflags controls whether or not to write to the MS.
54 """
55 return self._swigobj.run(writeflags, sequential)
57 def getflagversionlist(self, printflags=True):
58 """Print out the list of flag versions in the MS, unless the parameter printflags=False. The list of names is returned.
59 """
60 return self._swigobj.getflagversionlist(printflags)
62 def printflagselection(self):
63 """Print out a list of current flag selections.
64 """
65 return self._swigobj.printflagselection()
67 def saveflagversion(self, versionname='', comment='', merge=''):
68 """
69 """
70 return self._swigobj.saveflagversion(versionname, comment, merge)
72 def restoreflagversion(self, versionname=[ ], merge=''):
73 """
74 """
75 return self._swigobj.restoreflagversion(versionname, merge)
77 def deleteflagversion(self, versionname=[ ]):
78 """
79 """
80 return self._swigobj.deleteflagversion(versionname)
82 def parsemanualparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', autocorr=False, apply=True):
83 """
84 """
85 return self._swigobj.parsemanualparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, autocorr, apply)
87 def parseclipparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', datacolumn='DATA', clipminmax=[ ], clipoutside=True, channelavg=False, chanbin=int(1), timeavg=False, timebin='', clipzeros=False, apply=True):
88 """
89 """
90 return self._swigobj.parseclipparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, datacolumn, clipminmax, clipoutside, channelavg, chanbin, timeavg, timebin, clipzeros, apply)
92 def parsequackparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', quackmode='beg', quackinterval=float(1.0), quackincrement=False, apply=True):
93 """
94 """
95 return self._swigobj.parsequackparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, quackmode, quackinterval, quackincrement, apply)
97 def parseelevationparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', lowerlimit=float(0.0), upperlimit=float(90.0), apply=True):
98 """
99 """
100 return self._swigobj.parseelevationparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, lowerlimit, upperlimit, apply)
102 def parsetfcropparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', ntime=float(0.0), combinescans=False, datacolumn='DATA', timecutoff=float(4.0), freqcutoff=float(3.0), timefit='line', freqfit='poly', maxnpieces=int(7), flagdimension='freqtime', usewindowstats='none', halfwin=int(1), extendflags=True, apply=True, channelavg=False, chanbin=int(1), timeavg=False, timebin=''):
103 """
104 """
105 return self._swigobj.parsetfcropparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, ntime, combinescans, datacolumn, timecutoff, freqcutoff, timefit, freqfit, maxnpieces, flagdimension, usewindowstats, halfwin, extendflags, apply, channelavg, chanbin, timeavg, timebin)
107 def parseantintparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', antint_ref_antenna='', minchanfrac=float(0.6), verbose=False, apply=True):
108 """
109 """
110 return self._swigobj.parseantintparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, antint_ref_antenna, minchanfrac, verbose, apply)
112 def parseextendparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', ntime=float(0.0), combinescans=False, extendpols=True, growtime=float(50.0), growfreq=float(50.0), growaround=False, flagneartime=False, flagnearfreq=False, apply=True):
113 """
114 """
115 return self._swigobj.parseextendparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, ntime, combinescans, extendpols, growtime, growfreq, growaround, flagneartime, flagnearfreq, apply)
117 def parsesummaryparameters(self, field='', spw='', array='', feed='', scan='', antenna='', uvrange='', time='', correlation='', intent='', observation='', spwchan=False, spwcorr=False, basecnt=False, fieldcnt=False, name=''):
118 """
119 """
120 return self._swigobj.parsesummaryparameters(field, spw, array, feed, scan, antenna, uvrange, time, correlation, intent, observation, spwchan, spwcorr, basecnt, fieldcnt, name)