source: trunk/src/STSideBandSep.cpp @ 2836

Last change on this file since 2836 was 2836, checked in by Kana Sugimoto, 11 years ago

New Development: No

JIRA Issue: Yes (CAS-5139/TRAC-290)

Ready for Test: Yes

Interface Changes: No

What Interface Changed:

Test Programs:

Put in Release Notes: No

Module(s): sbseparator

Description:

sbseparator handles flagged data sets to some extent.

  • separation of row flagged spectra (eigher in a part of or in all datasets) are handled properly.
  • separation of partly channel flagged spectra are handled properly only when identical channels are flagged throughout data sets

TODO:
handle cases when flagged channels vary among datasets.

File size: 42.6 KB
Line 
1// C++ Interface: STSideBandSep
2//
3// Description:
4//    A class to invoke sideband separation of Scantable
5//
6// Author: Kana Sugimoto <kana.sugi@nao.ac.jp>, (C) 2012
7//
8// Copyright: See COPYING file that comes with this distribution
9//
10//
11
12// STL
13#include <ctype.h>
14
15// cascore
16#include <casa/OS/File.h>
17#include <casa/Logging/LogIO.h>
18#include <casa/Quanta/QuantumHolder.h>
19
20#include <measures/Measures/MFrequency.h>
21#include <measures/Measures/MCFrequency.h>
22
23#include <tables/Tables/TableRow.h>
24#include <tables/Tables/TableRecord.h>
25#include <tables/Tables/TableVector.h>
26
27// asap
28#include "STGrid.h"
29#include "STMath.h"
30#include "MathUtils.h"
31#include "STSideBandSep.h"
32
33using namespace std ;
34using namespace casa ;
35using namespace asap ;
36
37// #ifndef KS_DEBUG
38// #define KS_DEBUG
39// #endif
40
41namespace asap {
42
43// constructors
44STSideBandSep::STSideBandSep(const vector<string> &names)
45{
46  LogIO os(LogOrigin("STSideBandSep","STSideBandSep()", WHERE));
47  os << "Setting scantable names to process." << LogIO::POST ;
48  // Set file names
49  ntable_ = names.size();
50  infileList_.resize(ntable_);
51  for (unsigned int i = 0; i < ntable_; i++){
52    if (!checkFile(names[i], "d"))
53      throw( AipsError("File does not exist") );
54    infileList_[i] = names[i];
55  }
56  intabList_.resize(0);
57
58  init();
59
60  {// Summary
61    os << ntable_ << " files are set: [";
62    for (unsigned int i = 0; i < ntable_; i++) {
63      os << " '" << infileList_[i] << "' ";
64      if (i != ntable_-1) os << ",";
65    }
66    os << "] " << LogIO::POST;
67  }
68};
69
70STSideBandSep::STSideBandSep(const vector<ScantableWrapper> &tables)
71{
72  LogIO os(LogOrigin("STSideBandSep","STSideBandSep()", WHERE));
73  os << "Setting list of scantables to process." << LogIO::POST ;
74  // Set file names
75  ntable_ = tables.size();
76  intabList_.resize(ntable_);
77  for (unsigned int i = 0; i < ntable_; i++){
78    intabList_[i] = tables[i].getCP();
79  }
80  infileList_.resize(0);
81
82  init();
83  tp_ = intabList_[0]->table().tableType();
84
85  os << ntable_ << " tables are set." << LogIO::POST;
86};
87
88STSideBandSep::~STSideBandSep()
89{
90#ifdef KS_DEBUG
91  cout << "Destructor ~STSideBandSep()" << endl;
92#endif
93};
94
95void STSideBandSep::init()
96{
97  // frequency setup
98  sigIfno_= -1;
99  ftol_ = -1;
100  solFrame_ = MFrequency::N_Types;
101  // shifts
102  initshift();
103  // direction tolerance
104  xtol_ = ytol_ = 9.69627e-6; // 2arcsec
105  // solution parameters
106  otherside_ = false;
107  doboth_ = false;
108  rejlimit_ = 0.2;
109  // LO1 values
110  lo1Freq_ = -1;
111  loTime_ = -1;
112  loDir_ = "";
113  // Default LO frame is TOPO
114  loFrame_ = MFrequency::TOPO;
115  // scantable storage
116  tp_ = Table::Memory;
117};
118
119void STSideBandSep::initshift()
120{
121  // shifts
122  nshift_ = 0;
123  nchan_ = 0;
124  sigShift_.resize(0);
125  imgShift_.resize(0);
126  tableList_.resize(0);
127};
128
129void STSideBandSep::setFrequency(const unsigned int ifno,
130                                 const string freqtol,
131                                 const string frame)
132{
133  LogIO os(LogOrigin("STSideBandSep","setFrequency()", WHERE));
134
135  initshift();
136
137  // IFNO
138  sigIfno_ = (int) ifno;
139
140  // Frequency tolerance
141  Quantum<Double> qftol;
142  readQuantity(qftol, String(freqtol));
143  if (!qftol.getUnit().empty()){
144    // make sure the quantity is frequency
145    if (qftol.getFullUnit().getValue() != Unit("Hz").getValue())
146      throw( AipsError("Invalid quantity for frequency tolerance.") );
147    qftol.convert("Hz");
148  }
149  ftol_ = qftol;
150
151  // Frequency Frame
152  if (!frame.empty()){
153    MFrequency::Types mft;
154    if (!MFrequency::getType(mft, frame))
155      throw( AipsError("Invalid frame type.") );
156    solFrame_ = mft;
157  } else {
158    solFrame_ = MFrequency::N_Types;
159  }
160
161  {// Summary
162    const String sframe = ( (solFrame_ == MFrequency::N_Types) ?
163                            "table frame" :
164                            MFrequency::showType(solFrame_) );
165    os << "Frequency setup to search IF group: "
166       << "IFNO of table[0] = " << sigIfno_
167       << " , Freq tolerance = " << ftol_.getValue() << " [ "
168       << (ftol_.getUnit().empty() ? "channel" : ftol_.getUnit() )
169       << " ] (in " << sframe <<")" << LogIO::POST;
170  }
171};
172
173
174void STSideBandSep::setDirTolerance(const vector<string> dirtol)
175{
176  LogIO os(LogOrigin("STSideBandSep","setDirTolerance()", WHERE));
177  Quantum<Double> qcell;
178  if ( (dirtol.size() == 1) && !dirtol[0].empty() ) {
179    readQuantity(qcell, String(dirtol[0]));
180    if (qcell.getFullUnit().getValue() == Unit("rad").getValue())
181      xtol_ = ytol_ = qcell.getValue("rad");
182    else
183      throw( AipsError("Invalid unit for direction tolerance.") );
184  }
185  else if (dirtol.size() > 1) {
186    if ( dirtol[0].empty() && dirtol[1].empty() )
187      throw( AipsError("Direction tolerance is empty.") );
188    if ( !dirtol[0].empty() ) {
189      readQuantity(qcell, String(dirtol[0]));
190      if (qcell.getFullUnit().getValue() == Unit("rad").getValue())
191        xtol_ = qcell.getValue("rad");
192      else
193        throw( AipsError("Invalid unit for direction tolerance.") );
194    }
195    if ( !dirtol[1].empty() ) {
196      readQuantity(qcell, String(dirtol[1]));
197      if (qcell.getFullUnit().getValue() == Unit("rad").getValue())
198        ytol_ = qcell.getValue("rad");
199      else
200        throw( AipsError("Invalid unit for direction tolerance.") );
201    }
202    else {
203      ytol_ = xtol_;
204    }
205  }
206  else throw( AipsError("Invalid direction tolerance.") );
207
208  os << "Direction tolerance: ( "
209     << xtol_ << " , " << ytol_ << " ) [rad]" << LogIO::POST;
210};
211
212void STSideBandSep::setShift(const vector<double> &shift)
213{
214  LogIO os(LogOrigin("STSideBandSep","setShift()", WHERE));
215  imgShift_.resize(shift.size());
216  for (unsigned int i = 0; i < shift.size(); i++)
217    imgShift_[i] = shift[i];
218
219  if (imgShift_.size() == 0) {
220    os << "Channel shifts are cleared." << LogIO::POST;
221  } else {
222    os << "Channel shifts of image sideband are set: ( ";
223    for (unsigned int i = 0; i < imgShift_.size(); i++) {
224      os << imgShift_[i];
225      if (i != imgShift_.size()-1) os << " , ";
226    }
227    os << " ) [channels]" << LogIO::POST;
228  }
229};
230
231void STSideBandSep::setThreshold(const double limit)
232{
233  LogIO os(LogOrigin("STSideBandSep","setThreshold()", WHERE));
234  if (limit < 0)
235    throw( AipsError("Rejection limit should be a positive number.") );
236
237  rejlimit_ = limit;
238  os << "Rejection limit is set to " << rejlimit_ << LogIO::POST;
239};
240
241void STSideBandSep::separate(string outname)
242{
243#ifdef KS_DEBUG
244  cout << "STSideBandSep::separate" << endl;
245#endif
246  LogIO os(LogOrigin("STSideBandSep","separate()", WHERE));
247  if (outname.empty())
248    outname = "sbseparated.asap";
249
250  // Set up a goup of IFNOs in the list of scantables within
251  // the frequency tolerance and make them a list.
252  nshift_ = setupShift();
253  if (nshift_ < 2)
254    throw( AipsError("At least 2 IFs are necessary for convolution.") );
255  // Grid scantable and generate output tables
256  ScantableWrapper gridst = gridTable();
257  sigTab_p = gridst.getCP();
258  if (doboth_)
259    imgTab_p = gridst.copy().getCP();
260  vector<unsigned int> remRowIds;
261  remRowIds.resize(0);
262  Matrix<float> specMat(nchan_, nshift_);
263  vector<float> sigSpec(nchan_), imgSpec(nchan_);
264  vector<uInt> tabIdvec;
265
266  //Generate FFTServer
267  fftsf.resize(IPosition(1, nchan_), FFTEnums::REALTOCOMPLEX);
268  fftsi.resize(IPosition(1, nchan_), FFTEnums::COMPLEXTOREAL);
269
270  /// Loop over sigTab_p and separate sideband
271  for (int irow = 0; irow < sigTab_p->nrow(); irow++){
272    tabIdvec.resize(0);
273    const int polId = sigTab_p->getPol(irow);
274    const int beamId = sigTab_p->getBeam(irow);
275    const vector<double> dir = sigTab_p->getDirectionVector(irow);
276    // Get a set of spectra to solve
277    if (!getSpectraToSolve(polId, beamId, dir[0], dir[1],
278                           specMat, tabIdvec)){
279      remRowIds.push_back(irow);
280#ifdef KS_DEBUG
281      cout << "no matching row found. skipping row = " << irow << endl;
282#endif
283      continue;
284    }
285    // Solve signal sideband
286    sigSpec = solve(specMat, tabIdvec, true);
287    sigTab_p->setSpectrum(sigSpec, irow);
288
289    // Solve image sideband
290    if (doboth_) {
291      imgSpec = solve(specMat, tabIdvec, false);
292      imgTab_p->setSpectrum(imgSpec, irow);
293    }
294  } // end of row loop
295
296  // Remove or flag rows without relevant data from gridded tables
297  if (remRowIds.size() > 0) {
298    const size_t nrem = remRowIds.size();
299    if ( sigTab_p->table().canRemoveRow() ) {
300      sigTab_p->table().removeRow(remRowIds);
301      os << "Removing " << nrem << " rows from the signal band table"
302         << LogIO::POST;
303    } else {
304      sigTab_p->flagRow(remRowIds, false);
305      os << "Cannot remove rows from the signal band table. Flagging "
306         << nrem << " rows" << LogIO::POST;
307    }
308
309    if (doboth_) {
310      if ( imgTab_p->table().canRemoveRow() ) {
311        imgTab_p->table().removeRow(remRowIds);
312        os << "Removing " << nrem << " rows from the image band table"
313           << LogIO::POST;
314      } else {
315        imgTab_p->flagRow(remRowIds, false);
316        os << "Cannot remove rows from the image band table. Flagging "
317           << nrem << " rows" << LogIO::POST;
318      }
319    }
320  }
321
322  // Finally, save tables on disk
323  if (outname.size() ==0)
324    outname = "sbseparated.asap";
325  const string sigName = outname + ".signalband";
326  os << "Saving SIGNAL sideband table: " << sigName << LogIO::POST;
327  sigTab_p->makePersistent(sigName);
328  if (doboth_) {
329    solveImageFrequency();
330    const string imgName = outname + ".imageband";
331    os << "Saving IMAGE sideband table: " << sigName << LogIO::POST;
332    imgTab_p->makePersistent(imgName);
333  }
334
335};
336
337unsigned int STSideBandSep::setupShift()
338{
339  LogIO os(LogOrigin("STSideBandSep","setupShift()", WHERE));
340  if (infileList_.size() == 0 && intabList_.size() == 0)
341    throw( AipsError("No scantable has been set. Set a list of scantables first.") );
342
343  const bool byname = (intabList_.size() == 0);
344  // Make sure sigIfno_ exists in the first table.
345  CountedPtr<Scantable> stab;
346  vector<string> coordsav;
347  vector<string> coordtmp(3);
348  os << "Checking IFNO in the first table." << LogIO::POST;
349  if (byname) {
350    if (!checkFile(infileList_[0], "d"))
351      os << LogIO::SEVERE << "Could not find scantable '" << infileList_[0]
352         << "'" << LogIO::EXCEPTION;
353    stab = CountedPtr<Scantable>(new Scantable(infileList_[0]));
354  } else {
355    stab = intabList_[0];
356  }
357  if (sigIfno_ < 0) {
358    sigIfno_ = (int) stab->getIF(0);
359    os << "IFNO to process has not been set. Using the first IF = "
360       << sigIfno_ << LogIO::POST;
361  }
362
363  unsigned int basench;
364  double basech0, baseinc, ftolval, inctolval;
365  coordsav = stab->getCoordInfo();
366  const string stfframe = coordsav[1];
367  coordtmp[0] = "Hz";
368  coordtmp[1] = ( (solFrame_ == MFrequency::N_Types) ?
369                  stfframe :
370                  MFrequency::showType(solFrame_) );
371  coordtmp[2] = coordsav[2];
372  stab->setCoordInfo(coordtmp);
373  if (!getFreqInfo(stab, (unsigned int) sigIfno_, basech0, baseinc, basench)) {
374    os << LogIO::SEVERE << "No data with IFNO=" << sigIfno_
375       << " found in the first table." << LogIO::EXCEPTION;
376  }
377  else {
378    os << "Found IFNO = " << sigIfno_
379       << " in the first table." << LogIO::POST;
380  }
381  if (ftol_.getUnit().empty()) {
382    // tolerance in unit of channels
383    ftolval = ftol_.getValue() * baseinc;
384  }
385  else {
386    ftolval = ftol_.getValue("Hz");
387  }
388  inctolval = abs(baseinc/(double) basench);
389  const string poltype0 = stab->getPolType();
390
391  // Initialize shift values
392  initshift();
393
394  const bool setImg = ( doboth_ && (imgShift_.size() == 0) );
395  // Select IFs
396  for (unsigned int itab = 0; itab < ntable_; itab++ ){
397    os << "Table " << itab << LogIO::POST;
398    if (itab > 0) {
399      if (byname) {
400        if (!checkFile(infileList_[itab], "d"))
401          os << LogIO::SEVERE << "Could not find scantable '"
402             << infileList_[itab] << "'" << LogIO::EXCEPTION;
403        stab = CountedPtr<Scantable>(new Scantable(infileList_[itab]));
404      } else {
405        stab = intabList_[itab];
406      }
407      //POLTYPE should be the same.
408      if (stab->getPolType() != poltype0 ) {
409        os << LogIO::WARN << "POLTYPE differs from the first table."
410           << " Skipping the table" << LogIO::POST;
411        continue;
412      }
413      // Multi beam data may not handled properly
414      if (stab->nbeam() > 1)
415        os <<  LogIO::WARN << "Table contains multiple beams. "
416           << "It may not be handled properly."  << LogIO::POST;
417
418      coordsav = stab->getCoordInfo();
419      coordtmp[2] = coordsav[2];
420      stab->setCoordInfo(coordtmp);
421    }
422    bool selected = false;
423    vector<uint> ifnos = stab->getIFNos();
424    vector<uint>::iterator iter;
425    const STSelector& basesel = stab->getSelection();
426    for (iter = ifnos.begin(); iter != ifnos.end(); iter++){
427      unsigned int nch;
428      double freq0, incr;
429      if ( getFreqInfo(stab, *iter, freq0, incr, nch) ){
430        if ( (nch == basench) && (abs(freq0-basech0) < ftolval)
431             && (abs(incr-baseinc) < inctolval) ){
432          //Found
433          STSelector sel(basesel);
434          sel.setIFs(vector<int>(1,(int) *iter));
435          stab->setSelection(sel);
436          CountedPtr<Scantable> seltab = ( new Scantable(*stab, false) );
437          stab->setSelection(basesel);
438          seltab->setCoordInfo(coordsav);
439          const double chShift = (freq0 - basech0) / baseinc;
440          tableList_.push_back(seltab);
441          sigShift_.push_back(-chShift);
442          if (setImg)
443            imgShift_.push_back(chShift);
444
445          selected = true;
446          os << "- IF" << *iter << " selected: sideband shift = "
447             << chShift << " channels" << LogIO::POST;
448        }
449      }
450    } // ifno loop
451    stab->setCoordInfo(coordsav);
452    if (!selected)
453      os << LogIO::WARN << "No data selected in Table "
454         << itab << LogIO::POST;
455  } // table loop
456  nchan_ = basench;
457
458  os << "Total number of IFs selected = " << tableList_.size()
459     << LogIO::POST;
460  if ( setImg && (sigShift_.size() != imgShift_.size()) ){
461      os << LogIO::SEVERE
462         << "User defined channel shift of image sideband has "
463         << imgShift_.size()
464         << " elements, while selected IFNOs are " << sigShift_.size()
465         << "\nThe frequency tolerance (freqtol) may be too small."
466         << LogIO::EXCEPTION;
467  }
468
469  return tableList_.size();
470};
471
472bool STSideBandSep::getFreqInfo(const CountedPtr<Scantable> &stab,
473                                const unsigned int &ifno,
474                                double &freq0, double &incr,
475                                unsigned int &nchan)
476{
477    vector<uint> ifnos = stab->getIFNos();
478    bool found = false;
479    vector<uint>::iterator iter;
480    for (iter = ifnos.begin(); iter != ifnos.end(); iter++){
481      if (*iter == ifno) {
482        found = true;
483        break;
484      }
485    }
486    if (!found)
487      return false;
488
489    const STSelector& basesel = stab->getSelection();
490    STSelector sel(basesel);
491    sel.setIFs(vector<int>(1,(int) ifno));
492    stab->setSelection(sel);
493    vector<double> freqs;
494    freqs = stab->getAbcissa(0);
495    freq0 = freqs[0];
496    incr = freqs[1] - freqs[0];
497    nchan = freqs.size();
498    stab->setSelection(basesel);
499    return true;
500};
501
502ScantableWrapper STSideBandSep::gridTable()
503{
504  LogIO os(LogOrigin("STSideBandSep","gridTable()", WHERE));
505  if (tableList_.size() == 0)
506    throw( AipsError("Internal error. No scantable has been set to grid.") );
507  Double xmin, xmax, ymin, ymax;
508  mapExtent(tableList_, xmin, xmax, ymin, ymax);
509  const Double centx = 0.5 * (xmin + xmax);
510  const Double centy = 0.5 * (ymin + ymax);
511  const int nx = max(1, (int) ceil( (xmax - xmin) * cos(centy) /xtol_ ) );
512  const int ny = max(1, (int) ceil( (ymax - ymin) / ytol_ ) );
513
514  string scellx, scelly;
515  {
516    ostringstream oss;
517    oss << xtol_ << "rad" ;
518    scellx = oss.str();
519  }
520  {
521    ostringstream oss;
522    oss << ytol_ << "rad" ;
523    scelly = oss.str();
524  }
525
526  ScantableWrapper stab0;
527  if (intabList_.size() > 0)
528    stab0 = ScantableWrapper(intabList_[0]);
529  else
530    stab0 = ScantableWrapper(infileList_[0]);
531
532  string scenter;
533  {
534    ostringstream oss;
535    oss << stab0.getCP()->getDirectionRefString() << " "
536        << centx << "rad" << " " << centy << "rad";
537    scenter = oss.str();
538  }
539 
540  STGrid2 gridder = STGrid2(stab0);
541  gridder.setIF(sigIfno_);
542  gridder.defineImage(nx, ny, scellx, scelly, scenter);
543  //  gridder.setFunc("box", 1); // convsupport=1 fails
544  gridder.setFunc("box");
545  gridder.setWeight("uniform");
546#ifdef KS_DEBUG
547  cout << "Grid parameter summary: " << endl;
548  cout << "- IF = " << sigIfno_ << endl;
549  cout << "- center = " << scenter << "\n"
550       << "- npix = (" << nx << ", " << ny << ")\n"
551       << "- cell = (" << scellx << ", " << scelly << ")" << endl;
552#endif
553  gridder.grid();
554  const int itp = (tp_ == Table::Memory ? 0 : 1);
555  ScantableWrapper gtab = gridder.getResultAsScantable(itp);
556  return gtab;
557};
558
559void STSideBandSep::mapExtent(vector< CountedPtr<Scantable> > &tablist,
560                              Double &xmin, Double &xmax,
561                              Double &ymin, Double &ymax)
562{
563  ROArrayColumn<Double> dirCol_;
564  dirCol_.attach( tablist[0]->table(), "DIRECTION" );
565  Matrix<Double> direction = dirCol_.getColumn();
566  Vector<Double> ra( direction.row(0) );
567  mathutil::rotateRA(ra);
568  minMax( xmin, xmax, ra );
569  minMax( ymin, ymax, direction.row(1) );
570  Double amin, amax, bmin, bmax;
571  const uInt ntab = tablist.size();
572  for ( uInt i = 1 ; i < ntab ; i++ ) {
573    dirCol_.attach( tablist[i]->table(), "DIRECTION" );
574    direction.assign( dirCol_.getColumn() );
575    ra.assign( direction.row(0) );
576    mathutil::rotateRA(ra);
577    minMax( amin, amax, ra );
578    minMax( bmin, bmax, direction.row(1) );
579    xmin = min(xmin, amin);
580    xmax = max(xmax, amax);
581    ymin = min(ymin, bmin);
582    ymax = max(ymax, bmax);
583  }
584};
585
586bool STSideBandSep::getSpectraToSolve(const int polId, const int beamId,
587                                      const double dirX, const double dirY,
588                                      Matrix<float> &specMat, vector<uInt> &tabIdvec)
589{
590  LogIO os(LogOrigin("STSideBandSep","getSpectraToSolve()", WHERE));
591
592  tabIdvec.resize(0);
593  specMat.resize(nchan_, nshift_);
594  Vector<float> spec;
595  uInt nspec = 0;
596  STMath stm(false); // insitu has no effect for average.
597  for (uInt itab = 0 ; itab < nshift_ ; itab++) {
598    CountedPtr<Scantable> currtab_p = tableList_[itab];
599    // Selection by POLNO and BEAMNO
600    const STSelector& basesel = currtab_p->getSelection();
601    STSelector sel(basesel);
602    sel.setPolarizations(vector<int>(1, polId));
603    sel.setBeams(vector<int>(1, beamId));
604    try {
605      currtab_p->setSelection(sel);
606    } catch (...) {
607#ifdef KS_DEBUG
608      cout << "Table " << itab << " - No spectrum found. skipping the table."
609           << endl;
610#endif
611      continue;
612    }
613    // Selection by direction;
614    vector<int> selrow(0);
615    vector<double> currDir(2, 0.);
616    const int nselrow = currtab_p->nrow();
617    for (int irow = 0 ; irow < nselrow ; irow++) {
618      currDir = currtab_p->getDirectionVector(irow);
619      if ( (abs(currDir[0]-dirX) > xtol_) ||
620           (abs(currDir[1]-dirY) > ytol_) )
621        continue;
622      // within direction tolerance
623      selrow.push_back(irow);
624    } // end of row loop
625
626    if (selrow.size() < 1) {
627      currtab_p->setSelection(basesel);
628
629#ifdef KS_DEBUG
630      cout << "Table " << itab << " - No spectrum found. skipping the table."
631           << endl;
632#endif
633
634      continue;
635    }
636
637    // At least a spectrum is selected in this table
638    CountedPtr<Scantable> seltab_p = ( new Scantable(*currtab_p, false) );
639    currtab_p->setSelection(basesel);
640    STSelector sel2(seltab_p->getSelection());
641    sel2.setRows(selrow);
642    seltab_p->setSelection(sel2);
643    CountedPtr<Scantable> avetab_p;
644    if (seltab_p->nrow() > 1) {
645      // STMath::average also merges FLAGTRA and FLAGROW
646      avetab_p = stm.average(vector< CountedPtr<Scantable> >(1, seltab_p),
647                             vector<bool>(), "TINTSYS", "NONE");
648#ifdef KS_DEBUG
649      cout << "Table " << itab << " - more than a spectrum is selected. averaging rows..."
650           << endl;
651#endif
652      if (avetab_p->nrow() > 1)
653        throw( AipsError("Averaged table has more than a row. Somethigs went wrong.") );
654    } else {
655      avetab_p = seltab_p;
656    }
657    // Check FLAGTRA and FLAGROW if there's any valid channel in the spectrum
658    if (avetab_p->getFlagRow(0) || avetab_p->isAllChannelsFlagged(0)) {
659#ifdef KS_DEBUG
660      cout << "Table " << itab << " - All data are flagged. skipping the table."
661           << endl;
662#endif
663      continue;
664    }
665    // Interpolate flagged channels of the spectrum.
666    Vector<Float> tmpSpec = avetab_p->getSpectrum(0);
667    vector<bool> mask = avetab_p->getMask(0);
668    mathutil::doZeroOrderInterpolation(tmpSpec, mask);
669    spec.reference(specMat.column(nspec));
670    spec = tmpSpec;
671    tabIdvec.push_back((uInt) itab);
672    nspec++;
673  } // end of table loop
674  // Check the number of selected spectra and resize matrix.
675  if (nspec != nshift_){
676    //shiftSpecmat.resize(nchan_, nspec, true);
677    specMat.resize(nchan_, nspec, true);
678#ifdef KS_DEBUG
679      cout << "Could not find corresponding rows in some tables."
680           << endl;
681      cout << "Number of spectra selected = " << nspec << endl;
682#endif
683  }
684  if (nspec < 2) {
685#ifdef KS_DEBUG
686      cout << "At least 2 spectra are necessary for convolution"
687           << endl;
688#endif
689      return false;
690  }
691  return true;
692};
693
694vector<float> STSideBandSep::solve(const Matrix<float> &specmat,
695                                   const vector<uInt> &tabIdvec,
696                                   const bool signal)
697{
698  LogIO os(LogOrigin("STSideBandSep","solve()", WHERE));
699  if (tabIdvec.size() == 0)
700    throw(AipsError("Internal error. Table index is not defined."));
701  if (specmat.ncolumn() != tabIdvec.size())
702    throw(AipsError("Internal error. The row number of input matrix is not conformant."));
703  if (specmat.nrow() != nchan_)
704    throw(AipsError("Internal error. The channel size of input matrix is not conformant."));
705 
706
707#ifdef KS_DEBUG
708  cout << "Solving " << (signal ? "SIGNAL" : "IMAGE") << " sideband."
709     << endl;
710#endif
711
712  const size_t nspec = tabIdvec.size();
713  vector<double> *thisShift, *otherShift;
714  if (signal == otherside_) {
715    // (solve signal && solveother = T) OR (solve image && solveother = F)
716    thisShift = &imgShift_;
717    otherShift = &sigShift_;
718#ifdef KS_DEBUG
719    cout << "Image sideband will be deconvolved." << endl;
720#endif
721  } else {
722    // (solve signal && solveother = F) OR (solve image && solveother = T)
723    thisShift =  &sigShift_;
724    otherShift = &imgShift_;
725#ifdef KS_DEBUG
726    cout << "Signal sideband will be deconvolved." << endl;
727#endif
728 }
729
730  vector<double> spshift(nspec);
731  Matrix<float> shiftSpecmat(nchan_, nspec, 0.);
732  double tempshift;
733  Vector<float> shiftspvec;
734  for (uInt i = 0 ; i < nspec; i++) {
735    spshift[i] = otherShift->at(i) - thisShift->at(i);
736    tempshift = - thisShift->at(i);
737    shiftspvec.reference(shiftSpecmat.column(i));
738    shiftSpectrum(specmat.column(i), tempshift, shiftspvec);
739  }
740
741  Matrix<float> convmat(nchan_, nspec*(nspec-1)/2, 0.);
742  vector<float> thisvec(nchan_, 0.);
743
744  float minval, maxval;
745  minMax(minval, maxval, shiftSpecmat);
746#ifdef KS_DEBUG
747  cout << "Max/Min of input Matrix = (max: " << maxval << ", min: " << minval << ")" << endl;
748#endif
749
750#ifdef KS_DEBUG
751  cout << "starting deconvolution" << endl;
752#endif
753  deconvolve(shiftSpecmat, spshift, rejlimit_, convmat);
754#ifdef KS_DEBUG
755  cout << "finished deconvolution" << endl;
756#endif
757
758  minMax(minval, maxval, convmat);
759#ifdef KS_DEBUG
760  cout << "Max/Min of output Matrix = (max: " << maxval << ", min: " << minval << ")" << endl;
761#endif
762
763  aggregateMat(convmat, thisvec);
764
765  if (!otherside_) return thisvec;
766
767  // subtract from the other side band.
768  vector<float> othervec(nchan_, 0.);
769  subtractFromOther(shiftSpecmat, thisvec, spshift, othervec);
770  return othervec;
771};
772
773
774void STSideBandSep::shiftSpectrum(const Vector<float> &invec,
775                                  double shift,
776                                  Vector<float> &outvec)
777{
778  LogIO os(LogOrigin("STSideBandSep","shiftSpectrum()", WHERE));
779  if (invec.size() != nchan_)
780    throw(AipsError("Internal error. The length of input vector differs from nchan_"));
781  if (outvec.size() != nchan_)
782    throw(AipsError("Internal error. The length of output vector differs from nchan_"));
783
784#ifdef KS_DEBUG
785  cout << "Start shifting spectrum for " << shift << "channels" << endl;
786#endif
787
788  // tweak shift to be in 0 ~ nchan_-1
789  if ( fabs(shift) > nchan_ ) shift = fmod(shift, nchan_);
790  if (shift < 0.) shift += nchan_;
791  double rweight = fmod(shift, 1.);
792  if (rweight < 0.) rweight += 1.;
793  double lweight = 1. - rweight;
794  uInt lchan, rchan;
795
796  outvec = 0;
797  for (uInt i = 0 ; i < nchan_ ; i++) {
798    lchan = uInt( floor( fmod( (i + shift), nchan_ ) ) );
799    if (lchan < 0.) lchan += nchan_;
800    rchan = ( (lchan + 1) % nchan_ );
801    outvec(lchan) += invec(i) * lweight;
802    outvec(rchan) += invec(i) * rweight;
803  }
804};
805
806void STSideBandSep::deconvolve(Matrix<float> &specmat,
807                               const vector<double> shiftvec,
808                               const double threshold,
809                               Matrix<float> &outmat)
810{
811  LogIO os(LogOrigin("STSideBandSep","deconvolve()", WHERE));
812  if (specmat.nrow() != nchan_)
813    throw(AipsError("Internal error. The length of input matrix differs from nchan_"));
814  if (specmat.ncolumn() != shiftvec.size())
815    throw(AipsError("Internal error. The number of input shifts and spectrum  differs."));
816
817#ifdef KS_DEBUG
818  float minval, maxval;
819#endif
820#ifdef KS_DEBUG
821  minMax(minval, maxval, specmat);
822  cout << "Max/Min of input Matrix = (max: " << maxval << ", min: " << minval << ")" << endl;
823#endif
824
825  uInt ninsp = shiftvec.size();
826  outmat.resize(nchan_, ninsp*(ninsp-1)/2, 0.);
827  Matrix<Complex> fftspmat(nchan_/2+1, ninsp, 0.);
828  Vector<float> rvecref(nchan_, 0.);
829  Vector<Complex> cvecref(nchan_/2+1, 0.);
830  uInt icol = 0;
831  unsigned int nreject = 0;
832
833#ifdef KS_DEBUG
834  cout << "Starting initial FFT. The number of input spectra = " << ninsp << endl;
835  cout << "out matrix has ncolumn = " << outmat.ncolumn() << endl;
836#endif
837
838  for (uInt isp = 0 ; isp < ninsp ; isp++) {
839    rvecref.reference( specmat.column(isp) );
840    cvecref.reference( fftspmat.column(isp) );
841
842#ifdef KS_DEBUG
843    minMax(minval, maxval, rvecref);
844    cout << "Max/Min of inv FFTed Matrix = (max: " << maxval << ", min: " << minval << ")" << endl;
845#endif
846
847    fftsf.fft0(cvecref, rvecref, true);
848
849#ifdef KS_DEBUG
850    double maxr=cvecref[0].real(), minr=cvecref[0].real(),
851      maxi=cvecref[0].imag(), mini=cvecref[0].imag();
852    for (uInt i = 1; i<cvecref.size();i++){
853      maxr = max(maxr, cvecref[i].real());
854      maxi = max(maxi, cvecref[i].imag());
855      minr = min(minr, cvecref[i].real());
856      mini = min(mini, cvecref[i].imag());
857    }
858    cout << "Max/Min of inv FFTed Matrix (size=" << cvecref.size() << ") = (max: " << maxr << " + " << maxi << "j , min: " << minr << " + " << mini << "j)" << endl;
859#endif
860  }
861
862  //Liberate from reference
863  rvecref.unique();
864
865  Vector<Complex> cspec(nchan_/2+1, 0.);
866  const double PI = 6.0 * asin(0.5);
867  const double nchani = 1. / (float) nchan_;
868  const Complex trans(0., 1.);
869#ifdef KS_DEBUG
870  cout << "starting actual deconvolution" << endl;
871#endif
872  for (uInt j = 0 ; j < ninsp ; j++) {
873    for (uInt k = j+1 ; k < ninsp ; k++) {
874      const double dx = (shiftvec[k] - shiftvec[j]) * 2. * PI * nchani;
875
876#ifdef KS_DEBUG
877      cout << "icol = " << icol << endl;
878#endif
879
880      for (uInt ichan = 0 ; ichan < cspec.size() ; ichan++){
881        cspec[ichan] = ( fftspmat(ichan, j) + fftspmat(ichan, k) )*0.5;
882        double phase = dx*ichan;
883        if ( fabs( sin(phase) ) > threshold){
884          cspec[ichan] += ( fftspmat(ichan, j) - fftspmat(ichan, k) ) * 0.5
885            * trans * sin(phase) / ( 1. - cos(phase) );
886        } else {
887          nreject++;
888        }
889      } // end of channel loop
890
891#ifdef KS_DEBUG
892      cout << "done calculation of cspec" << endl;
893#endif
894
895      Vector<Float> rspec;
896      rspec.reference( outmat.column(icol) );
897
898#ifdef KS_DEBUG
899      cout << "Starting inverse FFT. icol = " << icol << endl;
900      //cout << "- size of complex vector = " << cspec.size() << endl;
901      double maxr=cspec[0].real(), minr=cspec[0].real(),
902        maxi=cspec[0].imag(), mini=cspec[0].imag();
903      for (uInt i = 1; i<cspec.size();i++){
904        maxr = max(maxr, cspec[i].real());
905        maxi = max(maxi, cspec[i].imag());
906        minr = min(minr, cspec[i].real());
907        mini = min(mini, cspec[i].imag());
908      }
909      cout << "Max/Min of conv vector (size=" << cspec.size() << ") = (max: " << maxr << " + " << maxi << "j , min: " << minr << " + " << mini << "j)" << endl;
910#endif
911
912      fftsi.fft0(rspec, cspec, false);
913
914#ifdef KS_DEBUG
915      //cout << "- size of inversed real vector = " << rspec.size() << endl;
916      minMax(minval, maxval, rspec);
917      cout << "Max/Min of inv FFTed Vector (size=" << rspec.size() << ") = (max: " << maxval << ", min: " << minval << ")" << endl;
918      //cout << "Done inverse FFT. icol = " << icol << endl;
919#endif
920
921      icol++;
922    }
923  }
924
925#ifdef KS_DEBUG
926  minMax(minval, maxval, outmat);
927  cout << "Max/Min of inv FFTed Matrix = (max: " << maxval << ", min: " << minval << ")" << endl;
928#endif
929
930  os << "Threshold = " << threshold << ", Rejected channels = " << nreject << endl;
931};
932
933
934void STSideBandSep::aggregateMat(Matrix<float> &inmat,
935                                 vector<float> &outvec)
936{
937  LogIO os(LogOrigin("STSideBandSep","aggregateMat()", WHERE));
938  if (inmat.nrow() != nchan_)
939    throw(AipsError("Internal error. The row numbers of input matrix differs from nchan_"));
940//   if (outvec.size() != nchan_)
941//     throw(AipsError("Internal error. The size of output vector should be equal to nchan_"));
942
943  os << "Averaging " << inmat.ncolumn() << " spectra in the input matrix."
944     << LogIO::POST;
945
946  const uInt nspec = inmat.ncolumn();
947  const double scale = 1./( (double) nspec );
948  // initialize values with 0
949  outvec.assign(nchan_, 0);
950  for (uInt isp = 0 ; isp < nspec ; isp++) {
951    for (uInt ich = 0 ; ich < nchan_ ; ich++) {
952      outvec[ich] += inmat(ich, isp);
953    }
954  }
955
956  vector<float>::iterator iter;
957  for (iter = outvec.begin(); iter != outvec.end(); iter++){
958    *iter *= scale;
959  }
960};
961
962void STSideBandSep::subtractFromOther(const Matrix<float> &shiftmat,
963                                      const vector<float> &invec,
964                                      const vector<double> &shift,
965                                      vector<float> &outvec)
966{
967  LogIO os(LogOrigin("STSideBandSep","subtractFromOther()", WHERE));
968  if (shiftmat.nrow() != nchan_)
969    throw(AipsError("Internal error. The row numbers of input matrix differs from nchan_"));
970  if (invec.size() != nchan_)
971    throw(AipsError("Internal error. The length of input vector should be nchan_"));
972  if (shift.size() != shiftmat.ncolumn())
973    throw(AipsError("Internal error. The column numbers of input matrix != the number of elements in shift"));
974
975  const uInt nspec = shiftmat.ncolumn();
976  Vector<float> subsp(nchan_, 0.), shiftsub;
977  Matrix<float> submat(nchan_, nspec, 0.);
978  vector<float>::iterator iter;
979  for (uInt isp = 0 ; isp < nspec ; isp++) {
980    for (uInt ich = 0; ich < nchan_ ; ich++) {
981      subsp(ich) = shiftmat(ich, isp) - invec[ich];
982    }
983    shiftsub.reference(submat.column(isp));
984    shiftSpectrum(subsp, shift[isp], shiftsub);
985  }
986
987  aggregateMat(submat, outvec);
988};
989
990
991void STSideBandSep::setLO1(const string lo1, const string frame,
992                           const double reftime, const string refdir)
993{
994  Quantum<Double> qfreq;
995  readQuantity(qfreq, String(lo1));
996  lo1Freq_ = qfreq.getValue("Hz");
997  MFrequency::getType(loFrame_, frame);
998  loTime_ = reftime;
999  loDir_ = refdir;
1000
1001#ifdef KS_DEBUG
1002  cout << "STSideBandSep::setLO1" << endl;
1003  if (lo1Freq_ > 0.)
1004    cout << "lo1 = " << lo1Freq_ << " [Hz] (" << frame << ")" << endl;
1005  if (loTime_ > 0.)
1006    cout << "ref time = " << loTime_ << " [day]" << endl;
1007  if (!loDir_.empty())
1008    cout << "ref direction = " << loDir_ << " [day]" << endl;
1009#endif
1010};
1011
1012void STSideBandSep::setLO1Root(string name)
1013{
1014   LogIO os(LogOrigin("STSideBandSep","setLO1Root()", WHERE));
1015   os << "Searching for '" << name << "'..." << LogIO::POST;
1016  // Check for existance of the file
1017  if (!checkFile(name)) {
1018     throw(AipsError("File does not exist"));
1019  }
1020  if (name[(name.size()-1)] == '/')
1021    name = name.substr(0,(name.size()-2));
1022
1023  if (checkFile(name+"/Receiver.xml", "file") &&
1024      checkFile(name+"/SpectralWindow.xml", "file")){
1025    os << "Found '" << name << "/Receiver.xml' ... got an ASDM name." << LogIO::POST;
1026    asdmName_ = name;
1027  } else if (checkFile(name+"/ASDM_RECEIVER") &&
1028             checkFile(name+"/ASDM_SPECTRALWINDOW")){
1029    os << "Found '" << name << "/ASDM_RECEIVER' ... got a Table name." << LogIO::POST;
1030    asisName_ = name;
1031  } else {
1032    throw(AipsError("Invalid file name. Set an MS or ASDM name."));
1033  }
1034
1035#ifdef KS_DEBUG
1036  cout << "STSideBandSep::setLO1Root" << endl;
1037  if (!asdmName_.empty())
1038    cout << "asdm name = " << asdmName_ << endl;
1039  if (!asisName_.empty())
1040    cout << "MS name = " << asisName_ << endl;
1041#endif
1042};
1043
1044
1045void STSideBandSep::solveImageFrequency()
1046{
1047  LogIO os(LogOrigin("STSideBandSep","solveImageFreqency()", WHERE));
1048  os << "Start calculating frequencies of image side band" << LogIO::POST;
1049
1050  if (imgTab_p.null())
1051    throw AipsError("STSideBandSep::solveImageFreqency - an image side band scantable should be set first");
1052
1053  // Convert frequency REFVAL to the value in frame of LO.
1054  // The code assumes that imgTab_p has only an IF and only a FREQ_ID
1055  // is associated to an IFNO
1056  // TODO: More complete Procedure would be
1057  // 1. Get freq IDs associated to sigIfno_
1058  // 2. Get freq information of the freq IDs
1059  // 3. For each freqIDs, get freq infromation in TOPO and an LO1
1060  //    frequency and calculate image band frequencies.
1061  STFrequencies freqTab_ = imgTab_p->frequencies();
1062  // get the base frame of table
1063  const MFrequency::Types tabframe = freqTab_.getFrame(true);
1064  TableVector<uInt> freqIdVec( imgTab_p->table(), "FREQ_ID" );
1065  // assuming single freqID per IFNO
1066  uInt freqid = freqIdVec(0);
1067  int nChan = imgTab_p->nchan(imgTab_p->getIF(0));
1068  double refpix, refval, increment ;
1069  freqTab_.getEntry(refpix, refval, increment, freqid);
1070  //MFrequency sigrefval = MFrequency(MVFrequency(refval),tabframe);
1071  // get freq infromation of sigIfno_ in loFrame_
1072  const MPosition mp = imgTab_p->getAntennaPosition();
1073  MEpoch me;
1074  MDirection md;
1075  if (loTime_ < 0.)
1076    me = imgTab_p->getEpoch(-1);
1077  else
1078    me = MEpoch(MVEpoch(loTime_));
1079  if (loDir_.empty()) {
1080    ArrayColumn<Double> srcdirCol_;
1081    srcdirCol_.attach(imgTab_p->table(), "SRCDIRECTION");
1082    // Assuming J2000 and SRCDIRECTION in unit of rad
1083    Quantum<Double> srcra = Quantum<Double>(srcdirCol_(0)(IPosition(1,0)), "rad");
1084    Quantum<Double> srcdec = Quantum<Double>(srcdirCol_(0)(IPosition(1,1)), "rad");
1085    md = MDirection(srcra, srcdec, MDirection::J2000);
1086    //imgTab_p->getDirection(0);
1087  } else {
1088    // parse direction string
1089    string::size_type pos0 = loDir_.find(" ");
1090   
1091    if (pos0 == string::npos) {
1092      throw AipsError("bad string format in LO1 direction");
1093    }
1094    string::size_type pos1 = loDir_.find(" ", pos0+1);
1095    String sepoch, sra, sdec;
1096    if (pos1 != string::npos) {
1097      sepoch = loDir_.substr(0, pos0);
1098      sra = loDir_.substr(pos0+1, pos1-pos0);
1099      sdec = loDir_.substr(pos1+1);
1100    }
1101    MDirection::Types epoch;
1102    MDirection::getType(epoch, sepoch);
1103    QuantumHolder qh ;
1104    String err ;
1105    qh.fromString( err, sra);
1106    Quantum<Double> ra = qh.asQuantumDouble() ;
1107    qh.fromString( err, sdec ) ;
1108    Quantum<Double> dec = qh.asQuantumDouble() ;
1109    //md = MDirection(ra.getValue("rad"), dec.getValue("rad"),epoch);
1110    md = MDirection(ra, dec, epoch);
1111  }
1112  MeasFrame mframe( me, mp, md );
1113  MFrequency::Convert tobframe(loFrame_, MFrequency::Ref(tabframe, mframe));
1114  MFrequency::Convert toloframe(tabframe, MFrequency::Ref(loFrame_, mframe));
1115  // Convert refval to loFrame_
1116  double sigrefval;
1117  if (tabframe == loFrame_)
1118    sigrefval = refval;
1119  else
1120    sigrefval = toloframe(Quantum<Double>(refval, "Hz")).get("Hz").getValue();
1121
1122  // Check for the availability of LO1
1123  if (lo1Freq_ > 0.) {
1124    os << "Using user defined LO1 frequency." << LogIO::POST;
1125  } else if (!asisName_.empty()) {
1126      // MS name is set.
1127    os << "Using user defined MS (asis): " << asisName_ << LogIO::POST;
1128    if (!getLo1FromAsisTab(asisName_, sigrefval, refpix, increment, nChan)) {
1129      throw AipsError("Failed to get LO1 frequency from MS");
1130    }
1131  } else if (!asdmName_.empty()) {
1132      // ASDM name is set.
1133    os << "Using user defined ASDM: " << asdmName_ << LogIO::POST;
1134    if (!getLo1FromAsdm(asdmName_, sigrefval, refpix, increment, nChan)) {
1135      throw AipsError("Failed to get LO1 frequency from ASDM");
1136    }
1137  } else {
1138    // Try getting ASDM name from scantable header
1139    os << "Try getting information from scantable header" << LogIO::POST;
1140    if (!getLo1FromScanTab(tableList_[0], sigrefval, refpix, increment, nChan)) {
1141      //throw AipsError("Failed to get LO1 frequency from asis table");
1142      os << LogIO::WARN << "Failed to get LO1 frequency using information in scantable." << LogIO::POST;
1143      os << LogIO::WARN << "Could not fill frequency information of IMAGE sideband properly." << LogIO::POST;
1144      os << LogIO::WARN << "Storing values of SIGNAL sideband in FREQUENCIES table" << LogIO::POST;
1145      return;
1146    }
1147  }
1148
1149  // LO1 should now be ready.
1150  if (lo1Freq_ < 0.)
1151    throw(AipsError("Got negative LO1 Frequency"));
1152
1153  // Print summary
1154  {
1155    // LO1
1156    Vector<Double> dirvec = md.getAngle(Unit(String("rad"))).getValue();
1157    os << "[LO1 settings]" << LogIO::POST;
1158    os << "- Frequency: " << lo1Freq_ << " [Hz] ("
1159       << MFrequency::showType(loFrame_) << ")" << LogIO::POST;
1160    os << "- Reference time: " << me.get(Unit(String("d"))).getValue()
1161       << " [day]" << LogIO::POST;
1162    os << "- Reference direction: [" << dirvec[0] << ", " << dirvec[1]
1163       << "] (" << md.getRefString() << ") " << LogIO::POST;
1164
1165    // signal sideband
1166    os << "[Signal side band]" << LogIO::POST;
1167    os << "- IFNO: " << imgTab_p->getIF(0) << " (FREQ_ID = " << freqid << ")"
1168       << LogIO::POST;
1169    os << "- Reference value: " << refval << " [Hz] ("
1170       << MFrequency::showType(tabframe) << ") = "
1171       << sigrefval << " [Hz] (" <<  MFrequency::showType(loFrame_)
1172       << ")" << LogIO::POST;
1173    os << "- Reference pixel: " << refpix  << LogIO::POST;
1174    os << "- Increment: " << increment << " [Hz]" << LogIO::POST;
1175  }
1176
1177  // Calculate image band incr and refval in loFrame_
1178  Double imgincr = -increment;
1179  Double imgrefval = 2 * lo1Freq_ - sigrefval;
1180  Double imgrefval_tab = imgrefval;
1181  // Convert imgrefval back to table base frame
1182  if (tabframe != loFrame_)
1183    imgrefval = tobframe(Quantum<Double>(imgrefval, "Hz")).get("Hz").getValue();
1184  // Set new frequencies table
1185  uInt fIDnew = freqTab_.addEntry(refpix, imgrefval, imgincr);
1186  // Update FREQ_ID in table.
1187  freqIdVec = fIDnew;
1188
1189  // Print summary (Image sideband)
1190  {
1191    os << "[Image side band]" << LogIO::POST;
1192    os << "- IFNO: " << imgTab_p->getIF(0) << " (FREQ_ID = " << freqIdVec(0)
1193       << ")" << LogIO::POST;
1194    os << "- Reference value: " << imgrefval << " [Hz] ("
1195       << MFrequency::showType(tabframe) << ") = "
1196       << imgrefval_tab << " [Hz] (" <<  MFrequency::showType(loFrame_)
1197       << ")" << LogIO::POST;
1198    os << "- Reference pixel: " << refpix  << LogIO::POST;
1199    os << "- Increment: " << imgincr << " [Hz]" << LogIO::POST;
1200  }
1201};
1202
1203Bool STSideBandSep::checkFile(const string name, string type)
1204{
1205  File file(name);
1206  if (!file.exists()){
1207    return false;
1208  } else if (type.empty()) {
1209    return true;
1210  } else {
1211    // Check for file type
1212    switch (tolower(type[0])) {
1213    case 'f':
1214      return file.isRegular(True);
1215    case 'd':
1216      return file.isDirectory(True);
1217    case 's':
1218      return file.isSymLink();
1219    default:
1220      throw AipsError("Invalid file type. Available types are 'file', 'directory', and 'symlink'.");
1221    }
1222  }
1223};
1224
1225bool STSideBandSep::getLo1FromAsdm(const string asdmname,
1226                                   const double /*refval*/,
1227                                   const double /*refpix*/,
1228                                   const double /*increment*/,
1229                                   const int /*nChan*/)
1230{
1231  // Check for relevant tables.
1232  string spwname = asdmname + "/SpectralWindow.xml";
1233  string recname = asdmname + "/Receiver.xml";
1234  if (!checkFile(spwname) || !checkFile(recname)) {
1235    throw(AipsError("Could not find subtables in ASDM"));
1236  }
1237
1238  return false;
1239
1240};
1241
1242
1243bool STSideBandSep::getLo1FromScanTab(CountedPtr< Scantable > &scantab,
1244                                      const double refval,
1245                                      const double refpix,
1246                                      const double increment,
1247                                      const int nChan)
1248{
1249  LogIO os(LogOrigin("STSideBandSep","getLo1FromScanTab()", WHERE));
1250  // Check for relevant tables.
1251  const TableRecord &rec = scantab->table().keywordSet() ;
1252  String spwname, recname;
1253  if (rec.isDefined("ASDM_SPECTRALWINDOW") && rec.isDefined("ASDM_RECEIVER")){
1254    spwname = rec.asString("ASDM_SPECTRALWINDOW");
1255    recname = rec.asString("ASDM_RECEIVER");
1256  }
1257  else {
1258    // keywords are not there
1259    os << LogIO::WARN
1260       << "Could not find necessary table names in scantable header."
1261       << LogIO::POST;
1262    return false;
1263  }
1264  if (!checkFile(spwname,"directory") || !checkFile(recname,"directory")) {
1265    throw(AipsError("Could not find relevant subtables in MS"));
1266  }
1267  // Get root MS name
1268  string msname;
1269  const String recsuff = "/ASDM_RECEIVER";
1270  String::size_type pos;
1271  pos = recname.size()-recsuff.size();
1272  if (recname.substr(pos) == recsuff)
1273    msname = recname.substr(0, pos);
1274  else
1275    throw(AipsError("Internal error in parsing table name from a scantable keyword."));
1276
1277  if (!checkFile(msname))
1278    throw(AipsError("Internal error in parsing MS name from a scantable keyword."));
1279
1280  return getLo1FromAsisTab(msname, refval, refpix, increment, nChan);
1281
1282};
1283
1284bool STSideBandSep::getLo1FromAsisTab(const string msname,
1285                                      const double refval,
1286                                      const double refpix,
1287                                      const double increment,
1288                                      const int nChan)
1289{
1290  LogIO os(LogOrigin("STSideBandSep","getLo1FromAsisTab()", WHERE));
1291  os << "Searching an LO1 frequency in '" << msname << "'" << LogIO::POST;
1292  // Check for relevant tables.
1293  const string spwname = msname + "/ASDM_SPECTRALWINDOW";
1294  const string recname = msname + "/ASDM_RECEIVER";
1295  if (!checkFile(spwname,"directory") || !checkFile(recname,"directory")) {
1296    throw(AipsError("Could not find relevant tables in MS"));
1297  }
1298
1299  Table spwtab_ = Table(spwname);
1300  String asdmSpw;
1301  ROTableRow spwrow(spwtab_);
1302  const Double rtol = 0.01;
1303  for (uInt idx = 0; idx < spwtab_.nrow(); idx++){
1304    const TableRecord& rec = spwrow.get(idx);
1305    // Compare nchan
1306    if (rec.asInt("numChan") != (Int) nChan)
1307      continue;
1308    // Compare increment
1309    Double asdminc;
1310    Array<Double> incarr = rec.asArrayDouble("chanWidthArray");
1311    if (incarr.size() > 0)
1312      asdminc = incarr(IPosition(1, (uInt) refpix));
1313    else
1314      asdminc = rec.asDouble("chanWidth");
1315    if (abs(asdminc - abs(increment)) > rtol * abs(increment))
1316      continue;
1317    // Compare refval
1318    Double asdmrefv;
1319    Array<Double> refvarr = rec.asArrayDouble("chanFreqArray");
1320    if (refvarr.size() > 0){
1321      const uInt iref = (uInt) refpix;
1322      const Double ratio = refpix - (Double) iref;
1323      asdmrefv = refvarr(IPosition(1, iref))*(1.-ratio)
1324        + refvarr(IPosition(1,iref+1))*ratio;
1325    }
1326    else {
1327      const Double ch0 = rec.asDouble("chanFreqStart");
1328      const Double chstep = rec.asDouble("chanFreqStep");
1329      asdmrefv = ch0 + chstep * refpix;
1330    }
1331    if (abs(asdmrefv - refval) < 0.5*abs(asdminc)){
1332      asdmSpw = rec.asString("spectralWindowId");
1333      break;
1334    }
1335  }
1336
1337  if (asdmSpw.empty()){
1338    os << LogIO::WARN << "Could not find relevant SPW ID in " << spwname << LogIO::POST;
1339    return false;
1340  }
1341  else {
1342    os << asdmSpw << " in " << spwname
1343       << " matches the freqeuncies of signal side band." << LogIO::POST;
1344  }
1345
1346  Table rectab_ = Table(recname);
1347  ROTableRow recrow(rectab_);
1348  for (uInt idx = 0; idx < rectab_.nrow(); idx++){
1349    const TableRecord& rec = recrow.get(idx);
1350    if (rec.asString("spectralWindowId") == asdmSpw){
1351      const Array<Double> loarr = rec.asArrayDouble("freqLO");
1352      lo1Freq_ = loarr(IPosition(1,0));
1353      os << "Found LO1 Frequency in " << recname << ": "
1354         << lo1Freq_ << " [Hz]" << LogIO::POST;
1355      return true;
1356    }
1357  }
1358  os << LogIO::WARN << "Could not find " << asdmSpw << " in " << recname
1359     << LogIO::POST;
1360  return false;
1361};
1362
1363} //namespace asap
Note: See TracBrowser for help on using the repository browser.