asap.linecatalog.linecatalog

Package asap :: Module linecatalog :: Class linecatalog

[show private | hide private]

Type linecatalog

object --+        
         |        
  instance --+    
             |    
   linecatalog --+
                 |
                linecatalog

This class is a warpper for line catalogs. These can be either ASCII tables or the tables saved from this class. ASCII tables have the following restrictions: Comments can be present through lines starting with '#'. The first column contains the name of the Molecule. This can't contain spaces, if it does it has to be wrapped in "" The second column contains the frequency of the transition. The third column contains the error in frequency. The fourth column contains a value describing the intensity

Method Summary
	`__init__(self, name)`
	`__getitem__(self, k)`
	`__len__(self)`
	`get_row(self, row)` Get the values in a specified row of the table.
	`reset(self)` Reset the table to its initial state, i.e.
	`save(self, name, overwrite)` Save the subset of the table to disk.
	`set_frequency_limits(self, fmin, fmax, unit)` Set frequency limits on the table.
	`set_name(self, name, mode)` Set a name restriction on the table.
	`set_strength_limits(self, smin, smax)` Set line strength limits on the table (arbitrary units)...
	`summary(self)` Print the contents of the table.
Inherited from `instance`: `__new__` Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Method Details

get_row(self, row=0)

Get the values in a specified row of the table.
Parameters:
      row:        the row to retrieve

reset(self)

Reset the table to its initial state, i.e. undo all calls to set_

Overrides:: asap._asap.linecatalog.reset

save(self, name, overwrite=False)

Save the subset of the table to disk. This uses an internal data format and can be read in again.

Overrides:: asap._asap.linecatalog.save

set_frequency_limits(self, fmin=1.0, fmax=120.0, unit='GHz')

Set frequency limits on the table.
Parameters:
    fmin:       the lower bound
    fmax:       the upper bound
    unit:       the frequency unit (default "GHz")

Note:
    The underlying table conatins frequency values in MHz

Overrides:: asap._asap.linecatalog.set_frequency_limits

set_name(self, name, mode='pattern')

Set a name restriction on the table. This can be a standard unix-style
pattern or a regular expression.
Parameters:
    name:       the name patterrn/regex
    mode:       the matching mode, i.e. "pattern" (default) or "regex"

Overrides:: asap._asap.linecatalog.set_name

set_strength_limits(self, smin, smax)

Set line strength limits on the table (arbitrary units)
Parameters:
    smin:       the lower bound
    smax:       the upper bound

Overrides:: asap._asap.linecatalog.set_strength_limits

summary(self)

Print the contents of the table.

Overrides:: asap._asap.linecatalog.summary

Generated by Epydoc 2.1 on Wed May 2 14:24:32 2007

http://epydoc.sf.net