Changeset 210 for trunk/python

Timestamp:

01/18/05 17:48:30 (20 years ago)

Author:

mar637

Message:

Added more help on how to read commands output
Added help on asapplotter

File:

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

trunk/python/__init__.py

@@ -9 +9 @@
 from asapmath import *
 from scantable import *
+print "Initialising plotter..."
+from asapplotter import *
+plotter = asapplotter()
 #from numarray ones,zeros
 
@@ -27 +30 @@
 
 def commands():
-    x = """
+    x = """    
     [The scan container]
         scantable           - a container for integrations/scans
@@ -79 +82 @@
                               set if they should be held fixed during fitting
             get_parameters  - get the fitted parameters
+    [Plotter]
+        asapplotter         - a plotter for asap, default plotter is
+                              called 'plotter'
+            plot            - plot a (list of) scantable
+            set_mode        - set the state of the plotter, i.e.
+                              what is to be plotted 'colour stacked'
+                              and what 'panelled'
+            set_range       - set the abcissa 'zoom' range
+            set_legend_map  - specify user labels for the legend indeces
+            
     [Reading files]
         reader              - access rpfits/sdfits files
@@ -93 +106 @@
         help                - print help for one of the listed functions
         execfile            - execute an asap script, e.g. execfile('myscript')
+    Note:
+        How to use this with help:
+                                         # function 'summary'
+        [xxx] is just a category
+        Every 'sub-level' in this list should be replaces by a '.' Period when
+        using help 
+        Example:
+            ASAP> help scantable # to get info on ths scantable
+            ASAP> help scantable.summary # to get help on the scantable's
+            ASAP> help average_time
+
     """
     print x