casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables
Public Member Functions | Public Attributes | Static Private Attributes
__casac__.msplot.msplot Class Reference
Inheritance diagram for __casac__.msplot.msplot:
__casac__.msplot._object

List of all members.

Public Member Functions

def __init__
def open
def clearplot
def emperorsNewClose
def reset
def closeMS
def close
def done
def plotoptions
def summary
def setdata
def extendflag
def avedata
def plot
def checkplot
def plotxy
def checkplotxy
def iterplotstart
def iterplotnext
def iterplotstop
def savefig
def markregion
def flagdata
def unflagdata
def clearflags
def locatedata
def saveflagversion
def restoreflagversion
def deleteflagversion
def getflagversionlist

Public Attributes

 this

Static Private Attributes

dictionary __swig_setmethods__
tuple __setattr__
dictionary __swig_getmethods__
tuple __getattr__
 __repr__
 __swig_destroy__
 __del__

Detailed Description

Proxy of C++ casac::msplot class

Definition at line 70 of file msplot.py.


Constructor & Destructor Documentation

__init__(self) -> msplot

Definition at line 77 of file msplot.py.


Member Function Documentation

def __casac__.msplot.msplot.avedata (   self,
  args,
  kwargs 
)
avedata(self, chanavemode=string("none"), corravemode=string("none"), datacolumn=string("DATA"), 
    averagemode=string("vector"), averagechan=string("1"), averagetime=string("0"), 
    averageflagged=False, averagescan=False, averagebl=False, averagearray=False, 
    averagechanid=False, averagevel=False) -> bool

Summary

   Specify which data is to be averaged in the MS (or selected MS).
   

Input Parameters:
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 
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 
datacolumn       Indicate the visibility data to be averaged. Valid values are: DATA CORRECTEDDATA MODELDATA DATA 
averagemode      Indicate the mode for channel and/or time averaging. Valid values are: vector scalar vector 
averagechan      Indicate the number of channels to average. The default value of 1 means no channel averaging. 1 
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 
averageflagged   Indicate either flagged or unflagged data to average. false 
averagescan      Indicate whether time averaging cross scan boundaries. false 
averagebl        Indicate whether averaging cross baseline boundaries. false 
averagearray     Indicate whether averaging cross array boundaries. false 
averagechanid    Indicate whether using averaged channel id or not. false 
averagevel       Indicate whether calculating averaged velocity id or not. false 

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

Definition at line 292 of file msplot.py.

def __casac__.msplot.msplot.checkplot (   self,
  args,
  kwargs 
)
checkplot(self, plottype=string(""), column=string("data"), value=string("amp"), iteration=std::vector< string >(1, "")) -> bool

Input Parameters:
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', 
column           Column name in main table of measurment set to plot. Valid values are: data, corrected, model, residual, and weight. data 
value            String: amp, phase amp 
iteration        List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Spectral Window/Polarization_id( not available yet ) 

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

Definition at line 338 of file msplot.py.

def __casac__.msplot.msplot.checkplotxy (   self,
  args,
  kwargs 
)
checkplotxy(self, x=string("uvdist"), y=string("data"), xcolumn=string("data"), ycolumn=string("data"), 
    xvalue=string("amp"), yvalue=string("amp"), iteration=std::vector< string >(1, "")) -> bool

Summary

       Routine for checking the sanity of a plotxy plot.
   

Input Parameters:
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 
y                Y-axis, a column name in the measurment sets' main table. Valid values are the same as the X-axis values. data 
xcolumn          The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data 
ycolumn          The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data 
xvalue           String, needed if X or Y is data quantity: amp, phase, real, and imag amp 
yvalue           String, needed if X or Y is data quantity: amp, phase, real, and imag amp 
iteration        List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Spectral Window/Polarization_id( not available yet ) 

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

Definition at line 377 of file msplot.py.

clearflags(self) -> bool

Summary
Clear all flags in the table. Note: This clears *all* 
    flags and should be used with caution.
   
--------------------------------------------------------------------------------

Definition at line 511 of file msplot.py.

def __casac__.msplot.msplot.clearplot (   self,
  subplot = 000 
)
clearplot(self, subplot=000) -> bool

