asap.linecatalog.linecatalog Class Reference

List of all members.

Public Member Functions
def	__init__
def	__repr__
def	summary
def	set_name
def	set_frequency_limits
def	set_strength_limits
def	save
def	reset
def	get_row
def	__len__
def	__getitem__

---

Detailed Description

\
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 double-quotes.

    * 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.

Definition at line 9 of file linecatalog.py.

---

Constructor & Destructor Documentation

def asap.linecatalog.linecatalog.__init__	(		self,
			name
	)

Definition at line 29 of file linecatalog.py.

---

Member Function Documentation

def asap.linecatalog.linecatalog.__getitem__	(		self,
			k
	)

Definition at line 136 of file linecatalog.py.

References asap.linecatalog.linecatalog.get_row(), tests.test_sdsave.sdsave_unittest_base.nrow, __casac__.ms.ms.nrow(), asap.asapgrid._SDGridPlotter.nrow, and tests.test_sdbaseline.BlparamFileParser.nrow().

def asap.linecatalog.linecatalog.__len__

(

self

)

Definition at line 133 of file linecatalog.py.

References tests.test_sdsave.sdsave_unittest_base.nrow, __casac__.ms.ms.nrow(), asap.asapgrid._SDGridPlotter.nrow, and tests.test_sdbaseline.BlparamFileParser.nrow().

def asap.linecatalog.linecatalog.__repr__

(

self

)

Definition at line 37 of file linecatalog.py.

def asap.linecatalog.linecatalog.get_row	(		self,
			row = 0
	)

\
Get the values in a specified row of the table.

Parameters:

      row:        the row to retrieve

Definition at line 118 of file linecatalog.py.

Referenced by asap.linecatalog.linecatalog.__getitem__().

def asap.linecatalog.linecatalog.reset

(

self

)

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

Definition at line 112 of file linecatalog.py.

def asap.linecatalog.linecatalog.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.

Definition at line 100 of file linecatalog.py.

def asap.linecatalog.linecatalog.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 contains frequency values in MHz

Definition at line 67 of file linecatalog.py.

def asap.linecatalog.linecatalog.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"

Definition at line 50 of file linecatalog.py.

def asap.linecatalog.linecatalog.set_strength_limits	(		self,
			smin,
			smax
	)

\
Set line strength limits on the table (arbitrary units)

Parameters:

    smin:       the lower bound

    smax:       the upper bound

Definition at line 87 of file linecatalog.py.

def asap.linecatalog.linecatalog.summary

(

self

)

Print the contents of the table.

Definition at line 40 of file linecatalog.py.

---

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

• asap/linecatalog.py