Changeset 271 for trunk/python

Timestamp:

01/23/05 20:27:12 (21 years ago)

Author:

kil064

Message:

document function 'align' more fully

File:

• trunk/python/asapmath.py (modified) (1 diff)

trunk/python/asapmath.py

@@ -199 +199 @@
 def align(scan, insitu=None):
     """
+        Return a scan where all rows have been aligned in velocity. The
+        velocity reference frame (e.gh. LSRK), unit and doppler (e.g. OPTICAL)
+        are those set by functions  set_unit and set_freqframe.  The data 
+        are aligned to the velocity abcissa at the first time present in the data.
         scan:        a scantable
         insitu:      if False a new scantable is returned.