Changeset 113 for trunk/python/__init__.py

Timestamp:

12/01/04 11:29:39 (19 years ago)

Author:

mar637

Message:

version 0.1a

File:

• trunk/python/__init__.py (modified) (2 diffs)

trunk/python/__init__.py

@@ -5 +5 @@
 #import _asap
 #from asaplot import ASAPlot
-#from asapfitter import AsapFitter
+from asapfitter import *
 from asapreader import reader
 from asapmath import *
@@ -22 +22 @@
     #    t = meta_t
     globs = sys.modules['__main__'].__dict__.iteritems()
-    return map(lambda x: x[0], filter(lambda x: isinstance(x[1], t), globs))
+    print "The user created scantables are:"
+    x = map(lambda x: x[0], filter(lambda x: isinstance(x[1], t), globs))
+    print x
 
-def list_all():
-     return ['reader','scantable','ASAPlot','AsapFitter']
+def commands():
+    x = """
+    [Reading files]
+        reader              - access rpfits/sdfits files
+            read            - read in integrations
+            summary         - list info about all integrations
+    [The scan container]
+        scantable           - a container for integrations/scans
+            copy            - returns a copy of a scan
+            get_scan        - gets a specific scan out of a scantable
+            summary         - print info about the scantable contents
+            set_selection   - set a specific Beam/IF/Pol for furthrt use
+            get_selection   - print out the current selection
+            rms             - get the rms of the spectra in the scantable
+            get_tsys        - get the TSys
+            get_time        - get the timestamps of the integrations
+            set_unit        - set the units to be used from this point on
+            set_freqframe   - set the frame info for the Spectral Axis
+                              (e.g. 'LSRK')
+            create_mask     - return a mask in thecurrent unit
+            set_restfreqs   - give a list of rest frequencies
+            flag_spectrum   - flag a whole Beam/IF/Pol
+            save            - save the scantable to disk
+            nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans 
+    [Math]
+        average_scans       - return the rms-weighted (time) average of
+                              a scan or a list of scans
+        average_pol         - averge the polarisations together.
+                              The dimension won't be reduced and
+                              all polarisations will contain the
+                              averaged spectrum.
+        quotient            - return the on/off quotient
+        scale               - returns a scan scaled by a given factor
+        bin                 - return a scan with binned channels
+        hanning             - return the hanning smoothed scan
+        poly_baseline       - fit a polynomial baseline to all Beams/IFs/Pols
 
-print """
-Welcome to ASAP - the ATNF Single Dish Analysis Package
+        fitter
+            auto_fit        - return a scan where the function is
+                              applied to all Beams/IFs/Pols.
+            commit          - return a new scan where the fits have been
+                              commited.
+            fit             - execute the actual fitting process
+            get_chi2        - get the Chi^2
+            set_scan        - set the scantable to be fit
+            set_function    - set the fitting function
+            set_parameters  - set the parameters for the function(s), and
+                              set if they should be held fixed during fitting
+            get_parameters  - get the fitted parameters
+            
+    [General]
+        commands            - this command
+        print               - print details about a variable
+        list_scans          - list all scantables created bt the user
+        del                 - delete the given variable from memory
+        range               - create a list of values, e.g.
+                              range(3) = [0,1,2], range(2,5) = [2,3,4]
+        help                - print help for one of the listed functions
+        execfile            - execute an asap script, e.g. execfile('myscript')
+    """
+    print x
+    return
+
+print """Welcome to ASAP - the ATNF Single Dish Analysis Package
 This is a testing pre-release v0.1a
 
 Please report any bugs to:
-                 Malte.Marquarding@atnf.csiro.au
+Malte.Marquarding@atnf.csiro.au
 
-NOTE: ASAP is 0-based
+[NOTE: ASAP is 0-based]
+Type commands() to get a list of all available ASAP commands.
 """