Changeset 2809 for trunk

Timestamp:

04/11/13 17:07:34 (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: modified help texts of sub_baseline() and apply_bltable().

File:

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

trunk/python/scantable.py

@@ -2705 +2705 @@
 
         Parameters:
-            insitu:        if False a new scantable is returned.
-                           Otherwise, the scaling is done in-situ
+            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. 
                            The default is taken from .asaprc (False)
             inbltable:     name of input baseline table. The row number of
@@ -2714 +2717 @@
                            parameters and fitting results recorded.
                            default is ''(no output).
-            overwrite:     if True, overwrites the existing baseline table
-                           specified in outbltable.
+            overwrite:     if True when an existing baseline table is
+                           specified for outbltable, overwrites it. 
+                           Otherwise there is no harm.
                            default is False.
         """
@@ -2754 +2758 @@
 
         Parameters:
-            insitu:        if False a new scantable is returned.
-                           Otherwise, the scaling is done in-situ
+            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. 
                            The default is taken from .asaprc (False)
             blinfo:        baseline parameter set stored in a dictionary
@@ -2777 +2784 @@
                            parameters and fitting results recorded.
                            default is ''(no output).
-            overwrite:     if True, overwrites the existing baseline table
-                           specified in bltable.
+            overwrite:     if True when an existing baseline table is
+                           specified for bltable, overwrites it. 
+                           Otherwise there is no harm.
                            default is False.