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

List of all members.

Public Member Functions

def __init__
def open
def setgui
def savefig
def selectdata
def plotdata
def iterplotstart
def replot
def iterplotnext
def iterplotstop
def markregions
def flagdata
def unflagdata
def locatedata
def clearflags
def saveflagversion
def restoreflagversion
def deleteflagversion
def getflagversionlist
def clearplot
def done

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::tableplot class

Definition at line 70 of file tableplot.py.


Constructor & Destructor Documentation

__init__(self) -> tableplot

Definition at line 77 of file tableplot.py.


Member Function Documentation

def __casac__.tableplot.tableplot.clearflags (   self,
  roottable = False 
)
clearflags(self, roottable=False) -> bool

Summary
  Clear all flags in the table.
    

Input Parameters:
roottable        false : clear flags for the current sub-selection; true : clear flags for root table false 

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

Definition at line 300 of file tableplot.py.

def __casac__.tableplot.tableplot.clearplot (   self,
  nrows = 0,
  ncols = 0,
  panel = 0 
)
clearplot(self, nrows=0, ncols=0, panel=0) -> bool

Summary
  Clear a plot.


Input Parameters:
nrows            Number of rows of panels 0 
ncols            Number of columns of panels 0 
panel            Panel number (index) 0 

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

Definition at line 379 of file tableplot.py.

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

Summary
  Delete a saved flag_version. 
                   

Input Parameters:
versionname      Version name 

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

Definition at line 351 of file tableplot.py.

done(self) -> bool

Summary
  Clean up the tableplot tool
   
--------------------------------------------------------------------------------

Definition at line 397 of file tableplot.py.

flagdata(self) -> bool

Summary

Flag Data for selected flag regions
   
--------------------------------------------------------------------------------

Definition at line 257 of file tableplot.py.

getflagversionlist(self) -> bool

Summary
  Print out a list of saved flag_versions. 
                   
--------------------------------------------------------------------------------

Definition at line 367 of file tableplot.py.

iterplotnext(self) -> int

Summary

Start/Continue plotting
    
--------------------------------------------------------------------------------

Definition at line 209 of file tableplot.py.

Referenced by TablePlotTkAgg.PlotFlag.configure_buttons().

def __casac__.tableplot.tableplot.iterplotstart (   self,
  args,
  kwargs 
)
iterplotstart(self, poption=initialize_record("1 1 6 0.8 1.0"), labels=std::vector< string >(1, ""), 
    datastr=std::vector< string >(1, ""), iteraxes=std::vector< string >(1, "")) -> bool

Summary
 Initialize plotting with an iteration axis


Input Parameters:
poption          Record of plot options default is nxpanels=1, nypanels=1, windowsize=6, aspectratio=0.8, fontsize=1.0 1 1 6 0.8 1.0 
labels           List of strings : Title,Xlabel,Ylabel 
datastr          List of TaQL strings : X,Y 
iteraxes         List of strings : Iteration axes 

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

Definition at line 176 of file tableplot.py.

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

Summary
 Stop plot iterations.
   

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

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

Definition at line 222 of file tableplot.py.

def __casac__.tableplot.tableplot.locatedata (   self,
  args,
  kwargs 
)
locatedata(self, columnlist=std::vector< string >(1, "")) -> bool

Summary

    Print info about data selected using tp.markregions(). 
   

Input Parameters:
columnlist       List of strings : Column names (or TaQL expressions !) 

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

Definition at line 283 of file tableplot.py.

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

def __casac__.tableplot.tableplot.markregions (   self,
  args,
  kwargs 
)
markregions(self, nrows=0, ncols=0, panel=1, region=initialize_vector(1, (double)0.0)) -> bool

Summary
 Mark a rectangular region to flag
   

Input Parameters:
nrows            Number of rows of panels 0 
ncols            Number of columns of panels 0 
panel            Panel number 1 
region           [xmin,ymin,xmax,ymax] bounding box 0.0 

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

Definition at line 238 of file tableplot.py.

def __casac__.tableplot.tableplot.open (   self,
  args,
  kwargs 
)
open(self, tabnames=std::vector< string >(1, "")) -> bool

Summary
Specify list of tables to operate on.

Input Parameters:
tabnames         List of strings identifying Table names 

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

Definition at line 84 of file tableplot.py.

def __casac__.tableplot.tableplot.plotdata (   self,
  args,
  kwargs 
)
plotdata(self, poption=initialize_record("1 1 6 0.8 1.0"), labels=std::vector< string >(1, ""), 
    datastr=std::vector< string >(1, "")) -> bool

Summary

    Plot the result of a general TaQL expression.
   

Input Parameters:
poption          Record of plot options 1 1 6 0.8 1.0 
labels           List of strings : Title,Xlabel,Ylabel 
datastr          List of TaQL strings : X,Y 

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

Definition at line 156 of file tableplot.py.

replot(self) -> bool

Summary

    Replot all existing panels and layers.
   
--------------------------------------------------------------------------------

Definition at line 196 of file tableplot.py.

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

Summary
Restore flags from a saved flag_version. 
                   

Input Parameters:
versionname      Version name 
merge            merge type 

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

Definition at line 334 of file tableplot.py.

def __casac__.tableplot.tableplot.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 plotcolour option of tp.plotdata(). 
edgecolor        Color of the outer edge. Valid values are the same as those accepted by the plotcolour option of tp.plotdata(). 

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

Definition at line 116 of file tableplot.py.

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

Summary
  Save current flags with a version name. 
                 

Input Parameters:
versionname      Version name 
comment          Comment for this flag table 
merge            merge type 

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

Definition at line 316 of file tableplot.py.

def __casac__.tableplot.tableplot.selectdata (   self,
  args,
  kwargs 
)
selectdata(self, taqlstring=string("")) -> bool

Summary
 
    Perform a TaQL based subtable selection for subsequent plots. 
   

Input Parameters:
taqlstring       TaQL string for selection 

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

Definition at line 139 of file tableplot.py.

def __casac__.tableplot.tableplot.setgui (   self,
  gui = False 
)
setgui(self, gui=False) -> bool

Summary

  Set the GUI on or off. Can be done only once !!


Input Parameters:
gui              gui=False to turn off gui false 

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

Definition at line 99 of file tableplot.py.

unflagdata(self) -> bool

Summary
 
    Unset flags for all regions marked using {tt tp.markregions()}. 
   
--------------------------------------------------------------------------------

Definition at line 270 of file tableplot.py.


Member Data Documentation

Definition at line 83 of file tableplot.py.

Definition at line 75 of file tableplot.py.

Definition at line 76 of file tableplot.py.

Definition at line 73 of file tableplot.py.

Definition at line 82 of file tableplot.py.

Definition at line 74 of file tableplot.py.

Definition at line 72 of file tableplot.py.

Definition at line 81 of file tableplot.py.


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