Summary
 Clear the plotting window or a particular panel,
     or all panels.
  

Input Parameters:
subplot          Three (or four) digits number: first digit for nrows, second for ncols, the rest for pannel number. 000 

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

Definition at line 105 of file msplot.py.

close(self) -> bool

Summary
See done -- close and done do the same thing.
  
--------------------------------------------------------------------------------

Definition at line 158 of file msplot.py.

closeMS(self) -> bool

Summary
Close the measurement set being used.
  
--------------------------------------------------------------------------------

Definition at line 146 of file msplot.py.

def __casac__.msplot.msplot.deleteflagversion (   self,
  args,
  kwargs 
)
deleteflagversion(self, versionname=std::vector< string >(1, "")) -> bool

Summary
For the current measurement set delete a saved flag_version.
   

Input Parameters:
versionname      Version name 

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

Definition at line 573 of file msplot.py.

done(self) -> bool

Summary
Close the current MeasurementSet, and destroy
      the plotter -- ending all plotting.
  
--------------------------------------------------------------------------------

Definition at line 170 of file msplot.py.

emperorsNewClose(self) -> bool

Summary
Like the Emperor's New Clothes.
  
--------------------------------------------------------------------------------

Definition at line 122 of file msplot.py.

def __casac__.msplot.msplot.extendflag (   self,
  args,
  kwargs 
)
extendflag(self, extendcorr=string(""), extendchan=string(""), extendspw=string(""), extendant=string(""), 
    extendtime=string("")) -> bool

Summary

   Set the scope of flagging extension
   

Input Parameters:
extendcorr       Indicate correlation based flagging extension. Valid values are: allhalf 
extendchan       Indicate channel based flagging extension. Valid values are: all 
extendspw        Indicate spectral window based flagging extension. Valid values are: all 
extendant        Indicate antenna (baselines) based flagging extension. Valid values are: all 
extendtime       Indicate time based flagging extension. Valid values are: all 

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

Definition at line 270 of file msplot.py.

flagdata(self) -> bool

Summary
Set flags for all selected
     regions marked using 
     mp.markregion()
   
--------------------------------------------------------------------------------

Definition at line 481 of file msplot.py.

getflagversionlist(self) -> bool

Summary
Print out a list of saved flag_versions, for 
the current Measurement Set.
  
--------------------------------------------------------------------------------

Definition at line 589 of file msplot.py.

iterplotnext(self) -> bool

Summary
Continue plotting on an iteration axes.
   
--------------------------------------------------------------------------------

Definition at line 413 of file msplot.py.

Referenced by TablePlotTkAgg.PlotFlag.configure_buttons().

iterplotstart(self) -> bool

Summary
Plot the first set of iterative plots.
   
--------------------------------------------------------------------------------

Definition at line 401 of file msplot.py.

def __casac__.msplot.msplot.iterplotstop (   self,
  rmplotter = False 
)
iterplotstop(self, rmplotter=False) -> bool

Summary
Stop an iterative plot.

Input Parameters:
rmplotter        Indicates of the plot window should be removed (true)from the display or left (false) false 

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

Definition at line 425 of file msplot.py.

locatedata(self) -> bool

Summary

    Print info about data selected using mp.markregion().
   
--------------------------------------------------------------------------------

Definition at line 524 of file msplot.py.

Referenced by testwrapper.UnitTest.funcSetup(), and testbase.testbase.runtests().

def __casac__.msplot.msplot.markregion (   self,
  args,
  kwargs 
)
markregion(self, subplot=111, region=initialize_vector(1, (double)0.0)) -> bool

Summary
 Mark a rectangular region to flag or to investigate
       the data in the area.
   

Input Parameters:
subplot          Three digits number: first digit for nx, second for ny, last for pannel number. 111 
region           [xmin,ymin,xmax,ymax] bounding box 0.0 

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

Definition at line 463 of file msplot.py.

Referenced by TablePlotTkAgg.PlotFlag.configure_buttons().

def __casac__.msplot.msplot.open (   self,
  args,
  kwargs 
)
open(self, msname=string(""), dovel=False, restfreq=string(""), frame=string(""), doppler=string("")) -> bool

Summary

     Set the measurement set to be plotted.
   

