Package ComboCode :: Package cc :: Package tools :: Package readers :: Module TxtReader :: Class TxtReader
[hide private]
[frames] | no frames]

Class TxtReader

source code


A text file reader for line profile data.

Instance Methods [hide private]
new empty dictionary

__init__(self, fn, star_name=None, *args, **kwargs)
A txt file reader for line profile data.
source code
 
readTxt(self)
Read the txt file.
source code

Inherited from cc.tools.readers.LPDataReader.LPDataReader: checkVlsr, getDateObs, getFlux, getNoise, getVelocity, getVexp, getVlsr, setNoise, setVexp

Inherited from cc.tools.readers.Reader.Reader: getFile, readFile

Inherited from dict: __cmp__, __contains__, __delitem__, __eq__, __ge__, __getattribute__, __getitem__, __gt__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __repr__, __setitem__, __sizeof__, clear, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values, viewitems, viewkeys, viewvalues

Inherited from object: __delattr__, __format__, __reduce__, __reduce_ex__, __setattr__, __str__, __subclasshook__

Class Variables [hide private]

Inherited from dict: __hash__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, fn, star_name=None, *args, **kwargs)
(Constructor)

source code 

A txt file reader for line profile data.

Filename of the txt file is passed to the object upon creation.

Initialisation of the object will also check Vlsr in Star.dat and add it as a keyword in the contents dictionary.

Text files must consist of two columns: velocity (km/s), flux (unit)

Additional args/kwargs are used for the dict creation of the parent of Reader.

Parameters:
  • fn (string) - The txt filename, including filepath.
  • star_name (str) - The star name if the filename doesn't follow naming conventions. None otherwise.

    (default: None)

Returns:
new empty dictionary

Overrides: object.__init__

readTxt(self)

source code 

Read the txt file.

Assumes Tmb flux values in K, with respect to velocity.