tableplot.py

Go to the documentation of this file.

# This file was automatically generated by SWIG (http://www.swig.org).
# Version 2.0.5
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.



from sys import version_info
if version_info >= (2,6,0):
    def swig_import_helper():
        from os.path import dirname
        import imp
        fp = None
        try:
            fp, pathname, description = imp.find_module('_tableplot', [dirname(__file__)])
        except ImportError:
            import _tableplot
            return _tableplot
        if fp is not None:
            try:
                _mod = imp.load_module('_tableplot', fp, pathname, description)
            finally:
                fp.close()
            return _mod
    _tableplot = swig_import_helper()
    del swig_import_helper
else:
    import _tableplot
del version_info
try:
    _swig_property = property
except NameError:
    pass # Python < 2.2 doesn't have 'property'.
def _swig_setattr_nondynamic(self,class_type,name,value,static=1):
    if (name == "thisown"): return self.this.own(value)
    if (name == "this"):
        if type(value).__name__ == 'SwigPyObject':
            self.__dict__[name] = value
            return
    method = class_type.__swig_setmethods__.get(name,None)
    if method: return method(self,value)
    if (not static):
        self.__dict__[name] = value
    else:
        raise AttributeError("You cannot add attributes to %s" % self)

def _swig_setattr(self,class_type,name,value):
    return _swig_setattr_nondynamic(self,class_type,name,value,0)

def _swig_getattr(self,class_type,name):
    if (name == "thisown"): return self.this.own()
    method = class_type.__swig_getmethods__.get(name,None)
    if method: return method(self)
    raise AttributeError(name)

def _swig_repr(self):
    try: strthis = "proxy of " + self.this.__repr__()
    except: strthis = ""
    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,)

try:
    _object = object
    _newclass = 1
except AttributeError:
    class _object : pass
    _newclass = 0


class tableplot(_object):
    """Proxy of C++ casac::tableplot class"""
    __swig_setmethods__ = {}
    __setattr__ = lambda self, name, value: _swig_setattr(self, tableplot, name, value)
    __swig_getmethods__ = {}
    __getattr__ = lambda self, name: _swig_getattr(self, tableplot, name)
    __repr__ = _swig_repr
    def __init__(self): 
        """__init__(self) -> tableplot"""
        this = _tableplot.new_tableplot()
        try: self.this.append(this)
        except: self.this = this
    __swig_destroy__ = _tableplot.delete_tableplot
    __del__ = lambda self : None;
    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_open(self, *args, **kwargs)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_setgui(self, gui)

    def 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(). 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_savefig(self, *args, **kwargs)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_selectdata(self, *args, **kwargs)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_plotdata(self, *args, **kwargs)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_iterplotstart(self, *args, **kwargs)

    def replot(self):
        """
        replot(self) -> bool

        Summary
                
            Replot all existing panels and layers.
           
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_replot(self)

    def iterplotnext(self):
        """
        iterplotnext(self) -> int

        Summary
                
        Start/Continue plotting
            
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_iterplotnext(self)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_iterplotstop(self, rmplotter)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_markregions(self, *args, **kwargs)

    def flagdata(self):
        """
        flagdata(self) -> bool

        Summary
                
        Flag Data for selected flag regions
           
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_flagdata(self)

    def unflagdata(self):
        """
        unflagdata(self) -> bool

        Summary
                 
            Unset flags for all regions marked using {tt tp.markregions()}. 
           
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_unflagdata(self)

    def 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 !) 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_locatedata(self, *args, **kwargs)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_clearflags(self, roottable)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_saveflagversion(self, *args, **kwargs)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_restoreflagversion(self, *args, **kwargs)

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

        Summary
                  Delete a saved flag_version. 
                                   

        Input Parameters:
                versionname      Version name 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_deleteflagversion(self, *args, **kwargs)

    def getflagversionlist(self):
        """
        getflagversionlist(self) -> bool

        Summary
                  Print out a list of saved flag_versions. 
                                   
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_getflagversionlist(self)

    def 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 
                
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_clearplot(self, nrows, ncols, panel)

    def done(self):
        """
        done(self) -> bool

        Summary
                  Clean up the tableplot tool
           
        --------------------------------------------------------------------------------
                      
        """
        return _tableplot.tableplot_done(self)

tableplot_swigregister = _tableplot.tableplot_swigregister
tableplot_swigregister(tableplot)

# This file is compatible with both classic and new-style classes.