Input Parameters:
msname           measurement set name, including path 
dovel            whether to calculate velocity or not false 
restfreq         a rest frequency quanta or transition name 
frame            frequency frame for spectral axis 
doppler          doppler mode 

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

Definition at line 84 of file msplot.py.

def __casac__.msplot.msplot.plot (   self,
  args,
  kwargs 
)
plot(self, type=string(""), column=string(""), value=string(""), iteration=std::vector< string >(1, "")) -> bool

Input Parameters:
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' 
column           Column name in main table of measurment set to plot. Valid values are: data, corrected, model, residual, and weight. 
value            String: amp, phase 
iteration        List of strings: Antenna1, Antenna2, Feed1, Feed2, Field_id, Scan_number, and Time. Spectral Window/Polarization_id( not available yet ) 

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

Definition at line 323 of file msplot.py.

Referenced by task_sdgrid.sdgrid_worker.finalize(), asap.asaplotbase.asaplotbase.hist(), asap.asapplotter.asapplotter.set_abcissa(), asap.asapplotter.asapplotter.set_colors(), asap.asapplotter.asapplotter.set_data(), asap.asapplotter.asapplotter.set_font(), asap.asapplotter.asapplotter.set_histogram(), asap.asapplotter.asapplotter.set_layout(), asap.asapplotter.asapplotter.set_legend(), asap.asapplotter.asapplotter.set_linestyles(), asap.asapplotter.asapplotter.set_margin(), asap.asapplotter.asapplotter.set_mask(), asap.asapplotter.asapplotter.set_mode(), asap.asapplotter.asapplotter.set_ordinate(), asap.asapplotter.asapplotter.set_range(), asap.asapplotter.asapplotter.set_selection(), and asap.asapplotter.asapplotter.set_title().

def __casac__.msplot.msplot.plotoptions (   self,
  args,
  kwargs 
)
plotoptions(self, subplot=111, plotsymbol=string(""), plotcolor=string(""), multicolor=string("none"), 
    plotrange=string(""), timeplot='o', markersize=8.0, linewidth=1.0, overplot=False, 
    replacetopplot=False, removeoldpanels=True, skipnrows=1, averagenrows=1, 
    extendflag=string(""), connect=string("none"), showflags=False, title=string(""), 
    xlabel=string(""), ylabel=string(""), fontsize=14.0, windowsize=1.0, 
    aspectratio=1.0) -> bool

Summary

     Set the style of the plot.
   

Input Parameters:
subplot          Three (or four) digits number: first digit for nx, second for ny, the rest for pannel number. 111 
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', '+', ... 
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. 
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 
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. 
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' 
markersize       Specify the size (in pixels) of the markers being plotted. Markers are specified with the plotsymbol option. . 8.0 
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 
overplot         To do overplot or not. false 
replacetopplot   true : when overplot=false, replace the top-most layer only false : overplot=false always creates a fresh stack of plots. false 
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 
skipnrows        Indicates how many points to skip when plotting, ie. it plots every nth point. 1 
averagenrows     Indicates how many rows to average when plotting, ie. average together every n rows. 1 
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. 
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 
showflags        Indicates whether or not to plot flagged and unflagged data. False : plot only unflagged data True : plot only flagged data false 
title            string for the title of the plot 
xlabel           string for the X -label of the plot 
ylabel           string for the Y -label of the plot 
fontsize         font size of the labels for the plot 14.0 
windowsize       window size of the plot 1.0 
aspectratio      aspect ratio of the window size of the plot 1.0 

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

Definition at line 183 of file msplot.py.

def __casac__.msplot.msplot.plotxy (   self,
  args,
  kwargs 
)
plotxy(self, x=string("uvdist"), y=string("data"), xcolumn=string("data"), ycolumn=string("data"), 
    xvalue=string("amp"), yvalue=string("amp"), iteration=std::vector< string >(1, "")) -> bool

Summary

       A generic plotting routine for Measurement sets.
   

Input Parameters:
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 
y                Y-axis, a column name in the measurment sets' main table. Valid values are the same as the X-axis values. data 
xcolumn          The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data 
ycolumn          The column name in the measurement sets' msin table. Valid values are: data, corrected, model, and residual. data 
xvalue           String, needed if X or Y is data quantity: amp, phase, real, imag amp 
yvalue           String, needed if X or Y is data quantity: amp, phase, real, imag amp 
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 ) 

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

