Changeset 733 for trunk/python

Timestamp:

11/24/05 14:12:33 (19 years ago)

Author:

mar637

Message:

documentation fixes

File:

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

trunk/python/__init__.py

@@ -99 +99 @@
     plotter.panelling          : scan
 
-    # push panels together, to shar axislabels
+    # push panels together, to share axislabels
     plotter.ganged             : True
+
+    # decimate the number of points plotted bya afactor of
+    # nchan/1024
+    plotter.decimate           : False
 
     # default colours/linestyles
@@ -282 +286 @@
             copy            - returns a copy of a scan
             get_scan        - gets a specific scan out of a scantable
+                              (by name or number)
             summary         - print info about the scantable contents
             set_cursor      - set a specific Beam/IF/Pol 'cursor' for
@@ -292 +297 @@
             get_tsys        - get the TSys
             get_time        - get the timestamps of the integrations
+            get_sourcename  - get the source names of the scans
             get_unit        - get the currnt unit
             set_unit        - set the abcissa unit to be used from this
@@ -313 +319 @@
                               or 'SDFITS'
             nbeam,nif,nchan,npol - the number of beams/IFs/Pols/Chans
+            nscan           - the number of scans in the scantable
+            nrow            - te number of integrations in the scantable
             history         - print the history of the scantable
             get_fit         - get a fit which has been stored witnh the data
@@ -323 +331 @@
             auto_quotient   - return the on/off quotient with
                               automatic detection of the on/off scans
+                              (matched pairs and 1 off - n on)
             quotient        - return the on/off quotient
             scale           - return a scan scaled by a given factor
@@ -339 +348 @@
             rotate_linpolphase - rotate the phase of the complex
                                  polarization O=Q+iU correlation
+            freq_switch     - perform frequency switching on the data
+            stats           - Determine the specified statistic, e.g. 'min'
+                              'max', 'rms' etc.
+            stddev          - Determine the standard deviation of the current
+                              beam/if/pol
+
      [Math] Mainly functions which operate on more than one scantable
 
@@ -373 +388 @@
                               and what 'panelled'
             set_cursor      - only plot a selected part of the data
-            set_range       - set a 'zoom' window
+            set_range       - set a 'zoom' window [xmin,xmax,ymin,ymax]
             set_legend      - specify user labels for the legend indeces
             set_title       - specify user labels for the panel indeces
+            set_abcissa     - specify a user label for the abcissa
             set_ordinate    - specify a user label for the ordinate
-            set_abcissa     - specify a user label for the abcissa
             set_layout      - specify the multi-panel layout (rows,cols)
+            set_colors      - specify a set of colours to use
+            set_linestyles  - specify a set of linestyles to use if only
+                              using one color
+            set_mask        - set a plotting mask for a specific polarization
 
     [Reading files]