Changeset 1268 for trunk/python

Timestamp:

09/13/06 11:21:17 (18 years ago)

Author:

vor010

Message:

chan_avg_limit parameter has been added to auto_poly_baseline method. It is passed to linefinder and determines whether to search for broad weak lines to exclude them from the baseline solution. Default value is 1, which means no search for such lines.

File:

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

trunk/python/scantable.py

@@ -1223 +1223 @@
 
     def auto_poly_baseline(self, mask=[], edge=(0, 0), order=0,
-                           threshold=3, plot=False, insitu=None):
+                           threshold=3, chan_avg_limit=1, plot=False, 
+                           insitu=None):
         """
         Return a scan which has been baselined (all rows) by a polynomial.
@@ -1242 +1243 @@
                         keep it large as only strong lines affect the
                         baseline solution.
+            chan_avg_limit:  
+                        a maximum number of consequtive spectral channels to
+                        average during the search of weak and broad lines.
+                        The default is no averaging (and no search for weak
+                        lines). If such lines can affect the fitted baseline
+                        (e.g. a high order polynomial is fitted), increase this
+                        parameter (usually values up to 8 are reasonable). Most
+                        users of this method should find the default value 
+                        sufficient.
             plot:       plot the fit and the residual. In this each
                         indivual fit has to be approved, by typing 'y'
@@ -1284 +1294 @@
         # setup line finder
         fl = linefinder()
-        fl.set_options(threshold=threshold)
+        fl.set_options(threshold=threshold,avg_limit=chan_avg_limit)
 
         if not insitu: