Changeset 1644 for trunk/python

Timestamp:

10/04/09 00:53:18 (15 years ago)

Author:

Max Voronkov

Message:

line finder: added more options on how the noise is to be estimated. See doc on linefinder.set_options for more info

File:

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

trunk/python/asaplinefind.py

@@ -41 +41 @@
 
     def set_options(self,threshold=1.7320508075688772,min_nchan=3,
-        avg_limit=8,box_size=0.2):
+        avg_limit=8,box_size=0.2,noise_box='all',noise_stat='mean80'):
         """
         Set the parameters of the algorithm
@@ -55 +55 @@
                           this parameter can be averaged to search for
                           broad lines. Default is 8.
-             box_size     A running mean box size specified as a fraction
+             box_size     A running mean/median box size specified as a fraction
                           of the total spectrum length. Default is 1/5
+             noise_box    Area of the spectrum used to estimate noise stats
+                          Both string values and numbers are allowed
+                          Allowed string values:
+                             'all' use all the spectrum (default)
+                             'box' noise box is the same as running mean/median
+                                   box
+                          Numeric values are defined as a fraction from the
+                          spectrum size. Values should be positive.
+                          (noise_box == box_size has the same effect as
+                           noise_box = 'box')
+             noise_stat   Statistics used to estimate noise, allowed values:
+                              'mean80' use the 80% of the lowest deviations
+                                       in the noise box (default)
+                              'median' median of deviations in the noise box
+                             
         Note:  For bad baselines threshold should be increased,
                and avg_limit decreased (or even switched off completely by
@@ -62 +77 @@
                undulations instead of real lines.
         """
-        self.finder.setoptions(threshold,min_nchan,avg_limit,box_size)
+        if noise_stat.lower() not in ["mean80",'median']:
+           raise RuntimeError, "noise_stat argument in linefinder.set_options can only be mean80 or median"
+        nStat = (noise_stat.lower() == "median")
+        nBox = -1.
+        if isinstance(noise_box,str):
+           if noise_box.lower() not in ['all','box']:
+              raise RuntimeError, "string-valued noise_box in linefinder.set_options can only be all or box"
+           if noise_box.lower() == 'box':
+              nBox = box_size
+        else:
+           nBox = float(noise_box)
+        self.finder.setoptions(threshold,min_nchan,avg_limit,box_size,nBox,nStat)
         return