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

List of all members.

Public Member Functions

def __init__
def splattotable
def open
def close
def done
def search
def list
def torecord
def species
def chemnames
def nrows

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

Definition at line 70 of file spectralline.py.


Constructor & Destructor Documentation

__init__(self) -> spectralline

Definition at line 77 of file spectralline.py.


Member Function Documentation

def __casac__.spectralline.spectralline.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 

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

Definition at line 211 of file spectralline.py.

close(self) -> bool

Summary
close the spectralline tool
--------------------------------------------------------------------------------

Definition at line 115 of file spectralline.py.

done(self) -> bool

Summary
End the spectralline tool
--------------------------------------------------------------------------------

Definition at line 126 of file spectralline.py.

list(self)

Summary
List the spectral lines in the associated table to the logger.
--------------------------------------------------------------------------------

Definition at line 172 of file spectralline.py.

nrows(self) -> int

Summary
Get the number of rows in the associated spectral line table.
--------------------------------------------------------------------------------

Definition at line 228 of file spectralline.py.

def __casac__.spectralline.spectralline.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. 

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

Definition at line 100 of file spectralline.py.

def __casac__.spectralline.spectralline.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 

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

Definition at line 137 of file spectralline.py.

def __casac__.spectralline.spectralline.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 

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

Definition at line 194 of file spectralline.py.

def __casac__.spectralline.spectralline.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. 

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

Definition at line 84 of file spectralline.py.

torecord(self) -> record *

Summary
Return data on the spectral lines in the table as a record.
--------------------------------------------------------------------------------

Definition at line 183 of file spectralline.py.


Member Data Documentation

Definition at line 83 of file spectralline.py.

Definition at line 75 of file spectralline.py.

Definition at line 76 of file spectralline.py.

Definition at line 73 of file spectralline.py.

Definition at line 82 of file spectralline.py.

Definition at line 74 of file spectralline.py.

Definition at line 72 of file spectralline.py.

Definition at line 81 of file spectralline.py.


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