source: trunk/python/__init__.py@ 186

Last change on this file since 186 was 182, checked in by mar637, 20 years ago

moved reader to the end, as it's behaviour can be emulated with the
scantable constructor.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.5 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: 2005-01-07 00:49:53 +0000 (Fri, 07 Jan 2005) $'
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 [The scan container]
31 scantable - a container for integrations/scans
32 (can open asap/rpfits/sdfits and ms files)
33 copy - returns a copy of a scan
34 get_scan - gets a specific scan out of a scantable
35 summary - print info about the scantable contents
36 set_selection - set a specific Beam/IF/Pol for furthrt use
37 get_selection - print out the current selection
38 stats - get specified statistic of the spectra in
39 the scantable
40 stddev - get the standard deviation of the spectra
41 in the scantable
42 get_tsys - get the TSys
43 get_time - get the timestamps of the integrations
44 set_unit - set the units to be used from this point on
45 set_freqframe - set the frame info for the Spectral Axis
46 (e.g. 'LSRK')
47 create_mask - return a mask in thecurrent unit
48 set_restfreqs - give a list of rest frequencies
49 flag_spectrum - flag a whole Beam/IF/Pol
50 save - save the scantable to disk as either 'ASAP'
51 or 'SDFITS'
52 nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans
53 [Math]
54 average_time - return the (weighted) time average of a scan
55 or a list of scans
56 average_pol - average the polarisations together.
57 The dimension won't be reduced and
58 all polarisations will contain the
59 averaged spectrum.
60 quotient - return the on/off quotient
61 scale - returns a scan scaled by a given factor
62 add - returns a scan with given value added
63 bin - return a scan with binned channels
64 smooth - return the spectrally 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 [Reading files]
80 reader - access rpfits/sdfits files
81 read - read in integrations
82 summary - list info about all integrations
83
84 [General]
85 commands - this command
86 print - print details about a variable
87 list_scans - list all scantables created bt the user
88 del - delete the given variable from memory
89 range - create a list of values, e.g.
90 range(3) = [0,1,2], range(2,5) = [2,3,4]
91 help - print help for one of the listed functions
92 execfile - execute an asap script, e.g. execfile('myscript')
93 """
94 print x
95 return
96
97print """Welcome to ASAP - the ATNF Single Dish Analysis Package
98This is a testing pre-release v0.1a
99
100Please report any bugs to:
101Malte.Marquarding@csiro.au
102
103[NOTE: ASAP is 0-based]
104Type commands() to get a list of all available ASAP commands.
105"""
Note: See TracBrowser for help on using the repository browser.