1 | //#--------------------------------------------------------------------------- |
---|
2 | //# STLineFinder.cc: A class for automated spectral line search |
---|
3 | //#-------------------------------------------------------------------------- |
---|
4 | //# Copyright (C) 2004 |
---|
5 | //# ATNF |
---|
6 | //# |
---|
7 | //# This program is free software; you can redistribute it and/or modify it |
---|
8 | //# under the terms of the GNU General Public License as published by the Free |
---|
9 | //# Software Foundation; either version 2 of the License, or (at your option) |
---|
10 | //# any later version. |
---|
11 | //# |
---|
12 | //# This program is distributed in the hope that it will be useful, but |
---|
13 | //# WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
14 | //# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General |
---|
15 | //# Public License for more details. |
---|
16 | //# |
---|
17 | //# You should have received a copy of the GNU General Public License along |
---|
18 | //# with this program; if not, write to the Free Software Foundation, Inc., |
---|
19 | //# 675 Massachusetts Ave, Cambridge, MA 02139, USA. |
---|
20 | //# |
---|
21 | //# Correspondence concerning this software should be addressed as follows: |
---|
22 | //# Internet email: Malte.Marquarding@csiro.au |
---|
23 | //# Postal address: Malte Marquarding, |
---|
24 | //# Australia Telescope National Facility, |
---|
25 | //# P.O. Box 76, |
---|
26 | //# Epping, NSW, 2121, |
---|
27 | //# AUSTRALIA |
---|
28 | //# |
---|
29 | //# $Id: STLineFinder.cpp 996 2006-04-06 03:45:58Z mar637 $ |
---|
30 | //#--------------------------------------------------------------------------- |
---|
31 | |
---|
32 | |
---|
33 | // ASAP |
---|
34 | #include "STLineFinder.h" |
---|
35 | #include "STFitter.h" |
---|
36 | |
---|
37 | // STL |
---|
38 | #include <functional> |
---|
39 | #include <algorithm> |
---|
40 | #include <iostream> |
---|
41 | #include <fstream> |
---|
42 | |
---|
43 | using namespace asap; |
---|
44 | using namespace casa; |
---|
45 | using namespace std; |
---|
46 | |
---|
47 | namespace asap { |
---|
48 | |
---|
49 | /////////////////////////////////////////////////////////////////////////////// |
---|
50 | // |
---|
51 | // RunningBox - a running box calculator. This class implements |
---|
52 | // interations over the specified spectrum and calculates |
---|
53 | // running box filter statistics. |
---|
54 | // |
---|
55 | |
---|
56 | class RunningBox { |
---|
57 | // The input data to work with. Use reference symantics to avoid |
---|
58 | // an unnecessary copying |
---|
59 | const casa::Vector<casa::Float> &spectrum; // a buffer for the spectrum |
---|
60 | const casa::Vector<casa::Bool> &mask; // associated mask |
---|
61 | const std::pair<int,int> &edge; // start and stop+1 channels |
---|
62 | // to work with |
---|
63 | |
---|
64 | // statistics for running box filtering |
---|
65 | casa::Float sumf; // sum of fluxes |
---|
66 | casa::Float sumf2; // sum of squares of fluxes |
---|
67 | casa::Float sumch; // sum of channel numbers (for linear fit) |
---|
68 | casa::Float sumch2; // sum of squares of channel numbers (for linear fit) |
---|
69 | casa::Float sumfch; // sum of flux*(channel number) (for linear fit) |
---|
70 | |
---|
71 | int box_chan_cntr; // actual number of channels in the box |
---|
72 | int max_box_nchan; // maximum allowed number of channels in the box |
---|
73 | // (calculated from boxsize and actual spectrum size) |
---|
74 | // cache for derivative statistics |
---|
75 | mutable casa::Bool need2recalculate; // if true, values of the statistics |
---|
76 | // below are invalid |
---|
77 | mutable casa::Float linmean; // a value of the linear fit to the |
---|
78 | // points in the running box |
---|
79 | mutable casa::Float linvariance; // the same for variance |
---|
80 | int cur_channel; // the number of the current channel |
---|
81 | int start_advance; // number of channel from which the box can |
---|
82 | // be moved (the middle of the box, if there is no |
---|
83 | // masking) |
---|
84 | public: |
---|
85 | // set up the object with the references to actual data |
---|
86 | // as well as the number of channels in the running box |
---|
87 | RunningBox(const casa::Vector<casa::Float> &in_spectrum, |
---|
88 | const casa::Vector<casa::Bool> &in_mask, |
---|
89 | const std::pair<int,int> &in_edge, |
---|
90 | int in_max_box_nchan) throw(AipsError); |
---|
91 | |
---|
92 | // access to the statistics |
---|
93 | const casa::Float& getLinMean() const throw(AipsError); |
---|
94 | const casa::Float& getLinVariance() const throw(AipsError); |
---|
95 | const casa::Float aboveMean() const throw(AipsError); |
---|
96 | int getChannel() const throw(); |
---|
97 | |
---|
98 | // actual number of channels in the box (max_box_nchan, if no channels |
---|
99 | // are masked) |
---|
100 | int getNumberOfBoxPoints() const throw(); |
---|
101 | |
---|
102 | // next channel |
---|
103 | void next() throw(AipsError); |
---|
104 | |
---|
105 | // checking whether there are still elements |
---|
106 | casa::Bool haveMore() const throw(); |
---|
107 | |
---|
108 | // go to start |
---|
109 | void rewind() throw(AipsError); |
---|
110 | |
---|
111 | protected: |
---|
112 | // supplementary function to control running mean calculations. |
---|
113 | // It adds a specified channel to the running mean box and |
---|
114 | // removes (ch-maxboxnchan+1)'th channel from there |
---|
115 | // Channels, for which the mask is false or index is beyond the |
---|
116 | // allowed range, are ignored |
---|
117 | void advanceRunningBox(int ch) throw(casa::AipsError); |
---|
118 | |
---|
119 | // calculate derivative statistics. This function is const, because |
---|
120 | // it updates the cache only |
---|
121 | void updateDerivativeStatistics() const throw(AipsError); |
---|
122 | }; |
---|
123 | |
---|
124 | // |
---|
125 | /////////////////////////////////////////////////////////////////////////////// |
---|
126 | |
---|
127 | /////////////////////////////////////////////////////////////////////////////// |
---|
128 | // |
---|
129 | // LFAboveThreshold An algorithm for line detection using running box |
---|
130 | // statistics. Line is detected if it is above the |
---|
131 | // specified threshold at the specified number of |
---|
132 | // consequtive channels. Prefix LF stands for Line Finder |
---|
133 | // |
---|
134 | class LFAboveThreshold : protected LFLineListOperations { |
---|
135 | // temporary line edge channels and flag, which is True if the line |
---|
136 | // was detected in the previous channels. |
---|
137 | std::pair<int,int> cur_line; |
---|
138 | casa::Bool is_detected_before; |
---|
139 | int min_nchan; // A minimum number of consequtive |
---|
140 | // channels, which should satisfy |
---|
141 | // the detection criterion, to be |
---|
142 | // a detection |
---|
143 | casa::Float threshold; // detection threshold - the |
---|
144 | // minimal signal to noise ratio |
---|
145 | std::list<pair<int,int> > &lines; // list where detections are saved |
---|
146 | // (pair: start and stop+1 channel) |
---|
147 | RunningBox *running_box; // running box filter |
---|
148 | casa::Vector<Int> signs; // An array to store the signs of |
---|
149 | // the value - current mean |
---|
150 | // (used to search wings) |
---|
151 | casa::Int last_sign; // a sign (+1, -1 or 0) of the |
---|
152 | // last point of the detected line |
---|
153 | // |
---|
154 | public: |
---|
155 | |
---|
156 | // set up the detection criterion |
---|
157 | LFAboveThreshold(std::list<pair<int,int> > &in_lines, |
---|
158 | int in_min_nchan = 3, |
---|
159 | casa::Float in_threshold = 5) throw(); |
---|
160 | virtual ~LFAboveThreshold() throw(); |
---|
161 | |
---|
162 | // replace the detection criterion |
---|
163 | void setCriterion(int in_min_nchan, casa::Float in_threshold) throw(); |
---|
164 | |
---|
165 | // return the array with signs of the value-current mean |
---|
166 | // An element is +1 if value>mean, -1 if less, 0 if equal. |
---|
167 | // This array is updated each time the findLines method is called and |
---|
168 | // is used to search the line wings |
---|
169 | const casa::Vector<Int>& getSigns() const throw(); |
---|
170 | |
---|
171 | // find spectral lines and add them into list |
---|
172 | // if statholder is not NULL, the accumulate function of it will be |
---|
173 | // called for each channel to save statistics |
---|
174 | // spectrum, mask and edge - reference to the data |
---|
175 | // max_box_nchan - number of channels in the running box |
---|
176 | void findLines(const casa::Vector<casa::Float> &spectrum, |
---|
177 | const casa::Vector<casa::Bool> &mask, |
---|
178 | const std::pair<int,int> &edge, |
---|
179 | int max_box_nchan) throw(casa::AipsError); |
---|
180 | |
---|
181 | protected: |
---|
182 | |
---|
183 | // process a channel: update curline and is_detected before and |
---|
184 | // add a new line to the list, if necessary using processCurLine() |
---|
185 | // detect=true indicates that the current channel satisfies the criterion |
---|
186 | void processChannel(Bool detect, const casa::Vector<casa::Bool> &mask) |
---|
187 | throw(casa::AipsError); |
---|
188 | |
---|
189 | // process the interval of channels stored in curline |
---|
190 | // if it satisfies the criterion, add this interval as a new line |
---|
191 | void processCurLine(const casa::Vector<casa::Bool> &mask) |
---|
192 | throw(casa::AipsError); |
---|
193 | |
---|
194 | // get the sign of runningBox->aboveMean(). The RunningBox pointer |
---|
195 | // should be defined |
---|
196 | casa::Int getAboveMeanSign() const throw(); |
---|
197 | }; |
---|
198 | |
---|
199 | // |
---|
200 | /////////////////////////////////////////////////////////////////////////////// |
---|
201 | |
---|
202 | } // namespace asap |
---|
203 | |
---|
204 | /////////////////////////////////////////////////////////////////////////////// |
---|
205 | // |
---|
206 | // RunningBox - a running box calculator. This class implements |
---|
207 | // interations over the specified spectrum and calculates |
---|
208 | // running box filter statistics. |
---|
209 | // |
---|
210 | |
---|
211 | // set up the object with the references to actual data |
---|
212 | // and the number of channels in the running box |
---|
213 | RunningBox::RunningBox(const casa::Vector<casa::Float> &in_spectrum, |
---|
214 | const casa::Vector<casa::Bool> &in_mask, |
---|
215 | const std::pair<int,int> &in_edge, |
---|
216 | int in_max_box_nchan) throw(AipsError) : |
---|
217 | spectrum(in_spectrum), mask(in_mask), edge(in_edge), |
---|
218 | max_box_nchan(in_max_box_nchan) |
---|
219 | { |
---|
220 | rewind(); |
---|
221 | } |
---|
222 | |
---|
223 | void RunningBox::rewind() throw(AipsError) { |
---|
224 | // fill statistics for initial box |
---|
225 | box_chan_cntr=0; // no channels are currently in the box |
---|
226 | sumf=0.; // initialize statistics |
---|
227 | sumf2=0.; |
---|
228 | sumch=0.; |
---|
229 | sumch2=0.; |
---|
230 | sumfch=0.; |
---|
231 | int initial_box_ch=edge.first; |
---|
232 | for (;initial_box_ch<edge.second && box_chan_cntr<max_box_nchan; |
---|
233 | ++initial_box_ch) |
---|
234 | advanceRunningBox(initial_box_ch); |
---|
235 | |
---|
236 | if (initial_box_ch==edge.second) |
---|
237 | throw AipsError("RunningBox::rewind - too much channels are masked"); |
---|
238 | |
---|
239 | cur_channel=edge.first; |
---|
240 | start_advance=initial_box_ch-max_box_nchan/2; |
---|
241 | } |
---|
242 | |
---|
243 | // access to the statistics |
---|
244 | const casa::Float& RunningBox::getLinMean() const throw(AipsError) |
---|
245 | { |
---|
246 | DebugAssert(cur_channel<edge.second, AipsError); |
---|
247 | if (need2recalculate) updateDerivativeStatistics(); |
---|
248 | return linmean; |
---|
249 | } |
---|
250 | |
---|
251 | const casa::Float& RunningBox::getLinVariance() const throw(AipsError) |
---|
252 | { |
---|
253 | DebugAssert(cur_channel<edge.second, AipsError); |
---|
254 | if (need2recalculate) updateDerivativeStatistics(); |
---|
255 | return linvariance; |
---|
256 | } |
---|
257 | |
---|
258 | const casa::Float RunningBox::aboveMean() const throw(AipsError) |
---|
259 | { |
---|
260 | DebugAssert(cur_channel<edge.second, AipsError); |
---|
261 | if (need2recalculate) updateDerivativeStatistics(); |
---|
262 | return spectrum[cur_channel]-linmean; |
---|
263 | } |
---|
264 | |
---|
265 | int RunningBox::getChannel() const throw() |
---|
266 | { |
---|
267 | return cur_channel; |
---|
268 | } |
---|
269 | |
---|
270 | // actual number of channels in the box (max_box_nchan, if no channels |
---|
271 | // are masked) |
---|
272 | int RunningBox::getNumberOfBoxPoints() const throw() |
---|
273 | { |
---|
274 | return box_chan_cntr; |
---|
275 | } |
---|
276 | |
---|
277 | // supplementary function to control running mean calculations. |
---|
278 | // It adds a specified channel to the running mean box and |
---|
279 | // removes (ch-max_box_nchan+1)'th channel from there |
---|
280 | // Channels, for which the mask is false or index is beyond the |
---|
281 | // allowed range, are ignored |
---|
282 | void RunningBox::advanceRunningBox(int ch) throw(AipsError) |
---|
283 | { |
---|
284 | if (ch>=edge.first && ch<edge.second) |
---|
285 | if (mask[ch]) { // ch is a valid channel |
---|
286 | ++box_chan_cntr; |
---|
287 | sumf+=spectrum[ch]; |
---|
288 | sumf2+=square(spectrum[ch]); |
---|
289 | sumch+=Float(ch); |
---|
290 | sumch2+=square(Float(ch)); |
---|
291 | sumfch+=spectrum[ch]*Float(ch); |
---|
292 | need2recalculate=True; |
---|
293 | } |
---|
294 | int ch2remove=ch-max_box_nchan; |
---|
295 | if (ch2remove>=edge.first && ch2remove<edge.second) |
---|
296 | if (mask[ch2remove]) { // ch2remove is a valid channel |
---|
297 | --box_chan_cntr; |
---|
298 | sumf-=spectrum[ch2remove]; |
---|
299 | sumf2-=square(spectrum[ch2remove]); |
---|
300 | sumch-=Float(ch2remove); |
---|
301 | sumch2-=square(Float(ch2remove)); |
---|
302 | sumfch-=spectrum[ch2remove]*Float(ch2remove); |
---|
303 | need2recalculate=True; |
---|
304 | } |
---|
305 | } |
---|
306 | |
---|
307 | // next channel |
---|
308 | void RunningBox::next() throw(AipsError) |
---|
309 | { |
---|
310 | AlwaysAssert(cur_channel<edge.second,AipsError); |
---|
311 | ++cur_channel; |
---|
312 | if (cur_channel+max_box_nchan/2<edge.second && cur_channel>=start_advance) |
---|
313 | advanceRunningBox(cur_channel+max_box_nchan/2); // update statistics |
---|
314 | } |
---|
315 | |
---|
316 | // checking whether there are still elements |
---|
317 | casa::Bool RunningBox::haveMore() const throw() |
---|
318 | { |
---|
319 | return cur_channel<edge.second; |
---|
320 | } |
---|
321 | |
---|
322 | // calculate derivative statistics. This function is const, because |
---|
323 | // it updates the cache only |
---|
324 | void RunningBox::updateDerivativeStatistics() const throw(AipsError) |
---|
325 | { |
---|
326 | AlwaysAssert(box_chan_cntr, AipsError); |
---|
327 | |
---|
328 | Float mean=sumf/Float(box_chan_cntr); |
---|
329 | |
---|
330 | // linear LSF formulae |
---|
331 | Float meanch=sumch/Float(box_chan_cntr); |
---|
332 | Float meanch2=sumch2/Float(box_chan_cntr); |
---|
333 | if (meanch==meanch2 || box_chan_cntr<3) { |
---|
334 | // vertical line in the spectrum, can't calculate linmean and linvariance |
---|
335 | linmean=0.; |
---|
336 | linvariance=0.; |
---|
337 | } else { |
---|
338 | Float coeff=(sumfch/Float(box_chan_cntr)-meanch*mean)/ |
---|
339 | (meanch2-square(meanch)); |
---|
340 | linmean=coeff*(Float(cur_channel)-meanch)+mean; |
---|
341 | linvariance=sqrt(sumf2/Float(box_chan_cntr)-square(mean)- |
---|
342 | square(coeff)*(meanch2-square(meanch))); |
---|
343 | } |
---|
344 | need2recalculate=False; |
---|
345 | } |
---|
346 | |
---|
347 | |
---|
348 | // |
---|
349 | /////////////////////////////////////////////////////////////////////////////// |
---|
350 | |
---|
351 | /////////////////////////////////////////////////////////////////////////////// |
---|
352 | // |
---|
353 | // LFAboveThreshold - a running mean algorithm for line detection |
---|
354 | // |
---|
355 | // |
---|
356 | |
---|
357 | |
---|
358 | // set up the detection criterion |
---|
359 | LFAboveThreshold::LFAboveThreshold(std::list<pair<int,int> > &in_lines, |
---|
360 | int in_min_nchan, |
---|
361 | casa::Float in_threshold) throw() : |
---|
362 | min_nchan(in_min_nchan), threshold(in_threshold), |
---|
363 | lines(in_lines), running_box(NULL) {} |
---|
364 | |
---|
365 | LFAboveThreshold::~LFAboveThreshold() throw() |
---|
366 | { |
---|
367 | if (running_box!=NULL) delete running_box; |
---|
368 | } |
---|
369 | |
---|
370 | // replace the detection criterion |
---|
371 | void LFAboveThreshold::setCriterion(int in_min_nchan, casa::Float in_threshold) |
---|
372 | throw() |
---|
373 | { |
---|
374 | min_nchan=in_min_nchan; |
---|
375 | threshold=in_threshold; |
---|
376 | } |
---|
377 | |
---|
378 | // get the sign of runningBox->aboveMean(). The RunningBox pointer |
---|
379 | // should be defined |
---|
380 | casa::Int LFAboveThreshold::getAboveMeanSign() const throw() |
---|
381 | { |
---|
382 | const Float buf=running_box->aboveMean(); |
---|
383 | if (buf>0) return 1; |
---|
384 | if (buf<0) return -1; |
---|
385 | return 0; |
---|
386 | } |
---|
387 | |
---|
388 | |
---|
389 | // process a channel: update cur_line and is_detected before and |
---|
390 | // add a new line to the list, if necessary |
---|
391 | void LFAboveThreshold::processChannel(Bool detect, |
---|
392 | const casa::Vector<casa::Bool> &mask) throw(casa::AipsError) |
---|
393 | { |
---|
394 | try { |
---|
395 | if (is_detected_before) { |
---|
396 | // we have to check that the current detection has the |
---|
397 | // same sign of running_box->aboveMean |
---|
398 | // otherwise it could be a spurious detection |
---|
399 | if (last_sign && last_sign!=getAboveMeanSign()) |
---|
400 | detect=False; |
---|
401 | } |
---|
402 | if (detect) { |
---|
403 | last_sign=getAboveMeanSign(); |
---|
404 | if (is_detected_before) |
---|
405 | cur_line.second=running_box->getChannel()+1; |
---|
406 | else { |
---|
407 | is_detected_before=True; |
---|
408 | cur_line.first=running_box->getChannel(); |
---|
409 | cur_line.second=running_box->getChannel()+1; |
---|
410 | } |
---|
411 | } else processCurLine(mask); |
---|
412 | } |
---|
413 | catch (const AipsError &ae) { |
---|
414 | throw; |
---|
415 | } |
---|
416 | catch (const exception &ex) { |
---|
417 | throw AipsError(String("LFAboveThreshold::processChannel - STL error: ")+ex.what()); |
---|
418 | } |
---|
419 | } |
---|
420 | |
---|
421 | // process the interval of channels stored in cur_line |
---|
422 | // if it satisfies the criterion, add this interval as a new line |
---|
423 | void LFAboveThreshold::processCurLine(const casa::Vector<casa::Bool> &mask) |
---|
424 | throw(casa::AipsError) |
---|
425 | { |
---|
426 | try { |
---|
427 | if (is_detected_before) { |
---|
428 | if (cur_line.second-cur_line.first>min_nchan) { |
---|
429 | // it was a detection. We need to change the list |
---|
430 | Bool add_new_line=False; |
---|
431 | if (lines.size()) { |
---|
432 | for (int i=lines.back().second;i<cur_line.first;++i) |
---|
433 | if (mask[i]) { // one valid channel in between |
---|
434 | // means that we deal with a separate line |
---|
435 | add_new_line=True; |
---|
436 | break; |
---|
437 | } |
---|
438 | } else add_new_line=True; |
---|
439 | if (add_new_line) |
---|
440 | lines.push_back(cur_line); |
---|
441 | else lines.back().second=cur_line.second; |
---|
442 | } |
---|
443 | is_detected_before=False; |
---|
444 | } |
---|
445 | } |
---|
446 | catch (const AipsError &ae) { |
---|
447 | throw; |
---|
448 | } |
---|
449 | catch (const exception &ex) { |
---|
450 | throw AipsError(String("LFAboveThreshold::processCurLine - STL error: ")+ex.what()); |
---|
451 | } |
---|
452 | } |
---|
453 | |
---|
454 | // return the array with signs of the value-current mean |
---|
455 | // An element is +1 if value>mean, -1 if less, 0 if equal. |
---|
456 | // This array is updated each time the findLines method is called and |
---|
457 | // is used to search the line wings |
---|
458 | const casa::Vector<Int>& LFAboveThreshold::getSigns() const throw() |
---|
459 | { |
---|
460 | return signs; |
---|
461 | } |
---|
462 | |
---|
463 | // find spectral lines and add them into list |
---|
464 | void LFAboveThreshold::findLines(const casa::Vector<casa::Float> &spectrum, |
---|
465 | const casa::Vector<casa::Bool> &mask, |
---|
466 | const std::pair<int,int> &edge, |
---|
467 | int max_box_nchan) |
---|
468 | throw(casa::AipsError) |
---|
469 | { |
---|
470 | const int minboxnchan=4; |
---|
471 | try { |
---|
472 | |
---|
473 | if (running_box!=NULL) delete running_box; |
---|
474 | running_box=new RunningBox(spectrum,mask,edge,max_box_nchan); |
---|
475 | |
---|
476 | |
---|
477 | // determine the off-line variance first |
---|
478 | // an assumption made: lines occupy a small part of the spectrum |
---|
479 | |
---|
480 | std::vector<float> variances(edge.second-edge.first); |
---|
481 | DebugAssert(variances.size(),AipsError); |
---|
482 | |
---|
483 | for (;running_box->haveMore();running_box->next()) |
---|
484 | variances[running_box->getChannel()-edge.first]= |
---|
485 | running_box->getLinVariance(); |
---|
486 | |
---|
487 | // in the future we probably should do a proper Chi^2 estimation |
---|
488 | // now a simple 80% of smaller values will be used. |
---|
489 | // it may degrade the performance of the algorithm for weak lines |
---|
490 | // due to a bias of the Chi^2 distribution. |
---|
491 | stable_sort(variances.begin(),variances.end()); |
---|
492 | |
---|
493 | Float offline_variance=0; |
---|
494 | uInt offline_cnt=uInt(0.8*variances.size()); |
---|
495 | if (!offline_cnt) offline_cnt=variances.size(); // no much else left, |
---|
496 | // although it is very inaccurate |
---|
497 | for (uInt n=0;n<offline_cnt;++n) |
---|
498 | offline_variance+=variances[n]; |
---|
499 | offline_variance/=Float(offline_cnt); |
---|
500 | |
---|
501 | // actual search algorithm |
---|
502 | is_detected_before=False; |
---|
503 | |
---|
504 | // initiate the signs array |
---|
505 | signs.resize(spectrum.nelements()); |
---|
506 | signs=Vector<Int>(spectrum.nelements(),0); |
---|
507 | |
---|
508 | //ofstream os("dbg.dat"); |
---|
509 | for (running_box->rewind();running_box->haveMore(); |
---|
510 | running_box->next()) { |
---|
511 | const int ch=running_box->getChannel(); |
---|
512 | if (running_box->getNumberOfBoxPoints()>=minboxnchan) |
---|
513 | processChannel(mask[ch] && (fabs(running_box->aboveMean()) >= |
---|
514 | threshold*offline_variance), mask); |
---|
515 | else processCurLine(mask); // just finish what was accumulated before |
---|
516 | |
---|
517 | signs[ch]=getAboveMeanSign(); |
---|
518 | // os<<ch<<" "<<spectrum[ch]<<" "<<fabs(running_box->aboveMean())<<" "<< |
---|
519 | // threshold*offline_variance<<endl; |
---|
520 | |
---|
521 | const Float buf=running_box->aboveMean(); |
---|
522 | if (buf>0) signs[ch]=1; |
---|
523 | else if (buf<0) signs[ch]=-1; |
---|
524 | else if (buf==0) signs[ch]=0; |
---|
525 | // os<<ch<<" "<<spectrum[ch]<<" "<<running_box->getLinMean()<<" "<< |
---|
526 | // threshold*offline_variance<<endl; |
---|
527 | } |
---|
528 | if (lines.size()) |
---|
529 | searchForWings(lines,signs,mask,edge); |
---|
530 | } |
---|
531 | catch (const AipsError &ae) { |
---|
532 | throw; |
---|
533 | } |
---|
534 | catch (const exception &ex) { |
---|
535 | throw AipsError(String("LFAboveThreshold::findLines - STL error: ")+ex.what()); |
---|
536 | } |
---|
537 | } |
---|
538 | |
---|
539 | // |
---|
540 | /////////////////////////////////////////////////////////////////////////////// |
---|
541 | |
---|
542 | /////////////////////////////////////////////////////////////////////////////// |
---|
543 | // |
---|
544 | // LFLineListOperations::IntersectsWith - An auxiliary object function |
---|
545 | // to test whether two lines have a non-void intersection |
---|
546 | // |
---|
547 | |
---|
548 | |
---|
549 | // line1 - range of the first line: start channel and stop+1 |
---|
550 | LFLineListOperations::IntersectsWith::IntersectsWith(const std::pair<int,int> &in_line1) : |
---|
551 | line1(in_line1) {} |
---|
552 | |
---|
553 | |
---|
554 | // return true if line2 intersects with line1 with at least one |
---|
555 | // common channel, and false otherwise |
---|
556 | // line2 - range of the second line: start channel and stop+1 |
---|
557 | bool LFLineListOperations::IntersectsWith::operator()(const std::pair<int,int> &line2) |
---|
558 | const throw() |
---|
559 | { |
---|
560 | if (line2.second<line1.first) return false; // line2 is at lower channels |
---|
561 | if (line2.first>line1.second) return false; // line2 is at upper channels |
---|
562 | return true; // line2 has an intersection or is adjacent to line1 |
---|
563 | } |
---|
564 | |
---|
565 | // |
---|
566 | /////////////////////////////////////////////////////////////////////////////// |
---|
567 | |
---|
568 | /////////////////////////////////////////////////////////////////////////////// |
---|
569 | // |
---|
570 | // LFLineListOperations::BuildUnion - An auxiliary object function to build a union |
---|
571 | // of several lines to account for a possibility of merging the nearby lines |
---|
572 | // |
---|
573 | |
---|
574 | // set an initial line (can be a first line in the sequence) |
---|
575 | LFLineListOperations::BuildUnion::BuildUnion(const std::pair<int,int> &line1) : |
---|
576 | temp_line(line1) {} |
---|
577 | |
---|
578 | // update temp_line with a union of temp_line and new_line |
---|
579 | // provided there is no gap between the lines |
---|
580 | void LFLineListOperations::BuildUnion::operator()(const std::pair<int,int> &new_line) |
---|
581 | throw() |
---|
582 | { |
---|
583 | if (new_line.first<temp_line.first) temp_line.first=new_line.first; |
---|
584 | if (new_line.second>temp_line.second) temp_line.second=new_line.second; |
---|
585 | } |
---|
586 | |
---|
587 | // return the result (temp_line) |
---|
588 | const std::pair<int,int>& LFLineListOperations::BuildUnion::result() const throw() |
---|
589 | { |
---|
590 | return temp_line; |
---|
591 | } |
---|
592 | |
---|
593 | // |
---|
594 | /////////////////////////////////////////////////////////////////////////////// |
---|
595 | |
---|
596 | /////////////////////////////////////////////////////////////////////////////// |
---|
597 | // |
---|
598 | // LFLineListOperations::LaterThan - An auxiliary object function to test whether a |
---|
599 | // specified line is at lower spectral channels (to preserve the order in |
---|
600 | // the line list) |
---|
601 | // |
---|
602 | |
---|
603 | // setup the line to compare with |
---|
604 | LFLineListOperations::LaterThan::LaterThan(const std::pair<int,int> &in_line1) : |
---|
605 | line1(in_line1) {} |
---|
606 | |
---|
607 | // return true if line2 should be placed later than line1 |
---|
608 | // in the ordered list (so, it is at greater channel numbers) |
---|
609 | bool LFLineListOperations::LaterThan::operator()(const std::pair<int,int> &line2) |
---|
610 | const throw() |
---|
611 | { |
---|
612 | if (line2.second<line1.first) return false; // line2 is at lower channels |
---|
613 | if (line2.first>line1.second) return true; // line2 is at upper channels |
---|
614 | |
---|
615 | // line2 intersects with line1. We should have no such situation in |
---|
616 | // practice |
---|
617 | return line2.first>line1.first; |
---|
618 | } |
---|
619 | |
---|
620 | // |
---|
621 | /////////////////////////////////////////////////////////////////////////////// |
---|
622 | |
---|
623 | |
---|
624 | /////////////////////////////////////////////////////////////////////////////// |
---|
625 | // |
---|
626 | // STLineFinder - a class for automated spectral line search |
---|
627 | // |
---|
628 | // |
---|
629 | |
---|
630 | STLineFinder::STLineFinder() throw() : edge(0,0) |
---|
631 | { |
---|
632 | setOptions(); |
---|
633 | } |
---|
634 | |
---|
635 | // set the parameters controlling algorithm |
---|
636 | // in_threshold a single channel threshold default is sqrt(3), which |
---|
637 | // means together with 3 minimum channels at least 3 sigma |
---|
638 | // detection criterion |
---|
639 | // For bad baseline shape, in_threshold may need to be |
---|
640 | // increased |
---|
641 | // in_min_nchan minimum number of channels above the threshold to report |
---|
642 | // a detection, default is 3 |
---|
643 | // in_avg_limit perform the averaging of no more than in_avg_limit |
---|
644 | // adjacent channels to search for broad lines |
---|
645 | // Default is 8, but for a bad baseline shape this |
---|
646 | // parameter should be decreased (may be even down to a |
---|
647 | // minimum of 1 to disable this option) to avoid |
---|
648 | // confusing of baseline undulations with a real line. |
---|
649 | // Setting a very large value doesn't usually provide |
---|
650 | // valid detections. |
---|
651 | // in_box_size the box size for running mean calculation. Default is |
---|
652 | // 1./5. of the whole spectrum size |
---|
653 | void STLineFinder::setOptions(const casa::Float &in_threshold, |
---|
654 | const casa::Int &in_min_nchan, |
---|
655 | const casa::Int &in_avg_limit, |
---|
656 | const casa::Float &in_box_size) throw() |
---|
657 | { |
---|
658 | threshold=in_threshold; |
---|
659 | min_nchan=in_min_nchan; |
---|
660 | avg_limit=in_avg_limit; |
---|
661 | box_size=in_box_size; |
---|
662 | } |
---|
663 | |
---|
664 | STLineFinder::~STLineFinder() throw(AipsError) {} |
---|
665 | |
---|
666 | // set scan to work with (in_scan parameter) |
---|
667 | void STLineFinder::setScan(const ScantableWrapper &in_scan) throw(AipsError) |
---|
668 | { |
---|
669 | scan=in_scan.getCP(); |
---|
670 | AlwaysAssert(!scan.null(),AipsError); |
---|
671 | |
---|
672 | } |
---|
673 | |
---|
674 | // search for spectral lines. Number of lines found is returned |
---|
675 | // in_edge and in_mask control channel rejection for a given row |
---|
676 | // if in_edge has zero length, all channels chosen by mask will be used |
---|
677 | // if in_edge has one element only, it represents the number of |
---|
678 | // channels to drop from both sides of the spectrum |
---|
679 | // in_edge is introduced for convinience, although all functionality |
---|
680 | // can be achieved using a spectrum mask only |
---|
681 | int STLineFinder::findLines(const std::vector<bool> &in_mask, |
---|
682 | const std::vector<int> &in_edge, |
---|
683 | const casa::uInt &whichRow) throw(casa::AipsError) |
---|
684 | { |
---|
685 | //const int minboxnchan=4; |
---|
686 | if (scan.null()) |
---|
687 | throw AipsError("STLineFinder::findLines - a scan should be set first," |
---|
688 | " use set_scan"); |
---|
689 | |
---|
690 | uInt nchan = scan->nchan(scan->getIF(whichRow)); |
---|
691 | // set up mask and edge rejection |
---|
692 | // no mask given... |
---|
693 | if (in_mask.size() == 0) { |
---|
694 | mask = Vector<Bool>(nchan,True); |
---|
695 | } else { |
---|
696 | // use provided mask |
---|
697 | mask=Vector<Bool>(in_mask); |
---|
698 | } |
---|
699 | if (mask.nelements()!=nchan) |
---|
700 | throw AipsError("STLineFinder::findLines - in_scan and in_mask have different" |
---|
701 | "number of spectral channels."); |
---|
702 | cout << mask.nelements() << endl; |
---|
703 | // number of elements in in_edge |
---|
704 | if (in_edge.size()>2) |
---|
705 | throw AipsError("STLineFinder::findLines - the length of the in_edge parameter" |
---|
706 | "should not exceed 2"); |
---|
707 | if (!in_edge.size()) { |
---|
708 | // all spectra, no rejection |
---|
709 | edge.first=0; |
---|
710 | edge.second=nchan; |
---|
711 | } else { |
---|
712 | edge.first=in_edge[0]; |
---|
713 | if (edge.first<0) |
---|
714 | throw AipsError("STLineFinder::findLines - the in_edge parameter has a negative" |
---|
715 | "number of channels to drop"); |
---|
716 | if (edge.first>=int(nchan)) |
---|
717 | throw AipsError("STLineFinder::findLines - all channels are rejected by the in_edge parameter"); |
---|
718 | if (in_edge.size()==2) { |
---|
719 | edge.second=in_edge[1]; |
---|
720 | if (edge.second<0) |
---|
721 | throw AipsError("STLineFinder::findLines - the in_edge parameter has a negative" |
---|
722 | "number of channels to drop"); |
---|
723 | edge.second=nchan-edge.second; |
---|
724 | } else edge.second=nchan-edge.first; |
---|
725 | if (edge.second<0 || (edge.first>=edge.second)) |
---|
726 | throw AipsError("STLineFinder::findLines - all channels are rejected by the in_edge parameter"); |
---|
727 | } |
---|
728 | |
---|
729 | // |
---|
730 | int max_box_nchan=int(nchan*box_size); // number of channels in running |
---|
731 | // box |
---|
732 | if (max_box_nchan<2) |
---|
733 | throw AipsError("STLineFinder::findLines - box_size is too small"); |
---|
734 | |
---|
735 | spectrum.resize(); |
---|
736 | spectrum = Vector<Float>(scan->getSpectrum(whichRow)); |
---|
737 | |
---|
738 | lines.resize(0); // search from the scratch |
---|
739 | last_row_used=whichRow; |
---|
740 | Vector<Bool> temp_mask(mask); |
---|
741 | |
---|
742 | Bool first_pass=True; |
---|
743 | Int avg_factor=1; // this number of adjacent channels is averaged together |
---|
744 | // the total number of the channels is not altered |
---|
745 | // instead, min_nchan is also scaled |
---|
746 | // it helps to search for broad lines |
---|
747 | Vector<Int> signs; // a buffer for signs of the value - mean quantity |
---|
748 | // see LFAboveThreshold for details |
---|
749 | // We need only signs resulted from last iteration |
---|
750 | // because all previous values may be corrupted by the |
---|
751 | // presence of spectral lines |
---|
752 | while (true) { |
---|
753 | // a buffer for new lines found at this iteration |
---|
754 | std::list<pair<int,int> > new_lines; |
---|
755 | |
---|
756 | try { |
---|
757 | // line find algorithm |
---|
758 | LFAboveThreshold lfalg(new_lines,avg_factor*min_nchan, threshold); |
---|
759 | lfalg.findLines(spectrum,temp_mask,edge,max_box_nchan); |
---|
760 | signs.resize(lfalg.getSigns().nelements()); |
---|
761 | signs=lfalg.getSigns(); |
---|
762 | first_pass=False; |
---|
763 | if (!new_lines.size()) |
---|
764 | throw AipsError("spurious"); // nothing new - use the same |
---|
765 | // code as for a real exception |
---|
766 | } |
---|
767 | catch(const AipsError &ae) { |
---|
768 | if (first_pass) throw; |
---|
769 | // nothing new - proceed to the next step of averaging, if any |
---|
770 | // (to search for broad lines) |
---|
771 | if (avg_factor>avg_limit) break; // averaging up to avg_limit |
---|
772 | // adjacent channels, |
---|
773 | // stop after that |
---|
774 | avg_factor*=2; // twice as more averaging |
---|
775 | subtractBaseline(temp_mask,9); |
---|
776 | averageAdjacentChannels(temp_mask,avg_factor); |
---|
777 | continue; |
---|
778 | } |
---|
779 | keepStrongestOnly(temp_mask,new_lines,max_box_nchan); |
---|
780 | // update the list (lines) merging intervals, if necessary |
---|
781 | addNewSearchResult(new_lines,lines); |
---|
782 | // get a new mask |
---|
783 | temp_mask=getMask(); |
---|
784 | } |
---|
785 | |
---|
786 | // an additional search for wings because in the presence of very strong |
---|
787 | // lines temporary mean used at each iteration will be higher than |
---|
788 | // the true mean |
---|
789 | |
---|
790 | if (lines.size()) |
---|
791 | LFLineListOperations::searchForWings(lines,signs,mask,edge); |
---|
792 | |
---|
793 | return int(lines.size()); |
---|
794 | } |
---|
795 | |
---|
796 | // auxiliary function to fit and subtract a polynomial from the current |
---|
797 | // spectrum. It uses the Fitter class. This action is required before |
---|
798 | // reducing the spectral resolution if the baseline shape is bad |
---|
799 | void STLineFinder::subtractBaseline(const casa::Vector<casa::Bool> &temp_mask, |
---|
800 | const casa::Int &order) throw(casa::AipsError) |
---|
801 | { |
---|
802 | AlwaysAssert(spectrum.nelements(),AipsError); |
---|
803 | // use the fact that temp_mask excludes channels rejected at the edge |
---|
804 | Fitter sdf; |
---|
805 | std::vector<float> absc(spectrum.nelements()); |
---|
806 | for (unsigned int i=0;i<absc.size();++i) |
---|
807 | absc[i]=float(i)/float(spectrum.nelements()); |
---|
808 | std::vector<float> spec; |
---|
809 | spectrum.tovector(spec); |
---|
810 | std::vector<bool> std_mask; |
---|
811 | temp_mask.tovector(std_mask); |
---|
812 | sdf.setData(absc,spec,std_mask); |
---|
813 | sdf.setExpression("poly",order); |
---|
814 | if (!sdf.fit()) return; // fit failed, use old spectrum |
---|
815 | spectrum=casa::Vector<casa::Float>(sdf.getResidual()); |
---|
816 | } |
---|
817 | |
---|
818 | // auxiliary function to average adjacent channels and update the mask |
---|
819 | // if at least one channel involved in summation is masked, all |
---|
820 | // output channels will be masked. This function works with the |
---|
821 | // spectrum and edge fields of this class, but updates the mask |
---|
822 | // array specified, rather than the field of this class |
---|
823 | // boxsize - a number of adjacent channels to average |
---|
824 | void STLineFinder::averageAdjacentChannels(casa::Vector<casa::Bool> &mask2update, |
---|
825 | const casa::Int &boxsize) |
---|
826 | throw(casa::AipsError) |
---|
827 | { |
---|
828 | DebugAssert(mask2update.nelements()==spectrum.nelements(), AipsError); |
---|
829 | DebugAssert(boxsize!=0,AipsError); |
---|
830 | |
---|
831 | for (int n=edge.first;n<edge.second;n+=boxsize) { |
---|
832 | DebugAssert(n<spectrum.nelements(),AipsError); |
---|
833 | int nboxch=0; // number of channels currently in the box |
---|
834 | Float mean=0; // buffer for mean calculations |
---|
835 | for (int k=n;k<n+boxsize && k<edge.second;++k) |
---|
836 | if (mask2update[k]) { // k is a valid channel |
---|
837 | mean+=spectrum[k]; |
---|
838 | ++nboxch; |
---|
839 | } |
---|
840 | if (nboxch<boxsize) // mask these channels |
---|
841 | for (int k=n;k<n+boxsize && k<edge.second;++k) |
---|
842 | mask2update[k]=False; |
---|
843 | else { |
---|
844 | mean/=Float(boxsize); |
---|
845 | for (int k=n;k<n+boxsize && k<edge.second;++k) |
---|
846 | spectrum[k]=mean; |
---|
847 | } |
---|
848 | } |
---|
849 | } |
---|
850 | |
---|
851 | |
---|
852 | // get the mask to mask out all lines that have been found (default) |
---|
853 | // if invert=true, only channels belong to lines will be unmasked |
---|
854 | // Note: all channels originally masked by the input mask (in_mask |
---|
855 | // in setScan) or dropped out by the edge parameter (in_edge |
---|
856 | // in setScan) are still excluded regardless on the invert option |
---|
857 | std::vector<bool> STLineFinder::getMask(bool invert) |
---|
858 | const throw(casa::AipsError) |
---|
859 | { |
---|
860 | try { |
---|
861 | if (scan.null()) |
---|
862 | throw AipsError("STLineFinder::getMask - a scan should be set first," |
---|
863 | " use set_scan followed by find_lines"); |
---|
864 | DebugAssert(mask.nelements()==scan->getChannels(last_row_used), AipsError); |
---|
865 | /* |
---|
866 | if (!lines.size()) |
---|
867 | throw AipsError("STLineFinder::getMask - one have to search for " |
---|
868 | "lines first, use find_lines"); |
---|
869 | */ |
---|
870 | std::vector<bool> res_mask(mask.nelements()); |
---|
871 | // iterator through lines |
---|
872 | std::list<std::pair<int,int> >::const_iterator cli=lines.begin(); |
---|
873 | for (int ch=0;ch<int(res_mask.size());++ch) |
---|
874 | if (ch<edge.first || ch>=edge.second) res_mask[ch]=false; |
---|
875 | else if (!mask[ch]) res_mask[ch]=false; |
---|
876 | else { |
---|
877 | res_mask[ch]=!invert; // no line by default |
---|
878 | if (cli==lines.end()) continue; |
---|
879 | if (ch>=cli->first && ch<cli->second) |
---|
880 | res_mask[ch]=invert; // this is a line |
---|
881 | if (ch>=cli->second) |
---|
882 | ++cli; // next line in the list |
---|
883 | } |
---|
884 | |
---|
885 | return res_mask; |
---|
886 | } |
---|
887 | catch (const AipsError &ae) { |
---|
888 | throw; |
---|
889 | } |
---|
890 | catch (const exception &ex) { |
---|
891 | throw AipsError(String("STLineFinder::getMask - STL error: ")+ex.what()); |
---|
892 | } |
---|
893 | } |
---|
894 | |
---|
895 | // get range for all lines found. The same units as used in the scan |
---|
896 | // will be returned (e.g. velocity instead of channels). |
---|
897 | std::vector<double> STLineFinder::getLineRanges() |
---|
898 | const throw(casa::AipsError) |
---|
899 | { |
---|
900 | // convert to required abscissa units |
---|
901 | std::vector<double> vel=scan->getAbcissa(last_row_used); |
---|
902 | std::vector<int> ranges=getLineRangesInChannels(); |
---|
903 | std::vector<double> res(ranges.size()); |
---|
904 | |
---|
905 | std::vector<int>::const_iterator cri=ranges.begin(); |
---|
906 | std::vector<double>::iterator outi=res.begin(); |
---|
907 | for (;cri!=ranges.end() && outi!=res.end();++cri,++outi) |
---|
908 | if (uInt(*cri)>=vel.size()) |
---|
909 | throw AipsError("STLineFinder::getLineRanges - getAbcissa provided less channels than reqired"); |
---|
910 | else *outi=vel[*cri]; |
---|
911 | return res; |
---|
912 | } |
---|
913 | |
---|
914 | // The same as getLineRanges, but channels are always used to specify |
---|
915 | // the range |
---|
916 | std::vector<int> STLineFinder::getLineRangesInChannels() |
---|
917 | const throw(casa::AipsError) |
---|
918 | { |
---|
919 | try { |
---|
920 | if (scan.null()) |
---|
921 | throw AipsError("STLineFinder::getLineRangesInChannels - a scan should be set first," |
---|
922 | " use set_scan followed by find_lines"); |
---|
923 | DebugAssert(mask.nelements()==scan->getChannels(last_row_used), AipsError); |
---|
924 | |
---|
925 | if (!lines.size()) |
---|
926 | throw AipsError("STLineFinder::getLineRangesInChannels - one have to search for " |
---|
927 | "lines first, use find_lines"); |
---|
928 | |
---|
929 | std::vector<int> res(2*lines.size()); |
---|
930 | // iterator through lines & result |
---|
931 | std::list<std::pair<int,int> >::const_iterator cli=lines.begin(); |
---|
932 | std::vector<int>::iterator ri=res.begin(); |
---|
933 | for (;cli!=lines.end() && ri!=res.end();++cli,++ri) { |
---|
934 | *ri=cli->first; |
---|
935 | if (++ri!=res.end()) |
---|
936 | *ri=cli->second-1; |
---|
937 | } |
---|
938 | return res; |
---|
939 | } |
---|
940 | catch (const AipsError &ae) { |
---|
941 | throw; |
---|
942 | } |
---|
943 | catch (const exception &ex) { |
---|
944 | throw AipsError(String("STLineFinder::getLineRanges - STL error: ")+ex.what()); |
---|
945 | } |
---|
946 | } |
---|
947 | |
---|
948 | |
---|
949 | |
---|
950 | // an auxiliary function to remove all lines from the list, except the |
---|
951 | // strongest one (by absolute value). If the lines removed are real, |
---|
952 | // they will be find again at the next iteration. This approach |
---|
953 | // increases the number of iterations required, but is able to remove |
---|
954 | // the sidelobes likely to occur near strong lines. |
---|
955 | // Later a better criterion may be implemented, e.g. |
---|
956 | // taking into consideration the brightness of different lines. Now |
---|
957 | // use the simplest solution |
---|
958 | // temp_mask - mask to work with (may be different from original mask as |
---|
959 | // the lines previously found may be masked) |
---|
960 | // lines2update - a list of lines to work with |
---|
961 | // nothing will be done if it is empty |
---|
962 | // max_box_nchan - channels in the running box for baseline filtering |
---|
963 | void STLineFinder::keepStrongestOnly(const casa::Vector<casa::Bool> &temp_mask, |
---|
964 | std::list<std::pair<int, int> > &lines2update, |
---|
965 | int max_box_nchan) |
---|
966 | throw (casa::AipsError) |
---|
967 | { |
---|
968 | try { |
---|
969 | if (!lines2update.size()) return; // ignore an empty list |
---|
970 | |
---|
971 | // current line |
---|
972 | std::list<std::pair<int,int> >::iterator li=lines2update.begin(); |
---|
973 | // strongest line |
---|
974 | std::list<std::pair<int,int> >::iterator strongli=lines2update.begin(); |
---|
975 | // the flux (absolute value) of the strongest line |
---|
976 | Float peak_flux=-1; // negative value - a flag showing uninitialized |
---|
977 | // value |
---|
978 | // the algorithm below relies on the list being ordered |
---|
979 | Float tmp_flux=-1; // a temporary peak |
---|
980 | for (RunningBox running_box(spectrum,temp_mask,edge,max_box_nchan); |
---|
981 | running_box.haveMore(); running_box.next()) { |
---|
982 | |
---|
983 | if (li==lines2update.end()) break; // no more lines |
---|
984 | const int ch=running_box.getChannel(); |
---|
985 | if (ch>=li->first && ch<li->second) |
---|
986 | if (temp_mask[ch] && tmp_flux<fabs(running_box.aboveMean())) |
---|
987 | tmp_flux=fabs(running_box.aboveMean()); |
---|
988 | if (ch==li->second-1) { |
---|
989 | if (peak_flux<tmp_flux) { // if peak_flux=-1, this condition |
---|
990 | peak_flux=tmp_flux; // will be satisfied |
---|
991 | strongli=li; |
---|
992 | } |
---|
993 | ++li; |
---|
994 | tmp_flux=-1; |
---|
995 | } |
---|
996 | } |
---|
997 | std::list<std::pair<int,int> > res; |
---|
998 | res.splice(res.end(),lines2update,strongli); |
---|
999 | lines2update.clear(); |
---|
1000 | lines2update.splice(lines2update.end(),res); |
---|
1001 | } |
---|
1002 | catch (const AipsError &ae) { |
---|
1003 | throw; |
---|
1004 | } |
---|
1005 | catch (const exception &ex) { |
---|
1006 | throw AipsError(String("STLineFinder::keepStrongestOnly - STL error: ")+ex.what()); |
---|
1007 | } |
---|
1008 | |
---|
1009 | } |
---|
1010 | |
---|
1011 | // |
---|
1012 | /////////////////////////////////////////////////////////////////////////////// |
---|
1013 | |
---|
1014 | |
---|
1015 | /////////////////////////////////////////////////////////////////////////////// |
---|
1016 | // |
---|
1017 | // LFLineListOperations - a class incapsulating operations with line lists |
---|
1018 | // The LF prefix stands for Line Finder |
---|
1019 | // |
---|
1020 | |
---|
1021 | // concatenate two lists preserving the order. If two lines appear to |
---|
1022 | // be adjacent, they are joined into the new one |
---|
1023 | void LFLineListOperations::addNewSearchResult(const std::list<pair<int, int> > &newlines, |
---|
1024 | std::list<std::pair<int, int> > &lines_list) |
---|
1025 | throw(AipsError) |
---|
1026 | { |
---|
1027 | try { |
---|
1028 | for (std::list<pair<int,int> >::const_iterator cli=newlines.begin(); |
---|
1029 | cli!=newlines.end();++cli) { |
---|
1030 | |
---|
1031 | // the first item, which has a non-void intersection or touches |
---|
1032 | // the new line |
---|
1033 | std::list<pair<int,int> >::iterator pos_beg=find_if(lines_list.begin(), |
---|
1034 | lines_list.end(), IntersectsWith(*cli)); |
---|
1035 | // the last such item |
---|
1036 | std::list<pair<int,int> >::iterator pos_end=find_if(pos_beg, |
---|
1037 | lines_list.end(), not1(IntersectsWith(*cli))); |
---|
1038 | |
---|
1039 | // extract all lines which intersect or touch a new one into |
---|
1040 | // a temporary buffer. This may invalidate the iterators |
---|
1041 | // line_buffer may be empty, if no lines intersects with a new |
---|
1042 | // one. |
---|
1043 | std::list<pair<int,int> > lines_buffer; |
---|
1044 | lines_buffer.splice(lines_buffer.end(),lines_list, pos_beg, pos_end); |
---|
1045 | |
---|
1046 | // build a union of all intersecting lines |
---|
1047 | pair<int,int> union_line=for_each(lines_buffer.begin(), |
---|
1048 | lines_buffer.end(),BuildUnion(*cli)).result(); |
---|
1049 | |
---|
1050 | // search for a right place for the new line (union_line) and add |
---|
1051 | std::list<pair<int,int> >::iterator pos2insert=find_if(lines_list.begin(), |
---|
1052 | lines_list.end(), LaterThan(union_line)); |
---|
1053 | lines_list.insert(pos2insert,union_line); |
---|
1054 | } |
---|
1055 | } |
---|
1056 | catch (const AipsError &ae) { |
---|
1057 | throw; |
---|
1058 | } |
---|
1059 | catch (const exception &ex) { |
---|
1060 | throw AipsError(String("LFLineListOperations::addNewSearchResult - STL error: ")+ex.what()); |
---|
1061 | } |
---|
1062 | } |
---|
1063 | |
---|
1064 | // extend all line ranges to the point where a value stored in the |
---|
1065 | // specified vector changes (e.g. value-mean change its sign) |
---|
1066 | // This operation is necessary to include line wings, which are below |
---|
1067 | // the detection threshold. If lines becomes adjacent, they are |
---|
1068 | // merged together. Any masked channel stops the extension |
---|
1069 | void LFLineListOperations::searchForWings(std::list<std::pair<int, int> > &newlines, |
---|
1070 | const casa::Vector<casa::Int> &signs, |
---|
1071 | const casa::Vector<casa::Bool> &mask, |
---|
1072 | const std::pair<int,int> &edge) throw(casa::AipsError) |
---|
1073 | { |
---|
1074 | try { |
---|
1075 | for (std::list<pair<int,int> >::iterator li=newlines.begin(); |
---|
1076 | li!=newlines.end();++li) { |
---|
1077 | // update the left hand side |
---|
1078 | for (int n=li->first-1;n>=edge.first;--n) { |
---|
1079 | if (!mask[n]) break; |
---|
1080 | if (signs[n]==signs[li->first] && signs[li->first]) |
---|
1081 | li->first=n; |
---|
1082 | else break; |
---|
1083 | } |
---|
1084 | // update the right hand side |
---|
1085 | for (int n=li->second;n<edge.second;++n) { |
---|
1086 | if (!mask[n]) break; |
---|
1087 | if (signs[n]==signs[li->second-1] && signs[li->second-1]) |
---|
1088 | li->second=n; |
---|
1089 | else break; |
---|
1090 | } |
---|
1091 | } |
---|
1092 | // need to search for possible mergers. |
---|
1093 | std::list<std::pair<int, int> > result_buffer; |
---|
1094 | addNewSearchResult(newlines,result_buffer); |
---|
1095 | newlines.clear(); |
---|
1096 | newlines.splice(newlines.end(),result_buffer); |
---|
1097 | } |
---|
1098 | catch (const AipsError &ae) { |
---|
1099 | throw; |
---|
1100 | } |
---|
1101 | catch (const exception &ex) { |
---|
1102 | throw AipsError(String("LFLineListOperations::extendLines - STL error: ")+ex.what()); |
---|
1103 | } |
---|
1104 | } |
---|
1105 | |
---|
1106 | // |
---|
1107 | /////////////////////////////////////////////////////////////////////////////// |
---|