|
casa
$Rev:20696$
|
|
casa
$Rev:20696$
|
Public Member Functions | |
| def | __init__ |
| def | open |
| def | setdata |
| def | setmanualflags |
| def | printflagselection |
| def | clearflagselection |
| def | getautoflagparams |
| def | setautoflag |
| def | setshadowflags |
| def | setelevationflags |
| def | setflagsummary |
| def | setqueryflag |
| def | setextendflag |
| def | run |
| def | writeflagstodisk |
| def | help |
| 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__ | |
Proxy of C++ casac::flagger class
Definition at line 70 of file flagger.py.
| def __casac__.flagger.flagger.__init__ | ( | self | ) |
__init__(self) -> flagger
Definition at line 77 of file flagger.py.
| def __casac__.flagger.flagger.clearflagselection | ( | self, | |
index = 0 |
|||
| ) |
clearflagselection(self, index=0) -> bool Summary Clear current manual and auto flag selections. Input Parameters: index Flag selection index to clear. Set index to -1 in order to clear all selections. 0 --------------------------------------------------------------------------------
Definition at line 183 of file flagger.py.
| def __casac__.flagger.flagger.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 501 of file flagger.py.
| def __casac__.flagger.flagger.done | ( | self | ) |
done(self) -> bool Summary Destroys the flag tool --------------------------------------------------------------------------------
Definition at line 449 of file flagger.py.
| def __casac__.flagger.flagger.getautoflagparams | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
getautoflagparams(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 199 of file flagger.py.
| def __casac__.flagger.flagger.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 517 of file flagger.py.
| def __casac__.flagger.flagger.help | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
help(self, names=string("")) -> bool
Summary
Prints help on available flagging methods
Input Parameters:
names Names of methods (all methods, if omitted)
--------------------------------------------------------------------------------Definition at line 434 of file flagger.py.
| def __casac__.flagger.flagger.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 flagger.py.
| def __casac__.flagger.flagger.printflagselection | ( | self | ) |
printflagselection(self) -> bool Summary Print out a list of current manual and auto flag selections. --------------------------------------------------------------------------------
Definition at line 171 of file flagger.py.
| def __casac__.flagger.flagger.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 478 of file flagger.py.
| def __casac__.flagger.flagger.run | ( | self, | |
trial = False, |
|||
reset = False |
|||
| ) |
run(self, trial=False, reset=False) -> record * Summary Executes a flagging run Input Parameters: trial Do a trial run only false reset Reset Flags before flagging false --------------------------------------------------------------------------------
Definition at line 407 of file flagger.py.
| def __casac__.flagger.flagger.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 460 of file flagger.py.
| def __casac__.flagger.flagger.setautoflag | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setautoflag(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.
The following is a description of currently supported autoflag algorithms.
(1) Time median filtering
(2) Frequency median filtering
(3) Spectral rejection
(4) Uv-binning
--------------------------------------------------------------------------------Definition at line 216 of file flagger.py.
| def __casac__.flagger.flagger.setdata | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setdata(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""),
baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""),
intent=string(""), observation=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'
intent Observing intent : example : '*CAL*, *BAND*'
observation Observation Id : example : '2~4'
--------------------------------------------------------------------------------Definition at line 99 of file flagger.py.
| def __casac__.flagger.flagger.setelevationflags | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setelevationflags(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""),
baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""),
intent=string(""), observation=string(""), lowerlimit=0.0, upperlimit=90.0) -> bool
Summary
Setup data selection parameters for flagging of
antennas pointing at a low elevation
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'
intent Observing intent : example : '*CAL*, *BAND*'
observation Observation Id : example : '2~4'
lowerlimit The limiting elevation in degrees. Data obtained at lower antenna elevations will get flagged. : example : limit = '15' 0.0
upperlimit The limiting elevation in degrees. Data obtained at higher antenna elevations will get flagged. : example : limit = '85' 90.0
--------------------------------------------------------------------------------Definition at line 268 of file flagger.py.
| def __casac__.flagger.flagger.setextendflag | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setextendflag(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""),
baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""),
intent=string(""), observation=string(""), along=string("allbaselines"),
width=0) -> bool
Summary
Extend existing flags along a specific direction.
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'
intent Observing intent : example : '*CAL*, *BAND*'
observation Observation Id : example : '2~4'
along Extend flags along this axis.
along='channel' : extends flags across channels, if any channel has a flag. (need 'width')
along='correlation' : extends flags across polarizations. (need some way to specify which pol)
along='time' : extend flags across timestamps. (need 'width'). Similarly for hourangle.
along='antenna1' : For one timestamp, flag all baselines with the same antenna1.
along='antenna2' : For one timestamp, flag all baselines with the same antenna2.
along='bothantennas' : For one timestamp, flag all baselines with either antenna1 or antenna2.
along='allbaselines' : For one timestamp, extend to all baselines. (Note that this is different from using rowflags. channel correlation time (hourangle) antenna1 antenna2 bothantennas allbaselines
width The limit to which flags should be extended on either side.
width=4 : Extend flags to 4 data points on either side.
width=0 : Extend to all values along the specified axis. 0
--------------------------------------------------------------------------------Definition at line 366 of file flagger.py.
| def __casac__.flagger.flagger.setflagsummary | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setflagsummary(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""),
baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""),
intent=string(""), observation=string("")) -> bool
Summary
This function produces a summary of the flags. Statistics include
percentage of flagged data.
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'
intent Observing intent : example : '*CAL*, *BAND*'
observation Observation Id : example : '2~4'
--------------------------------------------------------------------------------Definition at line 299 of file flagger.py.
| def __casac__.flagger.flagger.setmanualflags | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setmanualflags(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""),
baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""),
intent=string(""), observation=string(""), autocorrelation=False,
unflag=False, clipexpr=string(""), cliprange=initialize_vector(2,(double)0, (double)0),
clipcolumn=string("DATA"), outside=True, channelavg=False,
quackinterval=0.0, quackmode=string("beg"), quackincrement=False) -> bool
Summary
This function will select specific data, for manual flagging.
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'
intent Observing intent : example : '*CAL*, *BAND*'
observation Observation Id : example : '2~4'
autocorrelation Flag autocorrelations too ? [ True / False ] false
unflag Unflag the specified data ? [ True / False ] false
clipexpr Data expression for value to clip on : example : 'abs I'
cliprange Clip Range of the value defined by clipExpr [min,max] : example : [100.0,200.0] 0 0
clipcolumn Data column to use for clipping : example : 'DATA' DATA
outside Clip points outside this range ? [ True / False ] true
channelavg Average data over channels before clipping ? [ True / False ] false
quackinterval Quack Length in seconds : example : 30.0 0.0
quackmode Quack mode beg
quackincrement Quack incrementally? false
--------------------------------------------------------------------------------Definition at line 130 of file flagger.py.
| def __casac__.flagger.flagger.setqueryflag | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setqueryflag(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""),
baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""),
intent=string(""), observation=string(""), what=string("fieldid"),
fractionthreshold=0.0, nflagsthreshold=0, morethan=True) -> bool
Summary
List out a data description corresponding to the result of a flag query.
For example, to print out the list of channels with more than 70% of its data flagged.
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'
intent Observing intent : example : '*CAL*, *BAND*'
observation Observation Id : example : '2~4'
what Summary type, corresponding to a data axis.
what = 'antenna' will list the percentage of flagged data per antenna antenna channel spwid baseline correlation fieldid
fractionthreshold Threshold on the fraction of flagged data. [0-1]
example : what='antenna', fractionthreshold=0.7 0.0
nflagsthreshold Threshold on the absolute number of flagged points.
example : what='antenna', nflagsthreshold=1500 0
morethan List values corresponding to more-than or less-than the specified threshold fraction. true
--------------------------------------------------------------------------------Definition at line 328 of file flagger.py.
| def __casac__.flagger.flagger.setshadowflags | ( | self, | |
| args, | |||
| kwargs | |||
| ) |
setshadowflags(self, field=string(""), spw=string(""), array=string(""), feed=string(""), scan=string(""),
baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""),
intent=string(""), observation=string(""), diameter=-1.0) -> bool
Summary
Setup data selection parameters for flagging of
shadowed antennas
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'
intent Observing intent : example : '*CAL*, *BAND*'
observation Observation Id : example : '2~4'
diameter Antenna diameter to use. If negative, the default dish sizes stored in the MS are used : example : diameter = '30' -1.0
--------------------------------------------------------------------------------Definition at line 238 of file flagger.py.
| def __casac__.flagger.flagger.writeflagstodisk | ( | self | ) |
writeflagstodisk(self) -> bool Summary Applies flags from trial autoflag runs, to the data. --------------------------------------------------------------------------------
Definition at line 423 of file flagger.py.
__casac__.flagger.flagger.__del__ [static, private] |
Definition at line 83 of file flagger.py.
tuple __casac__.flagger.flagger.__getattr__ [static, private] |
Definition at line 75 of file flagger.py.
__casac__.flagger.flagger.__repr__ [static, private] |
Definition at line 76 of file flagger.py.
tuple __casac__.flagger.flagger.__setattr__ [static, private] |
Definition at line 73 of file flagger.py.
__casac__.flagger.flagger.__swig_destroy__ [static, private] |
Definition at line 82 of file flagger.py.
dictionary __casac__.flagger.flagger.__swig_getmethods__ [static, private] |
Definition at line 74 of file flagger.py.
dictionary __casac__.flagger.flagger.__swig_setmethods__ [static, private] |
Definition at line 72 of file flagger.py.
Definition at line 81 of file flagger.py.
1.8.0