LineList_BDP — LineID_AT data (line information and spectra).

This module defines the LineList_BDP class.

class admit.bdp.LineList_BDP.LineList_BDP(xmlFile=None, **keyval)

LineList BDP class.

This class contains a list of spectral lines identified by the LineID AT. The columns in the table are: fullname (name of the molecule “U” for unknown), formula (chemical formula), frequency (rest frequency in GHz), uid (unique identifier consisting of the formula and rest frequency), transition (molecular, vibrational or electronic transition), velocity (relative to the rest velocity), El (lower state energy in K), Eu (upper state energy in K), linestrength (line strength of the transition in Debye^2), peakintensity (peak intensity of the transition in Jy/bm), peakoffset (offset of the peak from rest in km/s), fwhm (full width half max of the line in km/s), startchan (starting channel in the spectral window), endchan (ending channel in the spectral window), and sigma (intensity of the line relative to the noise level).

Parameters:

xmlFile : str

Output XML file name.

keyval : dict

Dictionary of keyword:value pairs.

Attributes

table	(Table) Instance of the Table class to hold the spectral line information.
veltype	(str) Velocity definition used for the spectrum. Default: “vlsr”
ra	(str) The RA of where the spectrum was taken. Default: “”
dec	(str) The declination of where the spectrum was taken. Default: “”
spectra	(Table) Instance of the Table class to hold spectra.

Methods

addRow(row)	Method to add a row to the table
addSpectrum(spectrum, name[, replace])	Method to add a spectrum to the BDP
addimage(image[, name])	Method to add an image to the class
baseDir([path])	Get/set project base directory.
delete([delfiles])	Method to delete the BDP.
get(key)	Access an attribute.
getSpectraNames()	Method to get the names of the spectra
getSpectrum(name)	Method to get a specific spectrum by name
getall()	Method to get all rows from the table as a list of LineData objects
getdir()	Method to get the subdirectory(s) of the current BDP relative to the ADMIT working directory.
getfiles()	Return the filename(s) associated with the basic data in a BDP.
getimage([imtype, name])	Method to get a specific image type from the class
getimagefile([imtype, name])	Method to get the requested image file name from the named instance
haskey(key)	Query if a key exists for an BDP.
isequal(bdp)	Tests for equality with another BDP.
report()	Report BDP properties in human readable format.
setkey([name, key])	Sets keyword value(s).
show()	Show the xmlFile name.
update(new_state)	Updates BDP state.
write([xmlFile])	Writes the BDP to an XML file.

addRow(row)

Method to add a row to the table

Parameters:

row : LineData object

LineData object containing the data

Returns:

None

addSpectrum(spectrum, name, replace=False)

Method to add a spectrum to the BDP

Parameters:

spectrum : Spectrum object

The spectrum to add to the BDP

name : str

The name of the spectrum to add (e.g. cubestats)

replace : bool

If True replace the spectrum with the existing name.

Returns:

None

getSpectraNames()

Method to get the names of the spectra

Parameters:None Returns:List of strings containing the names

getSpectrum(name)

Method to get a specific spectrum by name

Parameters:

name : str

The name of the spectrum to get

Returns:

Spectrum instance containing the spectrum

getall()

Method to get all rows from the table as a list of LineData objects

Parameters:None Returns:List of LineData objects, one for each row in the table.