|
casa
$Rev:20696$
|
|
casa
$Rev:20696$
|
00001 # This file was automatically generated by SWIG (http://www.swig.org). 00002 # Version 2.0.5 00003 # 00004 # Do not make changes to this file unless you know what you are doing--modify 00005 # the SWIG interface file instead. 00006 00007 00008 00009 from sys import version_info 00010 if version_info >= (2,6,0): 00011 def swig_import_helper(): 00012 from os.path import dirname 00013 import imp 00014 fp = None 00015 try: 00016 fp, pathname, description = imp.find_module('_ms', [dirname(__file__)]) 00017 except ImportError: 00018 import _ms 00019 return _ms 00020 if fp is not None: 00021 try: 00022 _mod = imp.load_module('_ms', fp, pathname, description) 00023 finally: 00024 fp.close() 00025 return _mod 00026 _ms = swig_import_helper() 00027 del swig_import_helper 00028 else: 00029 import _ms 00030 del version_info 00031 try: 00032 _swig_property = property 00033 except NameError: 00034 pass # Python < 2.2 doesn't have 'property'. 00035 def _swig_setattr_nondynamic(self,class_type,name,value,static=1): 00036 if (name == "thisown"): return self.this.own(value) 00037 if (name == "this"): 00038 if type(value).__name__ == 'SwigPyObject': 00039 self.__dict__[name] = value 00040 return 00041 method = class_type.__swig_setmethods__.get(name,None) 00042 if method: return method(self,value) 00043 if (not static): 00044 self.__dict__[name] = value 00045 else: 00046 raise AttributeError("You cannot add attributes to %s" % self) 00047 00048 def _swig_setattr(self,class_type,name,value): 00049 return _swig_setattr_nondynamic(self,class_type,name,value,0) 00050 00051 def _swig_getattr(self,class_type,name): 00052 if (name == "thisown"): return self.this.own() 00053 method = class_type.__swig_getmethods__.get(name,None) 00054 if method: return method(self) 00055 raise AttributeError(name) 00056 00057 def _swig_repr(self): 00058 try: strthis = "proxy of " + self.this.__repr__() 00059 except: strthis = "" 00060 return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,) 00061 00062 try: 00063 _object = object 00064 _newclass = 1 00065 except AttributeError: 00066 class _object : pass 00067 _newclass = 0 00068 00069 00070 class ms(_object): 00071 """Proxy of C++ casac::ms class""" 00072 __swig_setmethods__ = {} 00073 __setattr__ = lambda self, name, value: _swig_setattr(self, ms, name, value) 00074 __swig_getmethods__ = {} 00075 __getattr__ = lambda self, name: _swig_getattr(self, ms, name) 00076 __repr__ = _swig_repr 00077 def __init__(self): 00078 """__init__(self) -> ms""" 00079 this = _ms.new_ms() 00080 try: self.this.append(this) 00081 except: self.this = this 00082 __swig_destroy__ = _ms.delete_ms 00083 __del__ = lambda self : None; 00084 def fromfits(self, *args, **kwargs): 00085 """ 00086 fromfits(self, msfile=string(""), fitsfile=string(""), nomodify=True, lock=False, obstype=0, host=string(""), 00087 forcenewserver=False, antnamescheme=string("old")) -> bool 00088 00089 Summary 00090 Create a measurement set from a uvfits file 00091 00092 Input Parameters: 00093 msfile Filename for the newly created measurement set 00094 fitsfile uvfits file to read 00095 nomodify open for read access only true 00096 lock lock the table for exclusive use false 00097 obstype specify the observation type: 0=standard, 1=fastmosaic, requiring small tiles in the measurement set 0 00098 host host to start ms tool on (IGNORED!!!) 00099 forcenewserver start a new server tool (IGNORED!!!) false 00100 antnamescheme For VLA only, antenna name scheme, old style is just antenna number, new style prepends VA or EV old old new 00101 00102 -------------------------------------------------------------------------------- 00103 00104 """ 00105 return _ms.ms_fromfits(self, *args, **kwargs) 00106 00107 def fromfitsidi(self, *args, **kwargs): 00108 """ 00109 fromfitsidi(self, msfile=string(""), fitsfile=string(""), nomodify=True, lock=False, obstype=0) -> bool 00110 00111 Summary 00112 Create a measurement set from a fits-idi file 00113 00114 Input Parameters: 00115 msfile Filename for the newly created measurement set 00116 fitsfile fits-idi file to read 00117 nomodify open for read access only true 00118 lock lock the table for exclusive use false 00119 obstype specify the observation type: 0=standard, 1=fastmosaic, requiring small tiles in the measurement set 0 00120 00121 -------------------------------------------------------------------------------- 00122 00123 """ 00124 return _ms.ms_fromfitsidi(self, *args, **kwargs) 00125 00126 def listfits(self, *args, **kwargs): 00127 """ 00128 listfits(self, fitsfile) -> bool 00129 00130 Summary 00131 00132 00133 00134 Input Parameters: 00135 fitsfile list HDU and typical data rows in a fits file 00136 00137 -------------------------------------------------------------------------------- 00138 00139 """ 00140 return _ms.ms_listfits(self, *args, **kwargs) 00141 00142 def createmultims(self, *args, **kwargs): 00143 """ 00144 createmultims(self, outputTableName, tables, subtables, nomodify=True, lock=False, copysubtables=False, 00145 omitsubtables=std::vector< string >(1, "")) -> bool 00146 00147 Summary 00148 00149 00150 00151 Input Parameters: 00152 outputTableName 00153 tables 00154 subtables 00155 nomodify prevent changes to the measurement set true 00156 lock lock the table for exclusive use by this tool false 00157 copysubtables copy the subtables from the first to all other member MSs false 00158 omitsubtables Omit the subtables from this list when copying subtables 00159 00160 -------------------------------------------------------------------------------- 00161 00162 """ 00163 return _ms.ms_createmultims(self, *args, **kwargs) 00164 00165 def ismultims(self): 00166 """ 00167 ismultims(self) -> bool 00168 00169 Summary 00170 00171 00172 -------------------------------------------------------------------------------- 00173 00174 """ 00175 return _ms.ms_ismultims(self) 00176 00177 def getreferencedtables(self): 00178 """ 00179 getreferencedtables(self) -> std::vector< std::string > 00180 00181 Summary 00182 00183 00184 -------------------------------------------------------------------------------- 00185 00186 """ 00187 return _ms.ms_getreferencedtables(self) 00188 00189 def nrow(self, selected=False): 00190 """ 00191 nrow(self, selected=False) -> int 00192 00193 Summary 00194 Returns the number of rows in the measurement set 00195 00196 Input Parameters: 00197 selected return number of selected rows false 00198 00199 -------------------------------------------------------------------------------- 00200 00201 """ 00202 return _ms.ms_nrow(self, selected) 00203 00204 def iswritable(self): 00205 """ 00206 iswritable(self) -> bool 00207 00208 Summary 00209 Returns True is the underlying Table is 00210 writable 00211 -------------------------------------------------------------------------------- 00212 00213 """ 00214 return _ms.ms_iswritable(self) 00215 00216 def open(self, *args, **kwargs): 00217 """ 00218 open(self, thems=string(""), nomodify=True, lock=False) -> bool 00219 00220 Summary 00221 Attach the ms tool to a measurement set table 00222 00223 Input Parameters: 00224 thems Name of the measurement set table to open 00225 nomodify prevent changes to the measurement set true 00226 lock lock the table for exclusive use by this tool false 00227 00228 -------------------------------------------------------------------------------- 00229 00230 """ 00231 return _ms.ms_open(self, *args, **kwargs) 00232 00233 def reset(self): 00234 """ 00235 reset(self) -> bool 00236 00237 Summary 00238 Re-attach the tool to the original MS. 00239 -------------------------------------------------------------------------------- 00240 00241 """ 00242 return _ms.ms_reset(self) 00243 00244 def close(self): 00245 """ 00246 close(self) -> bool 00247 00248 Summary 00249 Detach the ms tool from the measurement set table 00250 -------------------------------------------------------------------------------- 00251 00252 """ 00253 return _ms.ms_close(self) 00254 00255 def name(self): 00256 """ 00257 name(self) -> string 00258 00259 Summary 00260 Name of the measurement set table the tool is attached to. 00261 -------------------------------------------------------------------------------- 00262 00263 """ 00264 return _ms.ms_name(self) 00265 00266 def tofits(self, *args, **kwargs): 00267 """ 00268 tofits(self, fitsfile=string(""), column=string("corrected"), field=initialize_variant(""), spw=initialize_variant(""), 00269 width=1, baseline=initialize_variant(""), time=string(""), 00270 scan=initialize_variant(""), uvrange=initialize_variant(""), taql=string(""), 00271 writesyscal=False, multisource=False, combinespw=False, writestation=False, 00272 padwithflags=False) -> bool 00273 00274 Summary 00275 Convert a measurement set to a uvfits file 00276 00277 Input Parameters: 00278 fitsfile Name of the new uvfits file 00279 column Data column to write, see above for options corrected 00280 field Field ids (0-based) or fieldnames to split out 00281 spw Spectral windows to split 00282 width number of input channels to average 1 00283 baseline Antenna names or Antenna indices to select 00284 time Limit data selected to be within a given time range. Syntax is the defined in the msselection link 00285 scan Limit data selected on scan numbers. Syntax is the defined in the msselection link 00286 uvrange Limit data selected on uv distance. Syntax is the defined in the msselection link 00287 taql For the TAQL experts, flexible data selection using the TAQL syntax 00288 writesyscal Write GC and TY tables false 00289 multisource Write in multisource format false 00290 combinespw Export spectral windows as IFs false 00291 writestation Write station name instead of antenna name false 00292 padwithflags If combinespw==True, pad data with flags to fit IFs false 00293 00294 -------------------------------------------------------------------------------- 00295 00296 """ 00297 return _ms.ms_tofits(self, *args, **kwargs) 00298 00299 def summary(self, *args, **kwargs): 00300 """ 00301 summary(self, verbose=False, listfile=string("")) -> record * 00302 00303 Summary 00304 (PARTIALLY IMPLEMENTED!!!) Summarize the measurement set 00305 00306 Input Parameters: 00307 verbose Produce verbose logging output false 00308 listfile Output file 00309 00310 -------------------------------------------------------------------------------- 00311 00312 """ 00313 return _ms.ms_summary(self, *args, **kwargs) 00314 00315 def getscansummary(self): 00316 """ 00317 getscansummary(self) -> record * 00318 00319 Summary 00320 Get the summary of the ms 00321 -------------------------------------------------------------------------------- 00322 00323 """ 00324 return _ms.ms_getscansummary(self) 00325 00326 def getspectralwindowinfo(self): 00327 """ 00328 getspectralwindowinfo(self) -> record * 00329 00330 Summary 00331 Get a summary of the spectral windows 00332 -------------------------------------------------------------------------------- 00333 00334 """ 00335 return _ms.ms_getspectralwindowinfo(self) 00336 00337 def listhistory(self): 00338 """ 00339 listhistory(self) -> bool 00340 00341 Summary 00342 List history of the measurement set 00343 -------------------------------------------------------------------------------- 00344 00345 """ 00346 return _ms.ms_listhistory(self) 00347 00348 def writehistory(self, *args, **kwargs): 00349 """ 00350 writehistory(self, message=string(""), parms=string(""), origin=string("MSHistoryHandler::addMessage()"), 00351 msname=string(""), app=string("ms")) -> bool 00352 00353 Summary 00354 Add a row of arbitrary information to the measurement set history table 00355 00356 Input Parameters: 00357 message Message to be recorded in message field 00358 parms String to be written to input parameter field 00359 origin String to be written to origin field MSHistoryHandler::addMessage() 00360 msname name of selected measurement set 00361 app String to be written to application field ms 00362 00363 -------------------------------------------------------------------------------- 00364 00365 """ 00366 return _ms.ms_writehistory(self, *args, **kwargs) 00367 00368 def statistics(self, *args, **kwargs): 00369 """ 00370 statistics(self, column=string(""), complex_value=string(""), useflags=True, spw=string(""), field=string(""), 00371 baseline=string(""), uvrange=string(""), time=string(""), correlation=string(""), 00372 scan=string(""), array=string(""), obs=string("")) -> record * 00373 00374 Summary 00375 Get statistics on the selected measurement set 00376 00377 Input Parameters: 00378 column Column name 00379 complex_value Which derived value to use for complex columns (amp, amplitude, phase, imag, real, imaginary) 00380 useflags Use the data flags true 00381 spw Spectral Window Indices or names : example : '1,2' 00382 field Field indices or source names : example : '2,3C48' 00383 baseline Baseline number(s): example: '2&3;4&5' 00384 uvrange UV-distance range, with a unit : example : '2.0-3000.0 m' 00385 time Time range, as MJDs or date strings : example : 'xx.x.x.x.x~yy.y.y.y.y' 00386 correlation Correlations/polarizations : example : 'RR,LL,RL,LR,XX,YY,XY,YX' 00387 scan Scan number : example : '1,2,3' 00388 array Array Indices or names : example : 'VLAA' 00389 obs Observation ID(s): examples : '' or '1~3' 00390 00391 -------------------------------------------------------------------------------- 00392 00393 """ 00394 return _ms.ms_statistics(self, *args, **kwargs) 00395 00396 def range(self, *args, **kwargs): 00397 """ 00398 range(self, items=std::vector< string >(1, ""), useflags=True, blocksize=10) -> record * 00399 00400 Summary 00401 Get the range of values in the measurement set 00402 00403 Input Parameters: 00404 items Item names 00405 useflags Use the data flags true 00406 blocksize Set the blocksize in MB 10 00407 00408 -------------------------------------------------------------------------------- 00409 00410 """ 00411 return _ms.ms_range(self, *args, **kwargs) 00412 00413 def lister(self, *args, **kwargs): 00414 """ 00415 lister(self, options=string(""), datacolumn=string("data"), field=string(""), spw=string(""), 00416 antenna=string(""), timerange=string(""), correlation=string(""), scan=string(""), 00417 feed=string(""), array=string(""), observation=string(""), uvrange=string(""), 00418 average=string(""), showflags=False, msselect=string(""), pagerows=50, 00419 listfile=string("")) -> bool 00420 00421 Summary 00422 List measurement set visibilities 00423 00424 Input Parameters: 00425 options Output options (not yet implemented) 00426 datacolumn Column to list: data, model, corrected, residual data 00427 field Fields 00428 spw Spectral Windows 00429 antenna Antenna/Baselines 00430 timerange Time range 00431 correlation Polarization correlations 00432 scan Scan 00433 feed Feed (not yet implemented) 00434 array Array 00435 observation Select by observation ID(s) 00436 uvrange uv-distance (output units: wavelength) 00437 average Average mode (not yet implemented) 00438 showflags Showflags (not yet implemented) false 00439 msselect TaQL expression 00440 pagerows Rows per page 50 00441 listfile Output file 00442 00443 -------------------------------------------------------------------------------- 00444 00445 """ 00446 return _ms.ms_lister(self, *args, **kwargs) 00447 00448 def metadata(self): 00449 """ 00450 metadata(self) -> casac::msmetadata * 00451 00452 Summary 00453 Get the MS metadata associated with this MS. 00454 -------------------------------------------------------------------------------- 00455 00456 """ 00457 return _ms.ms_metadata(self) 00458 00459 def selectinit(self, datadescid=0, reset=False): 00460 """ 00461 selectinit(self, datadescid=0, reset=False) -> bool 00462 00463 Summary 00464 Initialize the selection of an ms 00465 00466 Input Parameters: 00467 datadescid Data description id 0 00468 reset Reset to unselected state false 00469 00470 -------------------------------------------------------------------------------- 00471 00472 """ 00473 return _ms.ms_selectinit(self, datadescid, reset) 00474 00475 def msselect(self, *args, **kwargs): 00476 """ 00477 msselect(self, items=initialize_record(""), onlyparse=False) -> bool 00478 00479 Summary 00480 Use the MSSelection module for data selection. 00481 00482 Input Parameters: 00483 items Record with fields contain the selection experessions. Keys recognized in the record are: 'spw', 'time', 'field', 'baseline', 'scan', 'scanintent', 'polarization', 'observation', 'array', 'uvdist' and 'taql'. 00484 onlyparse If set to True, expressions will only be parsed but not applied to the MS for selection. When set to False, a selected MS will also be generated internally. Default is False. When only parsing is requested, the selected-MS is the same as the original MS. false 00485 00486 -------------------------------------------------------------------------------- 00487 00488 """ 00489 return _ms.ms_msselect(self, *args, **kwargs) 00490 00491 def msselectedindices(self): 00492 """ 00493 msselectedindices(self) -> record * 00494 00495 Summary 00496 00497 Return the selected indices of the MS database. The keys in 00498 the record are the same as those used in msselect function 00499 (i.e. 'spw', 'time', 'field', 'baseline', 'scan', 'scanintent', 00500 'polarization' and 'uvdist'). 00501 00502 -------------------------------------------------------------------------------- 00503 00504 """ 00505 return _ms.ms_msselectedindices(self) 00506 00507 def select(self, *args, **kwargs): 00508 """ 00509 select(self, items=initialize_record("")) -> bool 00510 00511 Summary 00512 Select a subset of the measurement set. 00513 00514 Input Parameters: 00515 items record with fields contain ranges and enumerations 00516 00517 -------------------------------------------------------------------------------- 00518 00519 """ 00520 return _ms.ms_select(self, *args, **kwargs) 00521 00522 def selecttaql(self, *args, **kwargs): 00523 """ 00524 selecttaql(self, msselect=string("")) -> bool 00525 00526 Summary 00527 Select a subset of the measurement set. 00528 00529 Input Parameters: 00530 msselect TaQL selection string 00531 00532 -------------------------------------------------------------------------------- 00533 00534 """ 00535 return _ms.ms_selecttaql(self, *args, **kwargs) 00536 00537 def selectchannel(self, nchan=1, start=0, width=1, inc=1): 00538 """ 00539 selectchannel(self, nchan=1, start=0, width=1, inc=1) -> bool 00540 00541 Summary 00542 Select and average frequency channels 00543 00544 Input Parameters: 00545 nchan Number of output channels, positive integer 1 00546 start First input channel to use, positive integer 0 00547 width Number of input channels to average together, positive integer 1 00548 inc Increment to next (group of) input channel(s), positive integer 1 00549 00550 -------------------------------------------------------------------------------- 00551 00552 """ 00553 return _ms.ms_selectchannel(self, nchan, start, width, inc) 00554 00555 def selectpolarization(self, *args, **kwargs): 00556 """ 00557 selectpolarization(self, wantedpol=std::vector< string >(1, "")) -> bool 00558 00559 Summary 00560 Selection and convertion of polarizations 00561 00562 Input Parameters: 00563 wantedpol The polarizations wanted 00564 00565 -------------------------------------------------------------------------------- 00566 00567 """ 00568 return _ms.ms_selectpolarization(self, *args, **kwargs) 00569 00570 def regridspw(self, *args, **kwargs): 00571 """ 00572 regridspw(self, outframe=string("LSRK"), mode=string("chan"), restfreq=-3E30, interpolation=string("LINEAR"), 00573 start=-3E30, center=-3E30, bandwidth=-1., chanwidth=-1., hanning=True) -> bool 00574 00575 Summary 00576 transform spectral data to different reference frame and/or regrid the frequency channels 00577 00578 00579 Input Parameters: 00580 outframe Name of the reference frame to transform to (LSRK, LSRD, BARY, GALACTO, LGROUP, CMB, GEO, or TOPO). If no reference frame is given, the present reference frame given by the data is used, i.e. the reference frame is not changed. The observatory position is taken as the average of all antenna positions. LSRK 00581 mode The quantity (radio velocity (m/s), optical velocity (m/s), frequency (Hz), wavelength (m), or original channels) in which the user would like to give the regridding parameters below ('center', 'chanwidth', 'bandwidth'): vrad, vopt, freq, wave, or chan. chan 00582 restfreq Required in case the value of mode is 'vrad' or 'vopt': Rest frequency (Hz) for the conversion of the regrid parameters 'center', 'chanwidth', and 'bandwidth' to frequencies. -3E30 00583 interpolation Name of the interpolation method (NEAREST, LINEAR, SPLINE, CUBIC, FFTSHIFT) used in the regridding. Flagging information is combined using 'inclusive or'. LINEAR 00584 start Desired lower edge of the spectral window after regridding in the units given by 'mode' and in the reference frame given by 'outframe'. If no value is given, it is determined from 'center' and 'bandwidth'. -3E30 00585 center (Alternative to setting the parameter 'start'.) Desired center of the spectral window after regridding in the units given by 'mode' and in the reference frame given by 'outframe'. If no value is given, the center is determined from 'start' and 'bandwidth' or, if 'start' is not given either, it is kept as it is. -3E30 00586 bandwidth Desired width of the entire spectral window after regridding in the units given by 'mode' and in the reference frame given by 'outframe'. If no value is given or the given width is larger than the bandwidth of the data, the width will be truncated to the maximum width possible symmetrically around the value given by 'center'. -1. 00587 chanwidth Desired width of the channels in the units given by 'mode' and in the reference frame given by 'outframe'. This implies that channels will be equidistant in the unit given by 'mode'. If no value is given and 'mode' is vrad or freq, the function will keep the resolution as it is. If 'mode' is vopt or wave, the total number of channels will be kept as is. -1. 00588 hanning If true, perform hanning smoothing before regridding. true 00589 00590 -------------------------------------------------------------------------------- 00591 00592 """ 00593 return _ms.ms_regridspw(self, *args, **kwargs) 00594 00595 def cvel(self, *args, **kwargs): 00596 """ 00597 cvel(self, mode=string("channel"), nchan=-1, start=initialize_variant("0"), width=initialize_variant("1"), 00598 interp=string("linear"), phasec=initialize_variant(""), restfreq=initialize_variant("1.4GHz"), 00599 outframe=string(""), veltype=string("radio"), 00600 hanning=True) -> bool 00601 00602 Summary 00603 transform spectral data to different reference frame and/or regrid the frequency channels 00604 00605 00606 Input Parameters: 00607 mode 'channel', 'velocity', 'frequency', or 'channel_b', default = 'channel' channel 00608 nchan number of channels, default = -1 = all -1 00609 start start channel, default = 0 0 00610 width new channel width, default = 1 1 00611 interp interpolation method 'nearest', 'linear', 'spline', 'cubic', 'fftshift', default = linear linear 00612 phasec phase center, default = first field 00613 restfreq rest frequency, default = 1.4GHz 1.4GHz 00614 outframe LSRK, LSRD, BARY, GALACTO, LGROUP, CMB, GEO, or TOPO, default = '' = keep reference frame. 00615 veltype radio or optical, default = radio radio 00616 hanning If true, perform hanning smoothing before regridding. true 00617 00618 -------------------------------------------------------------------------------- 00619 00620 """ 00621 return _ms.ms_cvel(self, *args, **kwargs) 00622 00623 def cvelfreqs(self, *args, **kwargs): 00624 """ 00625 cvelfreqs(self, spwids=initialize_vector(1, (int)0), fieldids=initialize_vector(1, (int)0), obstime=string(""), 00626 mode=string("channel"), nchan=-1, start=initialize_variant("0"), 00627 width=initialize_variant("1"), phasec=initialize_variant("0"), restfreq=initialize_variant("1.4GHz"), 00628 outframe=string(""), veltype=string("radio")) -> std::vector< double > 00629 00630 Summary 00631 calculate the transformed grid of the SPW obtained by combining a given set of SPWs (MS is not modified) 00632 00633 00634 Input Parameters: 00635 spwids The list of ids of the spectral windows from which the input grid is to be taken. 0 00636 fieldids The list of ids of the fields which are selected (for observation time determination), default: all 0 00637 obstime the observation time to assume, default: time of the first row of the MS = 00638 mode 'channel', 'velocity', 'frequency', or 'channel_b', default = channel 00639 nchan number of channels, default = all = -1 00640 start start channel, default = 0 00641 width new channel width, default = 1 00642 phasec phase center, default = first field = 0 00643 restfreq rest frequency, default = 1.4GHz 00644 outframe LSRK, LSRD, BARY, GALACTO, LGROUP, CMB, GEO, or TOPO, default = keep reference frame = 00645 veltype radio or optical, default = radio 00646 00647 -------------------------------------------------------------------------------- 00648 00649 """ 00650 return _ms.ms_cvelfreqs(self, *args, **kwargs) 00651 00652 def getdata(self, *args, **kwargs): 00653 """ 00654 getdata(self, items=std::vector< string >(1, ""), ifraxis=False, ifraxisgap=0, increment=1, average=False) -> record * 00655 00656 Summary 00657 Read values from the measurement set. 00658 00659 Input Parameters: 00660 items Item names 00661 ifraxis Create interferometer axis if True false 00662 ifraxisgap Gap size on ifr axis when antenna1 changes 0 00663 increment Row increment for data access 1 00664 average Average the data in time or over rows false 00665 00666 -------------------------------------------------------------------------------- 00667 00668 """ 00669 return _ms.ms_getdata(self, *args, **kwargs) 00670 00671 def putdata(self, *args, **kwargs): 00672 """ 00673 putdata(self, items=initialize_record("")) -> bool 00674 00675 Summary 00676 Write new values into the measurement set 00677 00678 Input Parameters: 00679 items Record with items and their new values 00680 00681 -------------------------------------------------------------------------------- 00682 00683 """ 00684 return _ms.ms_putdata(self, *args, **kwargs) 00685 00686 def concatenate(self, *args, **kwargs): 00687 """ 00688 concatenate(self, msfile=string(""), freqtol=initialize_variant("1Hz"), dirtol=initialize_variant("1mas"), 00689 weightscale=1., handling=0, destmsfile=string(""), respectname=False) -> bool 00690 00691 Summary 00692 Concatenate two measurement sets 00693 00694 Input Parameters: 00695 msfile The name of the measurement set to append 00696 freqtol Frequency difference within which 2 spectral windows are considered similar; e.g '10Hz' 1Hz 00697 dirtol Direction difference within which 2 fields are considered the same; e.g '1mas' 1mas 00698 weightscale Scale the weights of the MS to be appended by this factor 1. 00699 handling Switch for the handling of the Main and Pointing tables: 0=standard, 1=no Main, 2=no Pointing, 3=no Main and Pointing, 4=virtual 0 0 1 2 3 00700 destmsfile Optional support for virtual concat: empty table (no subtables) where to store the appended MS copy 00701 respectname If true, fields with a different name are not merged even if their direction agrees false 00702 00703 -------------------------------------------------------------------------------- 00704 00705 """ 00706 return _ms.ms_concatenate(self, *args, **kwargs) 00707 00708 def testconcatenate(self, *args, **kwargs): 00709 """ 00710 testconcatenate(self, msfile=string(""), freqtol=initialize_variant("1Hz"), dirtol=initialize_variant("1mas"), 00711 respectname=False) -> bool 00712 00713 Summary 00714 Concatenate only the subtables of two measurement sets excluding the POINTING table (resulting MAIN and POINTING table not useful) 00715 00716 Input Parameters: 00717 msfile The name of the measurement set from which the subtables should be appended 00718 freqtol Frequency difference within which 2 spectral windows are considered similar; e.g '10Hz' 1Hz 00719 dirtol Direction difference within which 2 fields are considered the same; e.g '1mas' 1mas 00720 respectname If true, fields with a different name are not merged even if their direction agrees false 00721 00722 -------------------------------------------------------------------------------- 00723 00724 """ 00725 return _ms.ms_testconcatenate(self, *args, **kwargs) 00726 00727 def virtconcatenate(self, *args, **kwargs): 00728 """ 00729 virtconcatenate(self, msfile=string(""), auxfilename=string(""), freqtol=initialize_variant("1Hz"), dirtol=initialize_variant("1mas"), 00730 weightscale=1., respectname=True) -> bool 00731 00732 Summary 00733 Concatenate two measurement sets virtually 00734 00735 Input Parameters: 00736 msfile The name of the measurement set to append 00737 auxfilename The name of a auxiliary file which is needed when more than two MSs are to be concatenated. 00738 freqtol Frequency difference within which 2 spectral windows are considered similar; e.g '10Hz' 1Hz 00739 dirtol Direction difference within which 2 fields are considered the same; e.g '1mas' 1mas 00740 weightscale Scale the weights of the MS to be appended by this factor 1. 00741 respectname If true, fields with a different name are not merged even if their direction agrees true 00742 00743 -------------------------------------------------------------------------------- 00744 00745 """ 00746 return _ms.ms_virtconcatenate(self, *args, **kwargs) 00747 00748 def timesort(self, *args, **kwargs): 00749 """ 00750 timesort(self, newmsname=string("")) -> bool 00751 00752 Summary 00753 Sort the main table of an MS by time 00754 00755 Input Parameters: 00756 newmsname Name of the output measurement set (default: overwrite original) 00757 00758 -------------------------------------------------------------------------------- 00759 00760 """ 00761 return _ms.ms_timesort(self, *args, **kwargs) 00762 00763 def contsub(self, *args, **kwargs): 00764 """ 00765 contsub(self, outputms=string(""), fitspw=initialize_variant("*"), fitorder=1, combine=string(""), 00766 spw=initialize_variant("*"), unionspw=initialize_variant("*"), field=initialize_variant(""), 00767 scan=initialize_variant(""), intent=string(""), correlation=string(""), 00768 obs=string(""), whichcol=string("CORRECTED_DATA")) -> bool 00769 00770 Summary 00771 Subtract the continuum from the visibilities 00772 00773 Input Parameters: 00774 outputms The name of the resulting measurement set 00775 fitspw Line-free spectral windows (and :channels) to fit to * 00776 fitorder The order of the polynomial to use when fitting. 1 00777 combine Ignore changes in these columns (spw, scan, and/or state) when fitting. 00778 spw Spectral windows (and :channels) to select * 00779 unionspw The union of fitspw and spw, i.e. how much needs to be read. '*' always works, but may be more than you need. * 00780 field Fields to include, by names or 0-based ids. ('' => all) 00781 scan Only use the scan numbers requested using the msselection syntax. 00782 intent Only use the requested scan intents. 00783 correlation Limit data to specific correlations (LL, XX, LR, XY, etc.). 00784 obs Only use the requested observation IDs. 00785 whichcol 'DATA', 'MODEL_DATA', 'CORRECTED_DATA', and/or 'FLOAT_DATA' CORRECTED_DATA 00786 00787 -------------------------------------------------------------------------------- 00788 00789 """ 00790 return _ms.ms_contsub(self, *args, **kwargs) 00791 00792 def statwt(self, *args, **kwargs): 00793 """ 00794 statwt(self, dorms=False, byantenna=True, sepacs=True, fitspw=initialize_variant("*"), fitcorr=initialize_variant(""), 00795 combine=string(""), timebin=initialize_variant("0s"), 00796 minsamp=3, field=initialize_variant(""), spw=initialize_variant("*"), antenna=initialize_variant(""), 00797 timerange=string(""), scan=initialize_variant(""), 00798 intent=string(""), array=initialize_variant(""), correlation=string(""), 00799 obs=string(""), datacolumn=string("corrected_data")) -> bool 00800 00801 Summary 00802 Set WEIGHT and SIGMA from the scatter of the visibilities 00803 00804 Input Parameters: 00805 dorms How the scatter should be estimated (True -> rms, False -> stddev) false 00806 byantenna How the scatters are solved for (by antenna or by baseline) true 00807 sepacs If solving by antenna, treat autocorrs separately true 00808 fitspw Line-free spectral windows (and :channels) to get the scatter from. ('' => all) * 00809 fitcorr Correlations (V, LL, XX, LR, XY, etc.) to get the scatter from. ('' => all) 00810 combine Ignore changes in these columns (spw, scan, and/or state) when getting the scatter. 00811 timebin Duration of the moving window over which to estimate the scatter. Defaults to 0s, with an effective minimum of 1 integration. 0s 00812 minsamp The minimum number of visibilities for a scatter estimate 3 00813 field Fields to reweight, by names or 0-based ids. ('' => all) 00814 spw Spectral windows to reweight. ('' => all) * 00815 antenna Select data based on antenna/baseline 00816 timerange Select data by time range 00817 scan Scan numbers to reweight. ('' => all) 00818 intent Scan intents to reweight. ('' => all) 00819 array Select (sub)array(s) by array ID number 00820 correlation Correlations (LL, XX, LR, XY, etc.) to reweight. ('' => all) 00821 obs Observation IDs to reweight. ('' => all) 00822 datacolumn Which data column to calculate the scatter from. corrected_data 00823 00824 -------------------------------------------------------------------------------- 00825 00826 """ 00827 return _ms.ms_statwt(self, *args, **kwargs) 00828 00829 def split(self, *args, **kwargs): 00830 """ 00831 split(self, outputms=string(""), field=initialize_variant(""), spw=initialize_variant("*"), step=initialize_vector(1, (int)1), 00832 baseline=initialize_variant(""), timebin=initialize_variant("-1s"), 00833 time=string(""), scan=initialize_variant(""), uvrange=initialize_variant(""), 00834 taql=string(""), whichcol=string("DATA"), tileshape=initialize_variant(""), 00835 subarray=initialize_variant(""), combine=string(""), 00836 correlation=string(""), intent=string(""), obs=string("")) -> bool 00837 00838 Summary 00839 make a new ms from a subset of an existing ms, adjusting subtables and indices 00840 00841 Input Parameters: 00842 outputms The name of the resulting measurement set 00843 field Fields to include, by names or 0-based ids. ('' => all) 00844 spw Spectral windows (and :channels) to select * 00845 step number of input per output channels - Int vector of length 1 or same as spw 1 00846 baseline Antenna names or indices to select ('' => all) 00847 timebin Duration for averaging. Defaults to no averaging. -1s 00848 time Only use data in the given time range, using the msselection syntax. 00849 scan Only use the scan numbers requested using the msselection syntax. 00850 uvrange Limit data by uv distance using the msselection syntax. 00851 taql For the TAQL experts, flexible data selection using the TAQL syntax 00852 whichcol 'DATA', 'MODEL_DATA', 'CORRECTED_DATA', 'FLOAT_DATA', 'LAG_DATA', and/or 'all' DATA 00853 tileshape Tile shape of the disk data columns, most users should not need to touch this parameter [0] => normal tiling, [1] => fast mosaic style tile [4,15,351] => a tile shape of 4 pol 15 chan and 351 rows 00854 subarray Limit data to specific (sub)array numbers. 00855 combine Ignore changes in these columns (scan, and/or state) when time averaging. 00856 correlation Limit data to specific correlations (LL, XX, LR, XY, etc.). 00857 intent Only use the requested scan intents. 00858 obs Only use the requested observation IDs. 00859 00860 -------------------------------------------------------------------------------- 00861 00862 """ 00863 return _ms.ms_split(self, *args, **kwargs) 00864 00865 def partition(self, *args, **kwargs): 00866 """ 00867 partition(self, outputms=string(""), field=initialize_variant(""), spw=initialize_variant("*"), baseline=initialize_variant(""), 00868 timebin=initialize_variant("-1s"), time=string(""), 00869 scan=initialize_variant(""), uvrange=initialize_variant(""), taql=string(""), 00870 whichcol=string("DATA"), tileshape=initialize_variant(""), subarray=initialize_variant(""), 00871 combine=string(""), intent=string(""), obs=string("")) -> bool 00872 00873 Summary 00874 make a new ms from a subset of an existing ms, without changing any subtables 00875 00876 Input Parameters: 00877 outputms The name of the resulting measurement set 00878 field Fields to include, by names or 0-based ids. ('' => all) 00879 spw Spectral windows (and :channels) to select * 00880 baseline Antenna names or indices to select ('' => all) 00881 timebin Duration for averaging. Defaults to no averaging. -1s 00882 time Only use data in the given time range, using the msselection syntax. 00883 scan Only use the scan numbers requested using the msselection syntax. 00884 uvrange Limit data by uv distance using the msselection syntax. 00885 taql For the TAQL experts, flexible data selection using the TAQL syntax 00886 whichcol 'DATA', 'MODEL_DATA', 'CORRECTED_DATA', 'FLOAT_DATA', 'LAG_DATA', and/or 'all' DATA 00887 tileshape Tile shape of the disk data columns, most users should not need to touch this parameter [0] => normal tiling, [1] => fast mosaic style tile [4,15,351] => a tile shape of 4 pol 15 chan and 351 rows 00888 subarray Limit data to specific (sub)array numbers. 00889 combine Ignore changes in these columns (scan, and/or state) when time averaging. 00890 intent Only use the requested scan intents. 00891 obs Only use the requested observation IDs. 00892 00893 -------------------------------------------------------------------------------- 00894 00895 """ 00896 return _ms.ms_partition(self, *args, **kwargs) 00897 00898 def iterinit(self, *args, **kwargs): 00899 """ 00900 iterinit(self, columns=std::vector< string >(1, ""), interval=0.0, maxrows=0, adddefaultsortcolumns=True) -> bool 00901 00902 Summary 00903 Initialize for iteration over an ms 00904 00905 Input Parameters: 00906 columns Vector of column names (case sensitive). 00907 interval Time interval in seconds (greater than 0), to group together in iteration 0.0 00908 maxrows Max number of rows (greater than 0) to return in iteration 0 00909 adddefaultsortcolumns Add the default sort columns true 00910 00911 -------------------------------------------------------------------------------- 00912 00913 """ 00914 return _ms.ms_iterinit(self, *args, **kwargs) 00915 00916 def iterorigin(self): 00917 """ 00918 iterorigin(self) -> bool 00919 00920 Summary 00921 Set the iterator to the start of the data. 00922 -------------------------------------------------------------------------------- 00923 00924 """ 00925 return _ms.ms_iterorigin(self) 00926 00927 def iternext(self): 00928 """ 00929 iternext(self) -> bool 00930 00931 Summary 00932 Advance the iterator to the next lot of data 00933 -------------------------------------------------------------------------------- 00934 00935 """ 00936 return _ms.ms_iternext(self) 00937 00938 def iterend(self): 00939 """ 00940 iterend(self) -> bool 00941 00942 Summary 00943 End the iteration and reset the selected table 00944 -------------------------------------------------------------------------------- 00945 00946 """ 00947 return _ms.ms_iterend(self) 00948 00949 def fillbuffer(self, *args, **kwargs): 00950 """ 00951 fillbuffer(self, item=string(""), ifraxis=False) -> bool 00952 00953 Summary 00954 Fill the internal buffer with data and flags. 00955 00956 Input Parameters: 00957 item data derived item 00958 ifraxis Create interferometer axis if True false 00959 00960 -------------------------------------------------------------------------------- 00961 00962 """ 00963 return _ms.ms_fillbuffer(self, *args, **kwargs) 00964 00965 def diffbuffer(self, *args, **kwargs): 00966 """ 00967 diffbuffer(self, direction=string("TIME"), window=1) -> record * 00968 00969 Summary 00970 Differentiate or difference the internal buffer. 00971 00972 Input Parameters: 00973 direction choose between time or channel direction: TIME or CHANNEL TIME 00974 window width of averaging window in timeslots or channels; integer greater than 0 1 00975 00976 -------------------------------------------------------------------------------- 00977 00978 """ 00979 return _ms.ms_diffbuffer(self, *args, **kwargs) 00980 00981 def getbuffer(self): 00982 """ 00983 getbuffer(self) -> record * 00984 00985 Summary 00986 Return the internal buffer as a Record for access from the intrepreter. 00987 -------------------------------------------------------------------------------- 00988 00989 """ 00990 return _ms.ms_getbuffer(self) 00991 00992 def clipbuffer(self, pixellevel=0.0, timelevel=0.0, channellevel=0.0): 00993 """ 00994 clipbuffer(self, pixellevel=0.0, timelevel=0.0, channellevel=0.0) -> bool 00995 00996 Summary 00997 (NON-FUNCTIONAL???) Clip the internal buffer with specified limits. 00998 00999 Input Parameters: 01000 pixellevel cliplevel for pixels (greater than 0) 0.0 01001 timelevel cliplevel for time slots (greater than 0) 0.0 01002 channellevel cliplevel for channels (greater than 0) 0.0 01003 01004 -------------------------------------------------------------------------------- 01005 01006 """ 01007 return _ms.ms_clipbuffer(self, pixellevel, timelevel, channellevel) 01008 01009 def setbufferflags(self, *args, **kwargs): 01010 """ 01011 setbufferflags(self, flags=initialize_record("")) -> bool 01012 01013 Summary 01014 Set the flags in the buffer 01015 01016 Input Parameters: 01017 flags record with flag and flag\_row 01018 01019 -------------------------------------------------------------------------------- 01020 01021 """ 01022 return _ms.ms_setbufferflags(self, *args, **kwargs) 01023 01024 def writebufferflags(self): 01025 """ 01026 writebufferflags(self) -> bool 01027 01028 Summary 01029 Write the flags in the internal buffer back to the table. 01030 -------------------------------------------------------------------------------- 01031 01032 """ 01033 return _ms.ms_writebufferflags(self) 01034 01035 def clearbuffer(self): 01036 """ 01037 clearbuffer(self) -> bool 01038 01039 Summary 01040 Clear the internal buffer. 01041 -------------------------------------------------------------------------------- 01042 01043 """ 01044 return _ms.ms_clearbuffer(self) 01045 01046 def continuumsub(self, *args, **kwargs): 01047 """ 01048 continuumsub(self, field=initialize_variant(""), fitspw=initialize_variant(""), spw=initialize_variant(""), 01049 solint=initialize_variant("int"), fitorder=0, mode=string("subtract")) -> bool 01050 01051 Summary 01052 Continuum fitting and subtraction in uv plane 01053 01054 Input Parameters: 01055 field Select fields to fit 01056 fitspw Spectral windows/channels to use for fitting the continuum; default all spectral windows in all channels 01057 spw Select spectral windows and channels from which to subtract a continuum estimate; default: all channels in all spectral windows for which the continuum was estimated 01058 solint Continuum fit timescale (units optional) int 01059 fitorder Polynomial order for fit 0 01060 mode Desired use of fit model (see below) subtract 01061 01062 -------------------------------------------------------------------------------- 01063 01064 """ 01065 return _ms.ms_continuumsub(self, *args, **kwargs) 01066 01067 def done(self): 01068 """ 01069 done(self) -> bool 01070 01071 Summary 01072 Closes the ms tool 01073 -------------------------------------------------------------------------------- 01074 01075 """ 01076 return _ms.ms_done(self) 01077 01078 def msseltoindex(self, *args, **kwargs): 01079 """ 01080 msseltoindex(self, vis=string(""), spw=initialize_variant(""), field=initialize_variant(""), baseline=initialize_variant(""), 01081 time=initialize_variant(""), scan=initialize_variant(""), 01082 uvrange=initialize_variant(""), observation=initialize_variant(""), 01083 taql=string("")) -> record * 01084 01085 Summary 01086 Returns ids of the selection used 01087 01088 Input Parameters: 01089 vis Measurementset for which this selection applies 01090 spw Spectral Window Ids (0 relative) to select; -1 interpreted as all 01091 field Field Ids (0 relative) or Field names (msselection syntax and wilcards are used) to select 01092 baseline Antenna Ids (0 relative) or Antenna names (msselection syntax and wilcards are used) to select 01093 time Limit data selected to be within a given time range. Syntax is the defined in the msselection link 01094 scan Limit data selected on scan numbers. Syntax is the defined in the msselection link 01095 uvrange Limit data selected on uv distance. Syntax is the defined in the msselection link 01096 observation Select data by observation ID(s). The syntax is the same as for scan numbers. 01097 taql For the TAQL experts, flexible data selection using the TAQL syntax 01098 01099 -------------------------------------------------------------------------------- 01100 01101 """ 01102 return _ms.ms_msseltoindex(self, *args, **kwargs) 01103 01104 def hanningsmooth(self, *args, **kwargs): 01105 """ 01106 hanningsmooth(self, datacolumn=string("corrected")) -> bool 01107 01108 Summary 01109 Hanning smooth the frequency channels to remove Gibbs ringing. 01110 01111 Input Parameters: 01112 datacolumn the name of the MS column into which to write the smoothed data corrected 01113 01114 -------------------------------------------------------------------------------- 01115 01116 """ 01117 return _ms.ms_hanningsmooth(self, *args, **kwargs) 01118 01119 def uvsub(self, reverse=False): 01120 """ 01121 uvsub(self, reverse=False) -> bool 01122 01123 Summary 01124 Subtract model from the corrected visibility data. 01125 01126 Input Parameters: 01127 reverse When False subtracts model from visibility data; when True adds model to visibility data false 01128 01129 -------------------------------------------------------------------------------- 01130 01131 """ 01132 return _ms.ms_uvsub(self, reverse) 01133 01134 def moments(self, *args, **kwargs): 01135 """ 01136 moments(self, moments=initialize_vector(1, (int)0), antenna=initialize_variant(""), field=initialize_variant(""), 01137 spw=initialize_variant(""), includemask=initialize_vector(1, (double)-1), 01138 excludemask=initialize_vector(1, (double)-1), peaksnr=0.0, 01139 stddev=0.0, doppler=string(""), outfile=string(""), overwrite=False, async=False) -> casac::table * 01140 01141 Summary 01142 Calculate moments from MS with FLOAT_DATA column. 01143 01144 Input Parameters: 01145 moments A list of moments that you want to compute. Default is an integrarted spectrum. 0 01146 antenna antenna name or id 01147 field field name or id 01148 spw spectral window id 01149 includemask A range of masks to be included when moments are computed. Default is -1 (all channels). -1 01150 excludemask A range of masks to be excluded when moments are computed. Default is -1 (do not exclude channels). -1 01151 peaksnr The SNR ratio that is a lower limit to be included a moment calculation (not implemented yet). 0.0 01152 stddev Standard deviation of the noise signal in the spectra (used by the window and fit functions only). 0.0 01153 doppler Velocity doppler definition for velocity computations along spectral axes. 01154 outfile Output MS file name (or root for multiple moments). Default is input + an auto-determined suffix. 01155 overwrite Overwrite existing output file. false 01156 async Run asynchronously? false 01157 01158 -------------------------------------------------------------------------------- 01159 01160 """ 01161 return _ms.ms_moments(self, *args, **kwargs) 01162 01163 ms_swigregister = _ms.ms_swigregister 01164 ms_swigregister(ms) 01165 01166 # This file is compatible with both classic and new-style classes. 01167 01168
1.8.0
