source: trunk/python/__init__.py@ 290

Last change on this file since 290 was 285, checked in by mar637, 20 years ago

added test for $DISPLAY env variable.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 12.6 KB
Line 
1"""
2This is the ATNF Single Dish Analysis package.
3
4"""
5import os,sys
6
7def validate_bool(b):
8 'Convert b to a boolean or raise'
9 bl = b.lower()
10 if bl in ('f', 'no', 'false', '0', 0): return False
11 elif bl in ('t', 'yes', 'true', '1', 1): return True
12 else:
13 raise ValueError('Could not convert "%s" to boolean' % b)
14
15def validate_int(s):
16 'convert s to int or raise'
17 try: return int(s)
18 except ValueError:
19 raise ValueError('Could not convert "%s" to int' % s)
20
21def asap_fname():
22 """
23 Return the path to the rc file
24
25 Search order:
26
27 * current working dir
28 * environ var ASAPRC
29 * HOME/.asaprc
30
31 """
32
33 fname = os.path.join( os.getcwd(), '.asaprc')
34 if os.path.exists(fname): return fname
35
36 if os.environ.has_key('ASAPRC'):
37 path = os.environ['ASAPRC']
38 if os.path.exists(path):
39 fname = os.path.join(path, '.asaprc')
40 if os.path.exists(fname):
41 return fname
42
43 if os.environ.has_key('HOME'):
44 home = os.environ['HOME']
45 fname = os.path.join(home, '.asaprc')
46 if os.path.exists(fname):
47 return fname
48 return None
49
50
51defaultParams = {
52 # general
53 'verbose' : [True, validate_bool],
54 'useplotter' : [True, validate_bool],
55 'insitu' : [False, validate_bool],
56
57 # plotting
58 'plotter.stacking' : ['p', str],
59 'plotter.panelling' : ['s', str],
60
61 # scantable
62 'scantable.save' : ['ASAP', str],
63 'scantable.autoaverage' : [True, validate_bool],
64 'scantable.freqframe' : ['LSRK', str], #default frequency frame
65 'scantable.allaxes' : [True, validate_bool], # apply action to all axes
66 'scantable.plotter' : [True, validate_bool], # use internal plotter
67
68 # fitter
69 }
70
71def list_rcparameters():
72
73 print """
74 # general
75 # print verbose output
76 'verbose' : True
77
78 # preload a default plotter
79 'useplotter' : True
80
81 # apply operations on the input scantable or return new one
82 'insitu' : False
83
84 # plotting
85 # default mode for colour stacking
86 'plotter.stacking' : 'Pol'
87
88 # default mode for panelling
89 'plotter.panelling' : 'scan'
90
91 # scantable
92 # default ouput format when saving
93 'scantable.save' : 'ASAP'
94 # auto averaging on read
95 'scantable.autoaverage' : True
96
97 # default frequency frame to set when function
98 # scantable.set_freqfrmae is called
99 'scantable.freqframe' : 'LSRK'
100
101 # apply action to all axes not just the cursor location
102 'scantable.allaxes' : True
103
104 # use internal plotter
105 'scantable.plotter' : True
106
107 # Fitter
108 """
109
110def rc_params():
111 'Return the default params updated from the values in the rc file'
112
113 fname = asap_fname()
114
115 if fname is None or not os.path.exists(fname):
116 message = 'could not find rc file; returning defaults'
117 ret = dict([ (key, tup[0]) for key, tup in defaultParams.items()])
118 #print message
119 return ret
120
121 cnt = 0
122 for line in file(fname):
123 cnt +=1
124 line = line.strip()
125 if not len(line): continue
126 if line.startswith('#'): continue
127 tup = line.split(':',1)
128 if len(tup) !=2:
129 print ('Illegal line #%d\n\t%s\n\tin file "%s"' % (cnt, line, fname))
130 continue
131
132 key, val = tup
133 key = key.strip()
134 if not defaultParams.has_key(key):
135 print ('Bad key "%s" on line %d in %s' % (key, cnt, fname))
136 continue
137
138 default, converter = defaultParams[key]
139
140 ind = val.find('#')
141 if ind>=0: val = val[:ind] # ignore trailing comments
142 val = val.strip()
143 try: cval = converter(val) # try to convert to proper type or raise
144 except Exception, msg:
145 print ('Bad val "%s" on line #%d\n\t"%s"\n\tin file "%s"\n\t%s' % (val, cnt, line, fname, msg))
146 continue
147 else:
148 # Alles Klar, update dict
149 defaultParams[key][0] = cval
150
151 # strip the conveter funcs and return
152 ret = dict([ (key, tup[0]) for key, tup in defaultParams.items()])
153 verbose.report('loaded rc file %s'%fname)
154
155 return ret
156
157
158# this is the instance used by the asap classes
159rcParams = rc_params()
160
161rcParamsDefault = dict(rcParams.items()) # a copy
162
163def rc(group, **kwargs):
164 """
165 Set the current rc params. Group is the grouping for the rc, eg
166 for lines.linewidth the group is 'lines', for axes.facecolor, the
167 group is 'axes', and so on. kwargs is a list of attribute
168 name/value pairs, eg
169
170 rc('lines', linewidth=2, color='r')
171
172 sets the current rc params and is equivalent to
173
174 rcParams['lines.linewidth'] = 2
175 rcParams['lines.color'] = 'r'
176
177
178 Note you can use python's kwargs dictionary facility to store
179 dictionaries of default parameters. Eg, you can customize the
180 font rc as follows
181
182 font = {'family' : 'monospace',
183 'weight' : 'bold',
184 'size' : 'larger',
185 }
186
187 rc('font', **font) # pass in the font dict as kwargs
188
189 This enables you to easily switch between several configurations.
190 Use rcdefaults to restore the default rc params after changes.
191 """
192
193 aliases = {
194 }
195
196 for k,v in kwargs.items():
197 name = aliases.get(k) or k
198 key = '%s.%s' % (group, name)
199 if not rcParams.has_key(key):
200 raise KeyError('Unrecognized key "%s" for group "%s" and name "%s"' % (key, group, name))
201
202 rcParams[key] = v
203
204
205def rcdefaults():
206 """
207 Restore the default rc params - the ones that were created at
208 asap load time
209 """
210 rcParams.update(rcParamsDefault)
211
212from asapfitter import *
213from asapreader import reader
214from asapmath import *
215from scantable import *
216
217if rcParams['useplotter']:
218 if os.environ.has_key('DISPLAY'):
219 print "Initialising plotter..."
220 import asapplotter
221 plotter = asapplotter.asapplotter()
222 else:
223 print "No $DISPLAY set. Disabling plotter\n"
224
225#from numarray ones,zeros
226
227__date__ = '$Date: 2005-01-24 06:38:16 +0000 (Mon, 24 Jan 2005) $'
228__version__ = '0.2'
229
230def list_scans(t = scantable):
231 import sys, types
232 #meta_t = type(t)
233 #if meta_t == types.InstanceType:
234 # t = t.__class__
235 #elif meta_t not in [types.ClassType, types.TypeType]:
236 # t = meta_t
237 globs = sys.modules['__main__'].__dict__.iteritems()
238 print "The user created scantables are:"
239 x = map(lambda x: x[0], filter(lambda x: isinstance(x[1], t), globs))
240 print x
241
242def commands():
243 x = """
244 [The scan container]
245 scantable - a container for integrations/scans
246 (can open asap/rpfits/sdfits and ms files)
247 copy - returns a copy of a scan
248 get_scan - gets a specific scan out of a scantable
249 summary - print info about the scantable contents
250 set_cursor - set a specific Beam/IF/Pol 'cursor' for
251 further use
252 get_cursor - print out the current cursor position
253 stats - get specified statistic of the spectra in
254 the scantable
255 stddev - get the standard deviation of the spectra
256 in the scantable
257 get_tsys - get the TSys
258 get_time - get the timestamps of the integrations
259 get_unit - get the currnt unit
260 set_unit - set the abcissa unit to be used from this point on
261 get_abcissa - get the abcissa values and name for a given
262 row (time)
263 set_freqframe - set the frame info for the Spectral Axis
264 (e.g. 'LSRK')
265 set_doppler - set the doppler to be used from this point on
266 set_instrument - set the instrument name
267 get_fluxunit - get the brightness flux unit
268 set_fluxunit - set the brightness flux unit
269 create_mask - return an mask in the current unit
270 for the given region. The specified regions
271 are NOT masked
272 get_restfreqs - get the current list of rest frequencies
273 set_restfreqs - set a list of rest frequencies
274 flag_spectrum - flag a whole Beam/IF/Pol
275 save - save the scantable to disk as either 'ASAP'
276 or 'SDFITS'
277 nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans
278 [Math]
279 average_time - return the (weighted) time average of a scan
280 or a list of scans
281 average_pol - average the polarisations together.
282 The dimension won't be reduced and
283 all polarisations will contain the
284 averaged spectrum.
285 quotient - return the on/off quotient
286 simple_math - simple mathematical operations on two scantables,
287 'add', 'sub', 'mul', 'div'
288 scale - returns a scan scaled by a given factor
289 add - returns a scan with given value added
290 bin - return a scan with binned channels
291 smooth - return the spectrally smoothed scan
292 poly_baseline - fit a polynomial baseline to all Beams/IFs/Pols
293 gain_el - apply gain-elevation correction
294 opacity - apply opacity correction
295 convert_flux - convert to and from Jy and Kelvin brightness
296 units
297
298 fitter
299 auto_fit - return a scan where the function is
300 applied to all Beams/IFs/Pols.
301 commit - return a new scan where the fits have been
302 commited.
303 fit - execute the actual fitting process
304 get_chi2 - get the Chi^2
305 set_scan - set the scantable to be fit
306 set_function - set the fitting function
307 set_parameters - set the parameters for the function(s), and
308 set if they should be held fixed during fitting
309 get_parameters - get the fitted parameters
310 [Plotter]
311 asapplotter - a plotter for asap, default plotter is
312 called 'plotter'
313 plot - plot a (list of) scantable
314 set_mode - set the state of the plotter, i.e.
315 what is to be plotted 'colour stacked'
316 and what 'panelled'
317 set_range - set the abcissa 'zoom' range
318 set_legend - specify user labels for the legend indeces
319 set_title - specify user labels for the panel indeces
320 set_ordinate - specify a user label for the ordinate
321 set_abcissa - specify a user label for the abcissa
322
323 [Reading files]
324 reader - access rpfits/sdfits files
325 read - read in integrations
326 summary - list info about all integrations
327
328 [General]
329 commands - this command
330 print - print details about a variable
331 list_scans - list all scantables created bt the user
332 del - delete the given variable from memory
333 range - create a list of values, e.g.
334 range(3) = [0,1,2], range(2,5) = [2,3,4]
335 help - print help for one of the listed functions
336 execfile - execute an asap script, e.g. execfile('myscript')
337 list_rcparameters - print out a list of possible values to be
338 put into $HOME/.asaprc
339 Note:
340 How to use this with help:
341 # function 'summary'
342 [xxx] is just a category
343 Every 'sub-level' in this list should be replaces by a '.' Period when
344 using help
345 Example:
346 ASAP> help scantable # to get info on ths scantable
347 ASAP> help scantable.summary # to get help on the scantable's
348 ASAP> help average_time
349
350 """
351 print x
352 return
353
354print """Welcome to ASAP - the ATNF Single Dish Analysis Package
355This is a testing pre-release v0.2
356
357Please report any bugs to:
358Malte.Marquarding@csiro.au
359
360[NOTE: ASAP is 0-based]
361Type commands() to get a list of all available ASAP commands.
362"""
Note: See TracBrowser for help on using the repository browser.