spectralline.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('_spectralline', [dirname(__file__)])
        except ImportError:
            import _spectralline
            return _spectralline
        if fp is not None:
            try:
                _mod = imp.load_module('_spectralline', fp, pathname, description)
            finally:
                fp.close()
            return _mod
    _spectralline = swig_import_helper()
    del swig_import_helper
else:
    import _spectralline
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 spectralline(_object):
    """Proxy of C++ casac::spectralline class"""
    __swig_setmethods__ = {}
    __setattr__ = lambda self, name, value: _swig_setattr(self, spectralline, name, value)
    __swig_getmethods__ = {}
    __getattr__ = lambda self, name: _swig_getattr(self, spectralline, name)
    __repr__ = _swig_repr
    def __init__(self): 
        """__init__(self) -> spectralline"""
        this = _spectralline.new_spectralline()
        try: self.this.append(this)
        except: self.this = this
    __swig_destroy__ = _spectralline.delete_spectralline
    __del__ = lambda self : None;
    def splattotable(self, *args, **kwargs):
        """
        splattotable(self, filenames=std::vector< string >(1, ""), table=string("")) -> spectralline

        Summary
                Convert a downloaded Splatalogue spectral line list to a casa table.

        Input Parameters:
                filenames        Files containing Splatalogue dumps 
                table            Output table name. 
                
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_splattotable(self, *args, **kwargs)

    def open(self, *args, **kwargs):
        """
        open(self, table=string("")) -> bool

        Summary
                Open a spectralline tool using the specified table.

        Input Parameters:
                table            CASA table containing Splatalogue data. 
                
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_open(self, *args, **kwargs)

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

        Summary
                close the spectralline tool
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_close(self)

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

        Summary
                End the spectralline tool
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_done(self)

    def search(self, *args, **kwargs):
        """
        search(self, outfile=string(""), freqrange=initialize_vector(1, (double)0), species=initialize_variant(""), 
            reconly=False, chemnames=initialize_variant(""), qns=std::vector< string >(1, ""), 
            intensity=initialize_vector(1, (double)-1), smu2=initialize_vector(1, (double)-1), 
            loga=initialize_vector(1, (double)-1), el=initialize_vector(1, (double)-1), 
            eu=initialize_vector(1, (double)-1), rrlinclude=True, 
            rrlonly=False, verbose=True, logfile=string(""), append=False) -> spectralline

        Summary
                Search a Splatalogue table that has been converted to a casa table

        Input Parameters:
                outfile          Results table name. Blank means do not write the table to disk. 
                freqrange        Frequency range in GHz. 0 
                species          Species to search for. 
                reconly          List only NRAO recommended frequencies. false 
                chemnames        Chemical names to search for. 
                qns              Resolved quantum numbers to search for. 
                intensity        CDMS/JPL intensity range. -1 -> do not use an intensity range. -1 
                smu2             S*mu*mu range in Debye**2. -1 -> do not use an S*mu*mu range. -1 
                loga             log(A) (Einstein coefficient) range. -1 -> do not use a loga range. -1 
                el               Lower energy state range in Kelvin. -1 -> do not use an el range. -1 
                eu               Upper energy state range in Kelvin. -1 -> do not use an eu range. -1 
                rrlinclude       Include RRLs in the result set? true 
                rrlonly          Include only RRLs in the result set? false 
                verbose          List result set to logger (and optionally logfile)? true 
                logfile          List result set to this logfile (only used if verbose=true). 
                append           If true, append to logfile if it already exists, if false overwrite logfile it it exists. Only used if verbose=true and logfile not blank. false 
                
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_search(self, *args, **kwargs)

    def list(self):
        """
        list(self)

        Summary
                List the spectral lines in the associated table to the logger.
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_list(self)

    def torecord(self):
        """
        torecord(self) -> record *

        Summary
                Return data on the spectral lines in the table as a record.
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_torecord(self)

    def species(self, *args, **kwargs):
        """
        species(self, verbose=False, logfile=string(""), append=False) -> record *

        Summary
                List the unique species in the associated table to the logger.

        Input Parameters:
                verbose          List result set to logger (and optionally logfile)? false 
                logfile          List result set to this logfile (only used if verbose=true). 
                append           If true, append to logfile if it already exists, if false overwrite logfile it it exists. Only used if show=true and logfile not blank. false 
                
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_species(self, *args, **kwargs)

    def chemnames(self, *args, **kwargs):
        """
        chemnames(self, verbose=False, logfile=string(""), append=False) -> record *

        Summary
                List the unique chemical names in the associated table to the logger.

        Input Parameters:
                verbose          List result set to logger (and optionally logfile)? false 
                logfile          List result set to this logfile (only used if verbose=true). 
                append           If true, append to logfile if it already exists, if false overwrite logfile it it exists. Only used if show=true and logfile not blank. false 
                
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_chemnames(self, *args, **kwargs)

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

        Summary
                Get the number of rows in the associated spectral line table.
        --------------------------------------------------------------------------------
                      
        """
        return _spectralline.spectralline_nrows(self)

spectralline_swigregister = _spectralline.spectralline_swigregister
spectralline_swigregister(spectralline)

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