00001
00002
00003
00004
00005
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('_msplot', [dirname(__file__)])
00017 except ImportError:
00018 import _msplot
00019 return _msplot
00020 if fp is not None:
00021 try:
00022 _mod = imp.load_module('_msplot', fp, pathname, description)
00023 finally:
00024 fp.close()
00025 return _mod
00026 _msplot = swig_import_helper()
00027 del swig_import_helper
00028 else:
00029 import _msplot
00030 del version_info
00031 try:
00032 _swig_property = property
00033 except NameError:
00034 pass
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 msplot(_object):
00071 """Proxy of C++ casac::msplot class"""
00072 __swig_setmethods__ = {}
00073 __setattr__ = lambda self, name, value: _swig_setattr(self, msplot, name, value)
00074 __swig_getmethods__ = {}
00075 __getattr__ = lambda self, name: _swig_getattr(self, msplot, name)
00076 __repr__ = _swig_repr
00077 def __init__(self):
00078 """__init__(self) -> msplot"""
00079 this = _msplot.new_msplot()
00080 try: self.this.append(this)
00081 except: self.this = this
00082 __swig_destroy__ = _msplot.delete_msplot
00083 __del__ = lambda self : None;
00084 def open(self, *args, **kwargs):
00085 """
00086 open(self, msname=string(""), dovel=False, restfreq=string(""), frame=string(""), doppler=string("")) -> bool
00087
00088 Summary
00089
00090 Set the measurement set to be plotted.
00091
00092
00093 Input Parameters:
00094 msname measurement set name, including path
00095 dovel whether to calculate velocity or not false
00096 restfreq a rest frequency quanta or transition name
00097 frame frequency frame for spectral axis
00098 doppler doppler mode
00099
00100 --------------------------------------------------------------------------------
00101
00102 """
00103 return _msplot.msplot_open(self, *args, **kwargs)
00104
00105 def clearplot(self, subplot=000):
00106 """
00107 clearplot(self, subplot=000) -> bool
00108
00109 Summary
00110 Clear the plotting window or a particular panel,
00111 or all panels.
00112
00113
00114 Input Parameters:
00115 subplot Three (or four) digits number: first digit for nrows, second for ncols, the rest for pannel number. 000
00116
00117 --------------------------------------------------------------------------------
00118
00119 """
00120 return _msplot.msplot_clearplot(self, subplot)
00121
00122 def emperorsNewClose(self):
00123 """
00124 emperorsNewClose(self) -> bool
00125
00126 Summary
00127 Like the Emperor's New Clothes.
00128
00129 --------------------------------------------------------------------------------
00130
00131 """
00132 return _msplot.msplot_emperorsNewClose(self)
00133
00134 def reset(self):
00135 """
00136 reset(self) -> bool
00137
00138 Summary
00139 Reset the state of MS plot back to its default state.
00140
00141 --------------------------------------------------------------------------------
00142
00143 """
00144 return _msplot.msplot_reset(self)
00145
00146 def closeMS(self):
00147 """
00148 closeMS(self) -> bool
00149
00150 Summary
00151 Close the measurement set being used.
00152
00153 --------------------------------------------------------------------------------
00154
00155 """
00156 return _msplot.msplot_closeMS(self)
00157
00158 def close(self):
00159 """
00160 close(self) -> bool
00161
00162 Summary
00163 See done -- close and done do the same thing.
00164
00165 --------------------------------------------------------------------------------
00166
00167 """
00168 return _msplot.msplot_close(self)
00169
00170 def done(self):
00171 """
00172 done(self) -> bool
00173
00174 Summary
00175 Close the current MeasurementSet, and destroy
00176 the plotter -- ending all plotting.
00177
00178 --------------------------------------------------------------------------------
00179
00180 """
00181 return _msplot.msplot_done(self)
00182
00183 def plotoptions(self, *args, **kwargs):
00184 """
00185 plotoptions(self, subplot=111, plotsymbol=string(""), plotcolor=string(""), multicolor=string("none"),
00186 plotrange=string(""), timeplot='o', markersize=8.0, linewidth=1.0, overplot=False,
00187 replacetopplot=False, removeoldpanels=True, skipnrows=1, averagenrows=1,
00188 extendflag=string(""), connect=string("none"), showflags=False, title=string(""),
00189 xlabel=string(""), ylabel=string(""), fontsize=14.0, windowsize=1.0,
00190 aspectratio=1.0) -> bool
00191
00192 Summary
00193
00194 Set the style of the plot.
00195
00196
00197 Input Parameters:
00198 subplot Three (or four) digits number: first digit for nx, second for ny, the rest for pannel number. 111
00199 plotsymbol String specifying the colour to plot in, as well as the symbol to plot. This argument takes the same values as pylab plot command. Some of the valid symbols are: 'o', '+', ...
00200 plotcolor String specifying the colour to plot in. This can be one of the predefined pylab colour names. This over-rides the colour specified in plotsymbol.
00201 multicolor chan: means different channels in different colours, corr: means different correlations in different colours, both: means different correlations and channels in multicolour none: plot everything the same color. none
00202 plotrange Plot data within the specified range of values will be plotted. The range of values is given as a string in the form [xmin, xmax, ymin, ymax]. For most plots the xmin/max and ymin/max values are expected to be numeric values. However, for time plots, ie. where one or more of the axis is time, the xmin/max and ymin/max are expected to be strings in the from YYYY/MM/DD/hh:mm:ss.
00203 timeplot Indicate if the data is to be interpretted as time time values. Valid values are 'o'ff, 'x'-axis, 'y'-axis, 'b'oth axes. . 'o'
00204 markersize Specify the size (in pixels) of the markers being plotted. Markers are specified with the plotsymbol option. . 8.0
00205 linewidth Occasionally lines, rather then points, are plotted. This option allows the width of the plotted lines to be specified in points (pixels). 1.0
00206 overplot To do overplot or not. false
00207 replacetopplot true : when overplot=false, replace the top-most layer only false : overplot=false always creates a fresh stack of plots. false
00208 removeoldpanels true : mimic the native matplotlib behaviour of clearing up plots that lie partially or completely underneath a new panel. false : turn this feature off. Explicit mp.clearplot will then be required. This is provided to allow small plots to be inset into larger plot panels. true
00209 skipnrows Indicates how many points to skip when plotting, ie. it plots every nth point. 1
00210 averagenrows Indicates how many rows to average when plotting, ie. average together every n rows. 1
00211 extendflag A string contains flag extension code. Possible codes are: 'P' for correlation; 'C' for channel; 'B' for baseline; 'W' for spectral window; and 'T' for time.
00212 connect Indicates how to join point with lines when plotsymbol contains '-'. connect='none': points are not connected by lines. connect='row' : points are joined along time and baseline and each channel and correlation is a separate line. connect='chan': points are joined along channel. Each timestamp or baseline is a separate line. This is to be used in conjunction with 'averagenrows' or 'skipnrows' because for a large number of rows, it is inefficient. none
00213 showflags Indicates whether or not to plot flagged and unflagged data. False : plot only unflagged data True : plot only flagged data false
00214 title string for the title of the plot
00215 xlabel string for the X -label of the plot
00216 ylabel string for the Y -label of the plot
00217 fontsize font size of the labels for the plot 14.0
00218 windowsize window size of the plot 1.0
00219 aspectratio aspect ratio of the window size of the plot 1.0
00220
00221 --------------------------------------------------------------------------------
00222
00223 """
00224 return _msplot.msplot_plotoptions(self, *args, **kwargs)
00225
00226 def summary(self, selected=True):
00227 """
00228 summary(self, selected=True) -> bool
00229
00230 Summary
00231
00232 List a short summary, description, of the data in the open
00233 measurment set.
00234
00235
00236 Input Parameters:
00237 selected Determine if we print a summary of the selected (true) data or a summary of the full measurement set (false). true
00238
00239 --------------------------------------------------------------------------------
00240
00241 """
00242 return _msplot.msplot_summary(self, selected)
00243
00244 def setdata(self, *args, **kwargs):
00245 """
00246 setdata(self, baseline=string(""), field=string(""), scan=string(""), uvrange=string(""), array=string(""),
00247 feed=string(""), spw=string(""), correlation=string(""), time=string("")) -> bool
00248
00249 Summary
00250
00251 Select a subset of the measurement set to operate on.
00252
00253
00254 Input Parameters:
00255 baseline Baseline selection expression.
00256 field Field selection string.
00257 scan Scan selection string.
00258 uvrange UV Range selection string.
00259 array Array selection string.
00260 feed Feed selection string.
00261 spw Spectral Window selection string.
00262 correlation Correlation selection string.
00263 time Time selection values are in the form: YYYY\/MM\/MM\/DD\/hh:mm:ss~YYYY\/MM\/DD\/hh:mm:ss\^step where the first or second term may be dropped, and more then one range may be specified. Ranges are separted by a ','. The step value is a real value representing the number of seconds to skip or average, depending on the value given.
00264
00265 --------------------------------------------------------------------------------
00266
00267 """
00268 return _msplot.msplot_setdata(self, *args, **kwargs)
00269
00270 def extendflag(self, *args, **kwargs):
00271 """
00272 extendflag(self, extendcorr=string(""), extendchan=string(""), extendspw=string(""), extendant=string(""),
00273 extendtime=string("")) -> bool
00274
00275 Summary
00276
00277 Set the scope of flagging extension
00278
00279
00280 Input Parameters:
00281 extendcorr Indicate correlation based flagging extension. Valid values are: allhalf
00282 extendchan Indicate channel based flagging extension. Valid values are: all
00283 extendspw Indicate spectral window based flagging extension. Valid values are: all
00284 extendant Indicate antenna (baselines) based flagging extension. Valid values are: all
00285 extendtime Indicate time based flagging extension. Valid values are: all
00286
00287 --------------------------------------------------------------------------------
00288
00289 """
00290 return _msplot.msplot_extendflag(self, *args, **kwargs)
00291
00292 def avedata(self, *args, **kwargs):
00293 """
00294 avedata(self, chanavemode=string("none"), corravemode=string("none"), datacolumn=string("DATA"),
00295 averagemode=string("vector"), averagechan=string("1"), averagetime=string("0"),
00296 averageflagged=False, averagescan=False, averagebl=False, averagearray=False,
00297 averagechanid=False, averagevel=False) -> bool
00298
00299 Summary
00300
00301 Specify which data is to be averaged in the MS (or selected MS).
00302
00303
00304 Input Parameters:
00305 chanavemode Indicate what if any averaging should be done on the selected channels.The channel selection and averaging is done via the spw parameter. Valid values are: none: No averaging, default value step: Plot every nth point scalarstep: incoherent average of every n points vectorstep: coherent average of every n points scalarchunk: incoherent average of blocks with n points vectorchunk: coherent average of blocks with n points none
00306 corravemode Indicate what if any averaging should be done on the selected correlations. See chanavemode for a detailed description of the valid values. Valid values are: none, step, scalarstep, vectorstep, scalarchunk, or vectorchunk none
00307 datacolumn Indicate the visibility data to be averaged. Valid values are: DATA CORRECTEDDATA MODELDATA DATA
00308 averagemode Indicate the mode for channel and/or time averaging. Valid values are: vector scalar vector
00309 averagechan Indicate the number of channels to average. The default value of 1 means no channel averaging. 1
00310 averagetime Indicate the length of time interval to average. Valid values are double values of time in seconds. The default value 0 means no time averaging. 0
00311 averageflagged Indicate either flagged or unflagged data to average. false
00312 averagescan Indicate whether time averaging cross scan boundaries. false
00313 averagebl Indicate whether averaging cross baseline boundaries. false
00314 averagearray Indicate whether averaging cross array boundaries. false
00315 averagechanid Indicate whether using averaged channel id or not. false
00316 averagevel Indicate whether calculating averaged velocity id or not. false
00317
00318 --------------------------------------------------------------------------------
00319
00320 """
00321 return _msplot.msplot_avedata(self, *args, **kwargs)
00322
00323 def plot(self, *args, **kwargs):
00324 """
00325 plot(self, type=string(""), column=string(""), value=string(""), iteration=std::vector< string >(1, "")) -> bool
00326
00327 Input Parameters:
00328 type The type of plot to do. Valid values are strings for each of the msplot function, the valid strings are: 'array' 'azimuth', 'baseline', 'elevation', 'hourangle', 'parallacticangle', 'uvcoverage', 'uvdist', 'vischannel', and 'vistime'
00329 column Column name in main table of measurment set to plot. Valid values are: data, corrected, model, residual, and weight.
00330 value String: amp, phase
00331 iteration List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Spectral Window/Polarization_id( not available yet )
00332
00333 --------------------------------------------------------------------------------
00334
00335 """
00336 return _msplot.msplot_plot(self, *args, **kwargs)
00337
00338 def checkplot(self, *args, **kwargs):
00339 """
00340 checkplot(self, plottype=string(""), column=string("data"), value=string("amp"), iteration=std::vector< string >(1, "")) -> bool
00341
00342 Input Parameters:
00343 plottype The type of plot to check. Valid values are strings for each of the msplot function, the valid strings are: 'array' 'azimuth', 'baseline', 'elevation', 'hourangle', 'parallacticangle', 'uvcoverage', 'uvdist', 'vischannel', 'visfrequency', 'vistime', and 'visvelocity',
00344 column Column name in main table of measurment set to plot. Valid values are: data, corrected, model, residual, and weight. data
00345 value String: amp, phase amp
00346 iteration List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Spectral Window/Polarization_id( not available yet )
00347
00348 --------------------------------------------------------------------------------
00349
00350 """
00351 return _msplot.msplot_checkplot(self, *args, **kwargs)
00352
00353 def plotxy(self, *args, **kwargs):
00354 """
00355 plotxy(self, x=string("uvdist"), y=string("data"), xcolumn=string("data"), ycolumn=string("data"),
00356 xvalue=string("amp"), yvalue=string("amp"), iteration=std::vector< string >(1, "")) -> bool
00357
00358 Summary
00359
00360 A generic plotting routine for Measurement sets.
00361
00362
00363 Input Parameters:
00364 x X-axis, a column name in measurement ests' main table. Valid values are: antenna1, antenna2, aziumth, baseline, channel, corrected, data, elevation, feed1, feed2, field_id, frequency, hourangle, ifr_number, model, parallactic_angle, residual, scan_number, time, u, uvdist, v, velocity, w, and weight. uvdist
00365 y Y-axis, a column name in the measurment sets' main table. Valid values are the same as the X-axis values. data
00366 xcolumn The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data
00367 ycolumn The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data
00368 xvalue String, needed if X or Y is data quantity: amp, phase, real, imag amp
00369 yvalue String, needed if X or Y is data quantity: amp, phase, real, imag amp
00370 iteration List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Ex: iteration over baselines : ['antenna1','antenna2'] Spectral Window/Polarization_id( not available yet )
00371
00372 --------------------------------------------------------------------------------
00373
00374 """
00375 return _msplot.msplot_plotxy(self, *args, **kwargs)
00376
00377 def checkplotxy(self, *args, **kwargs):
00378 """
00379 checkplotxy(self, x=string("uvdist"), y=string("data"), xcolumn=string("data"), ycolumn=string("data"),
00380 xvalue=string("amp"), yvalue=string("amp"), iteration=std::vector< string >(1, "")) -> bool
00381
00382 Summary
00383
00384 Routine for checking the sanity of a plotxy plot.
00385
00386
00387 Input Parameters:
00388 x X-axis, a column name in measurement ests' main table. Valid values are: antenna1, antenna2, aziumth, baseline, channel, corrected, data, elevation, feed1, feed2, field_id, frequency, hourangle, ifr_number, model, parallactic_angle, residual, scan_number, time, u, uvdist, v, velocity, w, and weight. uvdist
00389 y Y-axis, a column name in the measurment sets' main table. Valid values are the same as the X-axis values. data
00390 xcolumn The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data
00391 ycolumn The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data
00392 xvalue String, needed if X or Y is data quantity: amp, phase, real, and imag amp
00393 yvalue String, needed if X or Y is data quantity: amp, phase, real, and imag amp
00394 iteration List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Spectral Window/Polarization_id( not available yet )
00395
00396 --------------------------------------------------------------------------------
00397
00398 """
00399 return _msplot.msplot_checkplotxy(self, *args, **kwargs)
00400
00401 def iterplotstart(self):
00402 """
00403 iterplotstart(self) -> bool
00404
00405 Summary
00406 Plot the first set of iterative plots.
00407
00408 --------------------------------------------------------------------------------
00409
00410 """
00411 return _msplot.msplot_iterplotstart(self)
00412
00413 def iterplotnext(self):
00414 """
00415 iterplotnext(self) -> bool
00416
00417 Summary
00418 Continue plotting on an iteration axes.
00419
00420 --------------------------------------------------------------------------------
00421
00422 """
00423 return _msplot.msplot_iterplotnext(self)
00424
00425 def iterplotstop(self, rmplotter=False):
00426 """
00427 iterplotstop(self, rmplotter=False) -> bool
00428
00429 Summary
00430 Stop an iterative plot.
00431
00432 Input Parameters:
00433 rmplotter Indicates of the plot window should be removed (true)from the display or left (false) false
00434
00435 --------------------------------------------------------------------------------
00436
00437 """
00438 return _msplot.msplot_iterplotstop(self, rmplotter)
00439
00440 def savefig(self, *args, **kwargs):
00441 """
00442 savefig(self, filename=string(""), dpi=-1, orientation=string(""), papertype=string(""), facecolor=string(""),
00443 edgecolor=string("")) -> bool
00444
00445 Summary
00446
00447 Save the currently plotted image.
00448
00449
00450 Input Parameters:
00451 filename Name the plot image is to be saved to.
00452 dpi Number of dots per inch (resolution) to save the image at. -1
00453 orientation Either landscape or portrait. Supported by the postscript format only.
00454 papertype Valid values are: letter, legal, exective, ledger, a0-a10 and b0-b10. This option is supported byt the postscript format only.
00455 facecolor Color of space between the plot and the edge of the square. Valid values are the same as those accepted by the plotcolor option.
00456 edgecolor Color of the outer edge. Valid values are the same as those accepted by the plotcolor option.
00457
00458 --------------------------------------------------------------------------------
00459
00460 """
00461 return _msplot.msplot_savefig(self, *args, **kwargs)
00462
00463 def markregion(self, *args, **kwargs):
00464 """
00465 markregion(self, subplot=111, region=initialize_vector(1, (double)0.0)) -> bool
00466
00467 Summary
00468 Mark a rectangular region to flag or to investigate
00469 the data in the area.
00470
00471
00472 Input Parameters:
00473 subplot Three digits number: first digit for nx, second for ny, last for pannel number. 111
00474 region [xmin,ymin,xmax,ymax] bounding box 0.0
00475
00476 --------------------------------------------------------------------------------
00477
00478 """
00479 return _msplot.msplot_markregion(self, *args, **kwargs)
00480
00481 def flagdata(self):
00482 """
00483 flagdata(self) -> bool
00484
00485 Summary
00486 Set flags for all selected
00487 regions marked using
00488 mp.markregion()
00489
00490 --------------------------------------------------------------------------------
00491
00492 """
00493 return _msplot.msplot_flagdata(self)
00494
00495 def unflagdata(self):
00496 """
00497 unflagdata(self) -> bool
00498
00499 Summary
00500
00501 Unset flags in all regions marked using
00502 mp.markregion()
00503 Similar to the
00504 mp.flagdata()
00505
00506 --------------------------------------------------------------------------------
00507
00508 """
00509 return _msplot.msplot_unflagdata(self)
00510
00511 def clearflags(self):
00512 """
00513 clearflags(self) -> bool
00514
00515 Summary
00516 Clear all flags in the table. Note: This clears *all*
00517 flags and should be used with caution.
00518
00519 --------------------------------------------------------------------------------
00520
00521 """
00522 return _msplot.msplot_clearflags(self)
00523
00524 def locatedata(self):
00525 """
00526 locatedata(self) -> bool
00527
00528 Summary
00529
00530 Print info about data selected using mp.markregion().
00531
00532 --------------------------------------------------------------------------------
00533
00534 """
00535 return _msplot.msplot_locatedata(self)
00536
00537 def saveflagversion(self, *args, **kwargs):
00538 """
00539 saveflagversion(self, versionname=string(""), comment=string(""), merge=string("replace")) -> bool
00540
00541 Summary
00542 Save current flags, applied to the current
00543 measurement set with a version name.
00544
00545
00546 Input Parameters:
00547 versionname Version name
00548 comment Comment for this flag table
00549 merge merge type: 'replace' existing flag version, 'and' logical AND with exisiting flag version, or 'or' logical OR with existing flag version replace
00550
00551 --------------------------------------------------------------------------------
00552
00553 """
00554 return _msplot.msplot_saveflagversion(self, *args, **kwargs)
00555
00556 def restoreflagversion(self, *args, **kwargs):
00557 """
00558 restoreflagversion(self, versionname=std::vector< string >(1, ""), merge=string("replace")) -> bool
00559
00560 Summary
00561 Restore flags for the current Measurement Set.
00562
00563
00564 Input Parameters:
00565 versionname List of flag versions to restore from.
00566 merge merge type: 'replace' existing flag version, 'and' logical AND with exisiting flag version, or 'or' logical OR with existing flag version replace
00567
00568 --------------------------------------------------------------------------------
00569
00570 """
00571 return _msplot.msplot_restoreflagversion(self, *args, **kwargs)
00572
00573 def deleteflagversion(self, *args, **kwargs):
00574 """
00575 deleteflagversion(self, versionname=std::vector< string >(1, "")) -> bool
00576
00577 Summary
00578 For the current measurement set delete a saved flag_version.
00579
00580
00581 Input Parameters:
00582 versionname Version name
00583
00584 --------------------------------------------------------------------------------
00585
00586 """
00587 return _msplot.msplot_deleteflagversion(self, *args, **kwargs)
00588
00589 def getflagversionlist(self):
00590 """
00591 getflagversionlist(self) -> bool
00592
00593 Summary
00594 Print out a list of saved flag_versions, for
00595 the current Measurement Set.
00596
00597 --------------------------------------------------------------------------------
00598
00599 """
00600 return _msplot.msplot_getflagversionlist(self)
00601
00602 msplot_swigregister = _msplot.msplot_swigregister
00603 msplot_swigregister(msplot)
00604
00605
00606
00607