source: branches/Release2.0/python/asaplinefind.py@ 1531

Last change on this file since 1531 was 929, checked in by mar637, 19 years ago

made it consistent with the interfaces changes at c++ level

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.1 KB
Line 
1import _asap
2
3class linefinder:
4 """
5 The class for automated spectral line search in ASAP.
6
7 Example:
8 fl=linefinder()
9 fl.set_scan(sc)
10 fl.set_options(threshold=3)
11 nlines=fl.find_lines(edge=(50,0))
12 if nlines!=0:
13 print "Found ",nlines," spectral lines"
14 print fl.get_ranges(False)
15 else:
16 print "No lines found!"
17 sc2=sc.poly_baseline(fl.get_mask(),7)
18
19 The algorithm involves a simple threshold criterion. The line is
20 considered to be detected if a specified number of consequtive
21 channels (default is 3) is brighter (with respect to the current baseline
22 estimate) than the threshold times the noise level. This criterion is
23 applied in the iterative procedure updating baseline estimate and trying
24 reduced spectral resolutions to detect broad lines as well. The off-line
25 noise level is determined at each iteration as an average of 80% of the
26 lowest variances across the spectrum (i.e. histogram equalization is
27 used to avoid missing weak lines if strong ones are present). For
28 bad baseline shapes it is recommended to increase the threshold and
29 possibly switch the averaging option off (see set_options) to
30 detect strong lines only, fit a high order baseline and repeat the line
31 search.
32
33 """
34
35 def __init__(self):
36 """
37 Create a line finder object.
38 """
39 self.finder = _asap.linefinder()
40 return
41
42 def set_options(self,threshold=1.7320508075688772,min_nchan=3,
43 avg_limit=8,box_size=0.2):
44 """
45 Set the parameters of the algorithm
46 Parameters:
47 threshold a single channel S/N ratio above which the
48 channel is considered to be a detection
49 Default is sqrt(3), which together with
50 min_nchan=3 gives a 3-sigma criterion
51 min_nchan a minimal number of consequtive channels,
52 which should satisfy a threshold criterion to
53 be a detection. Default is 3.
54 avg_limit A number of consequtive channels not greater than
55 this parameter can be averaged to search for
56 broad lines. Default is 8.
57 box_size A running mean box size specified as a fraction
58 of the total spectrum length. Default is 1/5
59 Note: For bad baselines threshold should be increased,
60 and avg_limit decreased (or even switched off completely by
61 setting this parameter to 1) to avoid detecting baseline
62 undulations instead of real lines.
63 """
64 self.finder.setoptions(threshold,min_nchan,avg_limit,box_size)
65 return
66
67 def set_scan(self, scan):
68 """
69 Set the 'data' (scantable) to work with.
70 Parameters:
71 scan: a scantable
72 """
73 if not scan:
74 raise RuntimeError, 'Please give a correct scan'
75 self.finder.setscan(scan)
76
77 def find_lines(self,nRow=0,mask=[],edge=(0,0)):
78 """
79 Search for spectral lines in the scan assigned in set_scan.
80 Parameters:
81 nRow: a row in the scantable to work with
82 mask: an optional mask (e.g. retreived from scantable)
83 edge: an optional number of channels to drop at
84 the edge of the spectrum. If only one value is
85 specified, the same number will be dropped from
86 both sides of the spectrum. Default is to keep
87 all channels
88 A number of lines found will be returned
89 """
90 if isinstance(edge,int):
91 edge=(edge,)
92
93 from asap import _is_sequence_or_number as _is_valid
94
95 if not _is_valid(edge, int):
96 raise RuntimeError, "Parameter 'edge' has to be an integer or \
97 a pair of integers specified as a tuple"
98
99 if len(edge)>2:
100 raise RuntimeError, "The edge parameter should have two \
101 or less elements"
102 return self.finder.findlines(mask,list(edge),nRow)
103 def get_mask(self,invert=False):
104 """
105 Get the mask to mask out all lines that have been found (default)
106
107 Parameters:
108 invert if True, only channels belong to lines will be unmasked
109
110 Note: all channels originally masked by the input mask or
111 dropped out by the edge parameter will still be excluded
112 regardless on the invert option
113 """
114 return self.finder.getmask(invert)
115 def get_ranges(self,defunits=True):
116 """
117 Get ranges (start and end channels or velocities) for all spectral
118 lines found.
119
120 Parameters:
121 defunits if True (default), the range will use the same units
122 as set for the scan (e.g. LSR velocity)
123 if False, the range will be expressed in channels
124 """
125 if (defunits):
126 return self.finder.getlineranges()
127 else:
128 return self.finder.getlinerangesinchannels()
Note: See TracBrowser for help on using the repository browser.