Definition at line 353 of file msplot.py.

reset(self) -> bool

Summary
Reset the state of MS plot back to its default state.
  
--------------------------------------------------------------------------------

Definition at line 134 of file msplot.py.

def __casac__.msplot.msplot.restoreflagversion (   self,
  args,
  kwargs 
)
restoreflagversion(self, versionname=std::vector< string >(1, ""), merge=string("replace")) -> bool

Summary
Restore flags for the current Measurement Set.
   

Input Parameters:
versionname      List of flag versions to restore from. 
merge            merge type: 'replace' existing flag version, 'and' logical AND with exisiting flag version, or 'or' logical OR with existing flag version replace 

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

Definition at line 556 of file msplot.py.

def __casac__.msplot.msplot.savefig (   self,
  args,
  kwargs 
)
savefig(self, filename=string(""), dpi=-1, orientation=string(""), papertype=string(""), facecolor=string(""), 
    edgecolor=string("")) -> bool

Summary

     Save the currently plotted image.
   

Input Parameters:
filename         Name the plot image is to be saved to. 
dpi              Number of dots per inch (resolution) to save the image at. -1 
orientation      Either landscape or portrait. Supported by the postscript format only. 
papertype        Valid values are: letter, legal, exective, ledger, a0-a10 and b0-b10. This option is supported byt the postscript format only. 
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. 
edgecolor        Color of the outer edge. Valid values are the same as those accepted by the plotcolor option. 

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

Definition at line 440 of file msplot.py.

def __casac__.msplot.msplot.saveflagversion (   self,
  args,
  kwargs 
)
saveflagversion(self, versionname=string(""), comment=string(""), merge=string("replace")) -> bool

Summary
Save current flags, applied to the current
     measurement set with a version name. 
   

Input Parameters:
versionname      Version name 
comment          Comment for this flag table 
merge            merge type: 'replace' existing flag version, 'and' logical AND with exisiting flag version, or 'or' logical OR with existing flag version replace 

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

Definition at line 537 of file msplot.py.

def __casac__.msplot.msplot.setdata (   self,
  args,
  kwargs 
)
setdata(self, baseline=string(""), field=string(""), scan=string(""), uvrange=string(""), array=string(""), 
    feed=string(""), spw=string(""), correlation=string(""), time=string("")) -> bool

Summary

   Select a subset of the measurement set to operate on.
   

Input Parameters:
baseline         Baseline selection expression. 
field            Field selection string. 
scan             Scan selection string. 
uvrange          UV Range selection string. 
array            Array selection string. 
feed             Feed selection string. 
spw              Spectral Window selection string. 
correlation      Correlation selection string. 
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. 

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

Definition at line 244 of file msplot.py.

def __casac__.msplot.msplot.summary (   self,
  selected = True 
)
summary(self, selected=True) -> bool

Summary

   List a short summary, description, of the data in the open
   measurment set.
   

Input Parameters:
selected         Determine if we print a summary of the selected (true) data or a summary of the full measurement set (false). true 

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

Definition at line 226 of file msplot.py.

unflagdata(self) -> bool

Summary

    Unset flags in  all regions marked using 
     mp.markregion()
      Similar to the
     mp.flagdata()
   
--------------------------------------------------------------------------------

Definition at line 495 of file msplot.py.


Member Data Documentation

Definition at line 83 of file msplot.py.

tuple __casac__.msplot.msplot.__getattr__ [static, private]

Definition at line 75 of file msplot.py.

Definition at line 76 of file msplot.py.

tuple __casac__.msplot.msplot.__setattr__ [static, private]

Definition at line 73 of file msplot.py.

Definition at line 82 of file msplot.py.

dictionary __casac__.msplot.msplot.__swig_getmethods__ [static, private]

Definition at line 74 of file msplot.py.

dictionary __casac__.msplot.msplot.__swig_setmethods__ [static, private]

Definition at line 72 of file msplot.py.

Definition at line 81 of file msplot.py.


The documentation for this class was generated from the following file: