Source code for casatasks.information.slsearch

#
# stub function definition file for docstring parsing
#

[docs]def slsearch(outfile='', freqrange=[84, 90], species='', reconly=False, chemnames='', qns='', intensity=[-1], smu2=[-1], loga=[-1], el=[-1], eu=[-1], rrlinclude=True, rrlonly=False, verbose=False, logfile='""', append=False): r""" Search a spectral line table. [`Description`_] [`Examples`_] [`Development`_] [`Details`_] Parameters - tablename_ (path='') - Input spectral line table name to search. If not specified, use the default table in the system. - outfile_ (string='') - Results table name. Blank means do not write the table to disk. - freqrange_ (doubleVec=[84, 90]) - Frequency range in GHz. - species_ (stringVec='') - Species to search for. - reconly_ (bool=False) - List only NRAO recommended frequencies. - chemnames_ (stringVec='') - Chemical names to search for. - qns_ (stringVec='') - Resolved quantum numbers to search for. - rrlinclude_ (bool=True) - Include RRLs in the result set? - rrlonly_ (bool=False) - Include only RRLs in the result set? .. raw:: html <details><summary><i> rrlonly = False </i></summary> - intensity_ (doubleVec=[-1]) - CDMS/JPL intensity range. -1 -> do not use an intensity range. - smu2_ (doubleVec=[-1]) - Quantum mechanical line strength. -1 -> do not use a smu2 range. - loga_ (doubleVec=[-1]) - log(A) (Einstein coefficient) range. -1 -> do not use a loga range. - eu_ (doubleVec=[-1]) - Upper energy state range in Kelvin. -1 -> do not use an eu range. - el_ (doubleVec=[-1]) - Lower energy state range in Kelvin. -1 -> do not use an el range. .. raw:: html </details> - verbose_ (bool=False) - List result set to logger (and optionally logfile)? .. raw:: html <details><summary><i> verbose = True </i></summary> - logfile_ (string='""') - List result set to this logfile (only used if verbose=True). - append_ (bool=False) - 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. .. raw:: html </details> .. _Description: Description This task allows the user to search a specified spectral line table. If no spectral line table is specified, the default is to use a subset of the `Splatalogue spectral line catalog <http://www.cv.nrao.edu/php/splat/>`__ , which is distributed with CASA. One can also export custom catalogs from the Splatalogue website and import them to CASA using the task splattotable ,or tool method sl.splattotable. The results table can be written to disk by specifying its name in the outfile parameter. If outfile is not specified (i.e. outfile=''), no table is created. Because `Splatalogue <http://www.cv.nrao.edu/php/splat/>`__ does not have values forthe CDMS/JPL intensity (intensity), quantum mechanical line strength (smu2), Einstein A coefficient (loga), the upper state energy level (eu), or the lower state energy level (el) measured in K for radio recombination lines (RRLs), one must specify to include RRLs in the specified frequency range in the output. In this case, RRLs will be included ignoring any filters on intensity, smu2, loga, eu, and el. One can also specify to list only RRLs. One can specify to list the search results to the logger via the verbose parameter. If verbose=False, no logger output is listed. If verbose=True, one can also specify that the results be listed to a logfile. If this file already exists, one can specify that the results be appended to it, or to overwrite it with the results. .. rubric:: Parameter descriptions *tablename* Input spectral line table name to search. If not specified, use the default table in the system. *outfile* Results table name. Blank means do not write the table to disk. *freqrange* Frequency range in GHz. *species* Species to search for. *reconly* List only NRAO recommended frequencies. *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. *smu2* Sμ 2 range in Debye 2. -1 -> do not use an Sμ 2 range. *loga* log(A) (Einstein A coefficient) range. -1 -> do not use a loga range. *el* Lower energy state range in Kelvin. -1 -> do not use an el range. *eu* Upper energy state range in Kelvin. -1 -> do not use an eu range. *rrlinclude* Include Radio Recombination Lines (RRLs) in the result set? *rrlonly* Include only RRLs in the result set? *verbose* List result set to logger (and optionally logfile) *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. .. _Examples: Examples To search the `Splatalogue database <http://www.cv.nrao.edu/php/splat/>`__ for spectral lines in the frequency range 90 - 92 GHz, and write the result to a table named "myspectrallines.tbl" as well as to the logger: :: slsearch(outfile="myspectrallines.tbl", freqrange=[90,92], verbose=True) .. _Development: Development No additional development details .. _Details: Parameter Details Detailed descriptions of each function parameter .. _tablename: | ``tablename (path='')`` - Input spectral line table name to search. If not specified, use the default table in the system. .. _outfile: | ``outfile (string='')`` - Results table name. Blank means do not write the table to disk. .. _freqrange: | ``freqrange (doubleVec=[84, 90])`` - Frequency range in GHz. .. _species: | ``species (stringVec='')`` - Species to search for. .. _reconly: | ``reconly (bool=False)`` - List only NRAO recommended frequencies. .. _chemnames: | ``chemnames (stringVec='')`` - Chemical names to search for. .. _qns: | ``qns (stringVec='')`` - Resolved quantum numbers to search for. .. _intensity: | ``intensity (doubleVec=[-1])`` - CDMS/JPL intensity range. -1 -> do not use an intensity range. .. _smu2: | ``smu2 (doubleVec=[-1])`` - Quantum mechanical line strength. -1 -> do not use a smu2 range. .. _loga: | ``loga (doubleVec=[-1])`` - log(A) (Einstein coefficient) range. -1 -> do not use a loga range. .. _el: | ``el (doubleVec=[-1])`` - Lower energy state range in Kelvin. -1 -> do not use an el range. .. _eu: | ``eu (doubleVec=[-1])`` - Upper energy state range in Kelvin. -1 -> do not use an eu range. .. _rrlinclude: | ``rrlinclude (bool=True)`` - Include RRLs in the result set? .. _rrlonly: | ``rrlonly (bool=False)`` - Include only RRLs in the result set? .. _verbose: | ``verbose (bool=False)`` - List result set to logger (and optionally logfile)? .. _logfile: | ``logfile (string='""')`` - List result set to this logfile (only used if verbose=True). .. _append: | ``append (bool=False)`` - 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. """ pass