Changeset 2810 for trunk

Timestamp:

04/11/13 18:26:00 (12 years ago)

Author:

WataruKawasaki

Message:

New Development: No

JIRA Issue: No

Ready for Test: Yes

Interface Changes: No

What Interface Changed:

Test Programs:

Put in Release Notes: No

Module(s): sd.scantable

Description: a bug fix in sd.scantable.pack_blinfo().

File:

• trunk/python/scantable.py (modified) (11 diffs)

trunk/python/scantable.py

@@ -266 +266 @@
     if lf_params_n == 3:
         dinfo['use_linefinder'] = 'true'
-    elif lf_params_n == 1:
+    elif lf_params_n == 0:
         dinfo['use_linefinder'] = 'false'
         dinfo['thresh']         = ''
@@ -2700 +2700 @@
 
     @asaplog_post_dec
-    def apply_bltable(self, insitu=None, inbltable=None, outbltable=None, overwrite=None):
+    def apply_bltable(self, insitu=None, retfitres=None, inbltable=None, outbltable=None, overwrite=None):
         """\
         Subtract baseline based on parameters written in Baseline Table.
@@ -2706 +2706 @@
         Parameters:
             insitu:        if True, baseline fitting/subtraction is done
-                           in-situ and fitting results is returned. If
-                           False, a dictionary containing new scantable
-                           (with baseline subtracted) and fitting results
-                           is returned. 
+                           in-situ. If False, a new scantable with
+                           baseline subtracted is returned. Actually,
+                           format of the returned value depends on both 
+                           insitu and retfitres (see below). 
                            The default is taken from .asaprc (False)
+            retfitres:     if True, the results of baseline fitting (i.e.,
+                           coefficients and rms) are returned.
+                           default is False.
+                           The format of the returned value of this
+                           function varies as follows:
+                           (1) in case insitu=True and retfitres=True:
+                               fitting result.
+                           (2) in case insitu=True and retfitres=False:
+                               None.
+                           (3) in case insitu=False and retfitres=True:
+                               a dictionary containing a new scantable
+                               (with baseline subtracted) and the fitting
+                               results.
+                           (4) in case insitu=False and retfitres=False:
+                               a new scantable (with baseline subtracted).
             inbltable:     name of input baseline table. The row number of
                            scantable and that of inbltable must be
@@ -2725 +2740 @@
         try:
             varlist = vars()
+            if retfitres      is None: retfitres      = False
             if inbltable      is None: raise ValueError("bltable missing.")
             if outbltable     is None: outbltable     = ''
@@ -2736 +2752 @@
 
             sres = workscan._apply_bltable(inbltable,
+                                           retfitres,
                                            outbltable,
                                            os.path.exists(outbltable),
                                            overwrite)
-            res = parse_fitresult(sres)
+            if retfitres: res = parse_fitresult(sres)
 
             workscan._add_history('apply_bltable', varlist)
@@ -2745 +2762 @@
             if insitu:
                 self._assign(workscan)
-                return res
+                if retfitres:
+                    return res
+                else:
+                    return None
             else:
-                return {'scantable': workscan, 'fitresults': res}
+                if retfitres:
+                    return {'scantable': workscan, 'fitresults': res}
+                else:
+                    return workscan
         
         except RuntimeError, e:
@@ -2753 +2776 @@
 
     @asaplog_post_dec
-    def sub_baseline(self, insitu=None, blinfo=None, bltable=None, overwrite=None):
+    def sub_baseline(self, insitu=None, retfitres=None, blinfo=None, bltable=None, overwrite=None):
         """\
         Subtract baseline based on parameters written in the input list. 
@@ -2759 +2782 @@
         Parameters:
             insitu:        if True, baseline fitting/subtraction is done
-                           in-situ and fitting results is returned. If
-                           False, a dictionary containing new scantable
-                           (with baseline subtracted) and fitting results
-                           is returned. 
+                           in-situ. If False, a new scantable with
+                           baseline subtracted is returned. Actually,
+                           format of the returned value depends on both 
+                           insitu and retfitres (see below). 
                            The default is taken from .asaprc (False)
+            retfitres:     if True, the results of baseline fitting (i.e.,
+                           coefficients and rms) are returned.
+                           default is False.
+                           The format of the returned value of this
+                           function varies as follows:
+                           (1) in case insitu=True and retfitres=True:
+                               fitting result.
+                           (2) in case insitu=True and retfitres=False:
+                               None.
+                           (3) in case insitu=False and retfitres=True:
+                               a dictionary containing a new scantable
+                               (with baseline subtracted) and the fitting
+                               results.
+                           (4) in case insitu=False and retfitres=False:
+                               a new scantable (with baseline subtracted).
             blinfo:        baseline parameter set stored in a dictionary
                            or a list of dictionary. Each dictionary 
@@ -2803 +2841 @@
         try:
             varlist = vars()
+            if retfitres      is None: retfitres      = False
             if blinfo         is None: blinfo         = []
             if bltable        is None: bltable        = ''
@@ -2820 +2859 @@
 
             sres = workscan._sub_baseline(in_blinfo,
+                                          retfitres,
                                           bltable,
                                           os.path.exists(bltable),
                                           overwrite)
-            res = parse_fitresult(sres)
+            if retfitres: res = parse_fitresult(sres)
             
             workscan._add_history('sub_baseline', varlist)
@@ -2829 +2869 @@
             if insitu:
                 self._assign(workscan)
-                return res
+                if retfitres:
+                    return res
+                else:
+                    return None
             else:
-                return {'scantable': workscan, 'fitresults': res}
+                if retfitres:
+                    return {'scantable': workscan, 'fitresults': res}
+                else:
+                    return workscan
 
         except RuntimeError, e: