Changeset 245 for trunk/python

Timestamp:

01/21/05 13:28:15 (20 years ago)

Author:

kil064

Message:

add arg. 'preserve' to quotient. also document algorithm

File:

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

trunk/python/asapmath.py

@@ -40 +40 @@
     return scantable(_av(lst, mask, scanAv, weight))
 
-def quotient(source, reference):
-    """
-    Return the quotient of a 'source' scan and a 'reference' scan
+def quotient(source, reference, preserve=True):
+    """
+    Return the quotient of a 'source' (signal) scan and a 'reference' scan
     Parameters:
         source:        the 'on' scan
         reference:     the 'off' scan
+        preserve:      you can preserve (default) the continuum or 
+                       remove it.  The equations used are 
+                          preserve - Output = Tref * (sig/ref) - Tref
+                          remove   - Output = Tref * (sig/ref) - Tsig
     """
     from asap._asap import quotient as _quot
-    return scantable(_quot(source, reference))
+    return scantable(_quot(source, reference, preserve))
 
 def b_operate(left, right, op='add'):