Changeset 2726 for trunk/src/STSideBandSep.h

Timestamp:

01/10/13 20:37:28 (11 years ago)

Author:

Kana Sugimoto

Message:

New Development: No

JIRA Issue: Yes (CAS-4141)

Ready for Test: Yes

Interface Changes: Yes

What Interface Changed: moved various set methods in python to c++

Test Programs:

Put in Release Notes: No

Module(s): sbseparator

Description:

Moved set methods in sbseparator module to c++ (STSideBandSep class).
Defined boost python interface methods, set_freq, set_dirtol, set_shift,
set_limit, solve_both, subtract_other to access them from python codes.

File:

• trunk/src/STSideBandSep.h (modified) (4 diffs)

trunk/src/STSideBandSep.h

@@ -36 +36 @@
    * constructors and a destructor
    **/
-  STSideBandSep();
-  //explicit STSideBandSep(const vector<string> infile);
-  //explicit STSideBandSep(const vector<ScantableWrapper> &tables);
+  STSideBandSep() { throw( AipsError("No data set to process") ); };
+  explicit STSideBandSep(const vector<string> &names);
+  explicit STSideBandSep(const vector<ScantableWrapper> &tables);
   virtual ~STSideBandSep();
 
   /**
-   * Set parameters for sideband separation
+   * Set IFNO and frequency tolerance to select data to process
    **/
-  void setFrequency(const unsigned int ifno, const double freqtol, string frame="");
+  void setFrequency(const unsigned int ifno, const string freqtol,
+                    const string frame="");
+
+  /**
+   * Set direction tolerance to group spectra.
+   * The spectra within this range will be averaged before procesing.
+   **/
+  void setDirTolerance(const vector<string> dirtol);
+
+  /**
+   * Set the number of channels shifted in image side band 
+   * of each of scantable.
+   **/
+  void setShift(const vector<double> &shift);
+
+  /**
+   * Set rejection limit of solution.
+   **/
+  void setThreshold(const double limit);
+
+  /**
+   * Resolve both image and signal sideband when true is set.
+   **/
+  void solveBoth(const bool flag) { doboth_ = flag; };
+
+  /**
+   * Obtain spectra by subtracting the solution of the other sideband.
+   **/
+  void solvefromOther(const bool flag) { otherside_ = flag; };
 
   /**
@@ -51 +79 @@
   void setImageTable(const ScantableWrapper &s);
   void setScanTb0(const ScantableWrapper &s);
+
   /**
    * Set additional information to fill frequencies of image sideband
    **/
-  void setLO1(const double lo1, string frame="TOPO", double reftime=-1, string refdir="");
+  void setLO1(const double lo1, const string frame="TOPO",
+              const double reftime=-1, string refdir="");
   void setLO1Root(const string name);
+
   /**
    * Actual calculation of frequencies of image sideband
@@ -62 +93 @@
 
 private:
+  /** Initialize member variables **/
+  void init();
+  void initshift();
+
+  /** Return if the path exists (optionally, check file type) **/
   Bool checkFile(const string name, string type="");
+
+  /** 
+   * Get LO1 frequency to solve the frequencies of image side band
+   **/
   bool getLo1FromAsdm(const string asdmname,
                       const double refval, const double refpix,
@@ -73 +113 @@
                          const double increment, const int nChan);
 
+  /** Member variables **/
+  // input tables
+  vector<string> infileList_;
+  vector< CountedPtr<Scantable> > intabList_;
+  unsigned int ntable_;
+  // frequency and direction setup to select data.
   unsigned int sigIfno_;
-  double ftol_;
+  Quantum<Double> ftol_;
+  MFrequency::Types solFrame_;
+  vector<double> sigShift_, imgShift_;
+  unsigned int nshift_, nchan_;
+  vector< CountedPtr<Scantable> > tableList_;
+  Double xtol_, ytol_;
+  // solution parameters
+  bool otherside_, doboth_;
+  double rejlimit_;
+  // LO1
   double lo1Freq_;
   MFrequency::Types loFrame_;