source: trunk/python/__init__.py@ 137

Last change on this file since 137 was 128, checked in by kil064, 20 years ago

function 'rms' -> 'stddev'
add function 'stats'
average_scan -> average_time

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.3 KB
Line 
1"""
2This is the ATNF Single Dish Analysis package.
3
4"""
5#import _asap
6#from asaplot import ASAPlot
7from asapfitter import *
8from asapreader import reader
9from asapmath import *
10from scantable import *
11#from numarray ones,zeros
12
13__date__ = '$Date: 2004-12-20 04:36:48 +0000 (Mon, 20 Dec 2004) $'
14__version__ = '0.1a'
15
16def list_scans(t = scantable):
17 import sys, types
18 #meta_t = type(t)
19 #if meta_t == types.InstanceType:
20 # t = t.__class__
21 #elif meta_t not in [types.ClassType, types.TypeType]:
22 # t = meta_t
23 globs = sys.modules['__main__'].__dict__.iteritems()
24 print "The user created scantables are:"
25 x = map(lambda x: x[0], filter(lambda x: isinstance(x[1], t), globs))
26 print x
27
28def commands():
29 x = """
30 [Reading files]
31 reader - access rpfits/sdfits files
32 read - read in integrations
33 summary - list info about all integrations
34 [The scan container]
35 scantable - a container for integrations/scans
36 copy - returns a copy of a scan
37 get_scan - gets a specific scan out of a scantable
38 summary - print info about the scantable contents
39 set_selection - set a specific Beam/IF/Pol for furthrt use
40 get_selection - print out the current selection
41 stats - get specified statistic of the spectra in the scantable
42 stddev - get the standard deviation of the spectra in the scantable
43 get_tsys - get the TSys
44 get_time - get the timestamps of the integrations
45 set_unit - set the units to be used from this point on
46 set_freqframe - set the frame info for the Spectral Axis
47 (e.g. 'LSRK')
48 create_mask - return a mask in thecurrent unit
49 set_restfreqs - give a list of rest frequencies
50 flag_spectrum - flag a whole Beam/IF/Pol
51 save - save the scantable to disk as either 'ASAP'
52 or 'SDFITS'
53 nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans
54 [Math]
55 average_time - return the rms-weighted (time) average of
56 a scan or a list of scans
57 average_pol - average the polarisations together.
58 The dimension won't be reduced and
59 all polarisations will contain the
60 averaged spectrum.
61 quotient - return the on/off quotient
62 scale - returns a scan scaled by a given factor
63 bin - return a scan with binned channels
64 hanning - return the hanning smoothed scan
65 poly_baseline - fit a polynomial baseline to all Beams/IFs/Pols
66
67 fitter
68 auto_fit - return a scan where the function is
69 applied to all Beams/IFs/Pols.
70 commit - return a new scan where the fits have been
71 commited.
72 fit - execute the actual fitting process
73 get_chi2 - get the Chi^2
74 set_scan - set the scantable to be fit
75 set_function - set the fitting function
76 set_parameters - set the parameters for the function(s), and
77 set if they should be held fixed during fitting
78 get_parameters - get the fitted parameters
79
80 [General]
81 commands - this command
82 print - print details about a variable
83 list_scans - list all scantables created bt the user
84 del - delete the given variable from memory
85 range - create a list of values, e.g.
86 range(3) = [0,1,2], range(2,5) = [2,3,4]
87 help - print help for one of the listed functions
88 execfile - execute an asap script, e.g. execfile('myscript')
89 """
90 print x
91 return
92
93print """Welcome to ASAP - the ATNF Single Dish Analysis Package
94This is a testing pre-release v0.1a
95
96Please report any bugs to:
97Malte.Marquarding@csiro.au
98
99[NOTE: ASAP is 0-based]
100Type commands() to get a list of all available ASAP commands.
101"""
Note: See TracBrowser for help on using the repository browser.