source: branches/asap-3.x/python/asapreader.py@ 1804

Last change on this file since 1804 was 1695, checked in by Malte Marquarding, 15 years ago

Use print_log_dec consistently

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 2.6 KB
Line 
1from asap._asap import stfiller
2from asap import print_log_dec
3
4class reader(stfiller):
5 """
6 This class allows the user to import single dish files
7 (rpfits,sdfits,ms).
8 The reader reads in integrations from the file and remains at
9 the fileposition afterwards.
10 Available functions are:
11
12 read() # read until the (current) end of file)
13
14 Example:
15 r = reader('/tmp/P389.rpf')
16 scans r.read() # reads in the complete file into 'scans'
17 print scans # summarises the contents
18 del r # destroys the reader
19
20 IMPORTANT: Due to limitations in the rpfits library, only one reader
21 can be created at a time.
22 r = reader('XYZ.rpf')
23 r2 = reader('ABC.rpf')
24 is NOT possible. This is a limitation affecting
25 rpfits ONLY.
26 """
27 @print_log_dec
28 def __init__(self, filename, unit=None, theif=None, thebeam=None):
29 self.unit = unit
30 """
31 Parameters:
32 filename: the name of an rpfits/sdfits/ms file on disk
33 unit: brightness unit; must be consistent with K or Jy.
34 The default is that a unit is set depending on
35 the telescope. Setting this over-rides that choice.
36 theif: select a specific IF (default is all)
37 thebeam: select a specific beam (default is all)
38 Example:
39 r = reader('/tmp/2001-09-01_0332_P363.rpf', theif=2)
40 """
41 if theif is None:
42 theif = -1
43 if thebeam is None:
44 thebeam = -1
45 from os.path import expandvars
46 filename = expandvars(filename)
47 stfiller.__init__(self, filename, theif, thebeam)
48
49 @print_log_dec
50 def read(self):
51 """
52 Reads in all integrations in the data file.
53 """
54 from asap import scantable
55 from asap import asaplog
56 asaplog.push("Reading integrations from disk...")
57 stfiller._read(self)
58 tbl = stfiller._getdata(self)
59 if self.unit is not None:
60 tbl.set_fluxunit(self.unit)
61 return scantable(tbl)
62
63 def close(self):
64 """
65 Close the reader.
66 """
67 self._close()
68
69 def summary(self, name=None):
70 """
71 Print a summary of all scans/integrations. This reads through the
72 whole file once.
73 Parameters:
74 None
75 Example:
76 r.summary()
77 """
78 stfiller._read(self)
79 from asap import scantable
80 tbl = scantable(stfiller._getdata(self))
81 tbl.summary(name)
82 del tbl
83 return
Note: See TracBrowser for help on using the repository browser.