source: trunk/src/ScantableWrapper.h@ 2190

Last change on this file since 2190 was 2189, checked in by WataruKawasaki, 13 years ago

New Development: No

JIRA Issue: Yes CAS-3149

Ready for Test: Yes

Interface Changes: Yes

What Interface Changed: scantable.*_baseline() parameter

Test Programs:

Put in Release Notes: No

Module(s):

Description: Added two parameters 'showprogress' and 'minnrow' to scantable.*_baseline() to enable to show progress status during time-consuming processes.


  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.9 KB
Line 
1//
2// C++ Interface: Scantable
3//
4// Description:
5//
6//
7// Author: Malte Marquarding <asap@atnf.csiro.au>, (C) 2006
8//
9// Copyright: See COPYING file that comes with this distribution
10//
11//
12#ifndef ASAPSCANTABLEWRAPPER_H
13#define ASAPSCANTABLEWRAPPER_H
14
15#include <vector>
16#include <string>
17#include <casa/Arrays/Vector.h>
18
19#include "MathUtils.h"
20#include "STFit.h"
21#include "STFitEntry.h"
22#include "Scantable.h"
23#include "STCoordinate.h"
24
25namespace asap {
26/**
27 * This class contains and wraps a CountedPtr<Scantable>, as the CountedPtr
28 * class does not provide the dor operator which is need for references
29 * in boost::python
30 * see Scantable for interfce description
31 *
32 * @brief The main ASAP data container wrapper
33 * @author Malte Marquarding
34 * @date 2006-02-23
35 * @version 2.0a
36*/
37class ScantableWrapper {
38
39public:
40 explicit ScantableWrapper( const std::string& name,
41 int type=0)
42 {
43 casa::Table::TableType tp = casa::Table::Memory;
44 if ( type == 1 ) tp = casa::Table::Plain;
45 table_ = new Scantable(name, tp);
46 }
47
48 explicit ScantableWrapper(int type=0)
49 {
50 casa::Table::TableType tp = casa::Table::Memory;
51 if ( type == 1) tp = casa::Table::Plain;
52 table_= new Scantable(tp);
53 }
54
55 explicit ScantableWrapper(casa::CountedPtr<Scantable> cp) : table_(cp) {;}
56
57 ScantableWrapper(const ScantableWrapper& mt) :
58 table_(mt.getCP()) {;}
59
60 void assign(const ScantableWrapper& mt)
61 { table_= mt.getCP(); }
62
63 ScantableWrapper copy() {
64 return ScantableWrapper(new Scantable(*(this->getCP()), false));
65 }
66
67 std::vector<float> getSpectrum( int whichrow=0,
68 const std::string& poltype="" ) const {
69 return table_->getSpectrum(whichrow, poltype);
70 }
71 // std::string getPolarizationLabel(bool linear, bool stokes, bool linPol, int polIdx) const {
72 // Boost fails with 4 arguments.
73 std::string getPolarizationLabel(int index, const std::string& ptype) const {
74 return table_->getPolarizationLabel(index, ptype);
75 }
76
77 std::vector<double> getAbcissa(int whichrow=0) const
78 { return table_->getAbcissa(whichrow); }
79
80 std::string getAbcissaLabel(int whichrow=0) const
81 { return table_->getAbcissaLabel(whichrow); }
82
83 float getTsys(int whichrow=0) const
84 { return table_->getTsys(whichrow); }
85
86 std::vector<float> getTsysSpectrum(int whichrow=0) const
87 { return table_->getTsysSpectrum(whichrow); }
88
89 //std::string getTime(int whichrow=0) const
90 // { return table_->getTime(whichrow); }
91 std::string getTime(int whichrow=0, int prec = 0) const
92 { return table_->getTime(whichrow, true, casa::uInt(prec)); }
93
94 double getIntTime(int whichrow=0) const
95 { return table_->getIntTime(whichrow); }
96
97 std::string getDirectionString(int whichrow=0) const
98 { return table_->getDirectionString(whichrow); }
99
100 std::string getFluxUnit() const { return table_->getFluxUnit(); }
101
102 void setFluxUnit(const std::string& unit) { table_->setFluxUnit(unit); }
103
104 void setInstrument(const std::string& name) {table_->setInstrument(name);}
105 void setFeedType(const std::string& ftype) {table_->setFeedType(ftype);}
106
107 std::vector<bool> getMask(int whichrow=0) const
108 { return table_->getMask(whichrow); }
109
110 /**
111 void flag(const std::vector<bool>& msk=std::vector<bool>())
112 { table_->flag(msk); }
113 **/
114 /**
115 void flag(const std::vector<bool>& msk=std::vector<bool>(), bool unflag=false)
116 { table_->flag(msk, unflag); }
117 **/
118 void flag(int whichrow=-1, const std::vector<bool>& msk=std::vector<bool>(), bool unflag=false)
119 { table_->flag(whichrow, msk, unflag); }
120
121 void flagRow(const std::vector<casa::uInt>& rows=std::vector<casa::uInt>(), bool unflag=false)
122 { table_->flagRow(rows, unflag); }
123
124 bool getFlagRow(int whichrow=0) const
125 { return table_->getFlagRow(whichrow); }
126
127 void clip(const casa::Float uthres, const casa::Float dthres, bool clipoutside=true, bool unflag=false)
128 { table_->clip(uthres, dthres, clipoutside, unflag); }
129
130 std::vector<bool> getClipMask(int whichrow, const casa::Float uthres, const casa::Float dthres, bool clipoutside, bool unflag) const
131 { return table_->getClipMask(whichrow, uthres, dthres, clipoutside, unflag); }
132
133 std::string getSourceName(int whichrow=0) const
134 { return table_->getSourceName(whichrow); }
135
136 float getElevation(int whichrow=0) const
137 { return table_->getElevation(whichrow); }
138
139 float getAzimuth(int whichrow=0) const
140 { return table_->getAzimuth(whichrow); }
141
142 float getParAngle(int whichrow=0) const
143 { return table_->getParAngle(whichrow); }
144
145
146 void setSpectrum(std::vector<float> spectrum, int whichrow=0)
147 { table_->setSpectrum(spectrum, whichrow); }
148
149 std::vector<uint> getIFNos() { return table_->getIFNos(); }
150 int getIF(int whichrow) const {return table_->getIF(whichrow);}
151 std::vector<uint> getBeamNos() { return table_->getBeamNos(); }
152 int getBeam(int whichrow) const {return table_->getBeam(whichrow);}
153 std::vector<uint> getPolNos() { return table_->getPolNos(); }
154 int getPol(int whichrow) const {return table_->getPol(whichrow);}
155 int getCycle(int whichrow) const {return table_->getCycle(whichrow);}
156 std::vector<uint> getScanNos() { return table_->getScanNos(); }
157 int getScan(int whichrow) const {return table_->getScan(whichrow);}
158 std::vector<uint> getMolNos() { return table_->getMolNos();}
159
160 STSelector getSelection() const { return table_->getSelection(); }
161 void setSelection(const STSelector& sts)
162 { return table_->setSelection(sts);}
163
164 std::string getPolType() const { return table_->getPolType(); }
165
166 int nif(int scanno=-1) const {return table_->nif(scanno);}
167 int nbeam(int scanno=-1) const {return table_->nbeam(scanno);}
168 int npol(int scanno=-1) const {return table_->npol(scanno);}
169 int nchan(int ifno=-1) const {return table_->nchan(ifno);}
170 int nscan() const {return table_->nscan();}
171 int nrow() const {return table_->nrow();}
172 int ncycle(int scanno) const {return table_->ncycle(scanno);}
173
174 void makePersistent(const std::string& fname)
175 { table_->makePersistent(fname); }
176
177 void setSourceType(int stype)
178 { table_->setSourceType(stype); }
179
180 void shift(int npix)
181 { table_->shift(npix); }
182
183/**
184 commented out by TT
185 void setRestFrequencies(double rf, const std::string& name,
186 const std::string& unit)
187 { table_->setRestFrequencies(rf, name, unit); }
188**/
189 void setRestFrequencies(vector<double> rf, const vector<std::string>& name,
190 const std::string& unit)
191 { table_->setRestFrequencies(rf, name, unit); }
192
193/*
194 void setRestFrequencies(const std::string& name) {
195 table_->setRestFrequencies(name);
196 }
197*/
198
199/*
200 std::vector<double> getRestFrequencies() const
201 { return table_->getRestFrequencies(); }
202*/
203 std::vector<double> getRestFrequency(int id) const
204 { return table_->getRestFrequency(id); }
205
206 void setCoordInfo(std::vector<string> theinfo) {
207 table_->setCoordInfo(theinfo);
208 }
209 std::vector<string> getCoordInfo() const {
210 return table_->getCoordInfo();
211 }
212
213 void setDirection(const std::string& refstr="")
214 { table_->setDirectionRefString(refstr); }
215
216 casa::CountedPtr<Scantable> getCP() const {return table_;}
217 Scantable* getPtr() {return &(*table_);}
218
219 std::string summary() const {
220 return table_->summary();
221 }
222
223 std::string listHeader() const {
224 return table_->headerSummary();
225 }
226
227 std::vector<std::string> getHistory() const
228 { return table_->getHistory(); }
229
230 void addHistory(const std::string& hist)
231 { table_->addHistory(hist); }
232
233 void addFit(const STFitEntry& fit, int row)
234 { table_->addFit(fit, row); }
235
236 STFitEntry getFit(int whichrow) const
237 { return table_->getFit(whichrow); }
238
239 void calculateAZEL() { table_->calculateAZEL(); }
240
241 std::vector<std::string> columnNames() const
242 { return table_->columnNames(); }
243
244 std::string getAntennaName() const
245 { return table_->getAntennaName(); }
246
247 int checkScanInfo(const vector<int>& scanlist) const
248 { return table_->checkScanInfo(scanlist); }
249
250 std::vector<double> getDirectionVector(int whichrow) const
251 { return table_->getDirectionVector(whichrow); }
252
253 void parallactify(bool flag)
254 { table_->parallactify(flag); }
255
256 STCoordinate getCoordinate(int row) {
257 return STCoordinate(table_->getSpectralCoordinate(row));
258 }
259
260 std::vector<float> getWeather(int whichrow) const
261 { return table_->getWeather(whichrow); }
262
263 void reshapeSpectrum( int nmin, int nmax )
264 { table_->reshapeSpectrum( nmin, nmax ); }
265
266 void polyBaseline(const std::vector<bool>& mask, int order, bool getresidual=true, const std::string& showprogress="true,1000", const bool outlog=false, const std::string& blfile="")
267 { table_->polyBaseline(mask, order, getresidual, showprogress, outlog, blfile); }
268
269 void autoPolyBaseline(const std::vector<bool>& mask, int order, const std::vector<int>& edge, float threshold=5.0, int chan_avg_limit=1, bool getresidual=true, const std::string& showprogress="true,1000", const bool outlog=false, const std::string& blfile="")
270 { table_->autoPolyBaseline(mask, order, edge, threshold, chan_avg_limit, getresidual, showprogress, outlog, blfile); }
271
272 void cubicSplineBaseline(const std::vector<bool>& mask, int npiece, float clipthresh, int clipniter, bool getresidual=true, const std::string& showprogress="true,1000", const bool outlog=false, const std::string& blfile="")
273 { table_->cubicSplineBaseline(mask, npiece, clipthresh, clipniter, getresidual, showprogress, outlog, blfile); }
274
275 void autoCubicSplineBaseline(const std::vector<bool>& mask, int npiece, float clipthresh, int clipniter, const std::vector<int>& edge, float threshold=5.0, int chan_avg_limit=1, bool getresidual=true, const std::string& showprogress="true,1000", const bool outlog=false, const std::string& blfile="")
276 { table_->autoCubicSplineBaseline(mask, npiece, clipthresh, clipniter, edge, threshold, chan_avg_limit, getresidual, showprogress, outlog, blfile); }
277
278 void sinusoidBaseline(const std::vector<bool>& mask, const bool applyfft, const std::string& fftmethod, const std::string& fftthresh, const std::vector<int>& addwn, const std::vector<int>& rejwn, float clipthresh, int clipniter, bool getresidual=true, const std::string& showprogress="true,1000", const bool outlog=false, const std::string& blfile="")
279 { table_->sinusoidBaseline(mask, applyfft, fftmethod, fftthresh, addwn, rejwn, clipthresh, clipniter, getresidual, showprogress, outlog, blfile); }
280
281 void autoSinusoidBaseline(const std::vector<bool>& mask, const bool applyfft, const std::string& fftmethod, const std::string& fftthresh, const std::vector<int>& addwn, const std::vector<int>& rejwn, float clipthresh, int clipniter, const std::vector<int>& edge, float threshold=5.0, int chan_avg_limit=1, bool getresidual=true, const std::string& showprogress="true,1000", const bool outlog=false, const std::string& blfile="")
282 { table_->autoSinusoidBaseline(mask, applyfft, fftmethod, fftthresh, addwn, rejwn, clipthresh, clipniter, edge, threshold, chan_avg_limit, getresidual, showprogress, outlog, blfile); }
283
284 float getRms(const std::vector<bool>& mask, int whichrow)
285 { return table_->getRms(mask, whichrow); }
286
287 std::string formatBaselineParams(const std::vector<float>& params, const std::vector<bool>& fixed, float rms, const std::string& masklist, int whichrow, bool verbose=false)
288 { return table_->formatBaselineParams(params, fixed, rms, masklist, whichrow, verbose); }
289
290 std::string formatPiecewiseBaselineParams(const std::vector<int>& ranges, const std::vector<float>& params, const std::vector<bool>& fixed, float rms, const std::string& masklist, int whichrow, bool verbose=false)
291 { return table_->formatPiecewiseBaselineParams(ranges, params, fixed, rms, masklist, whichrow, verbose); }
292
293 bool getFlagtraFast(int whichrow=0) const
294 { return table_->getFlagtraFast(casa::uInt(whichrow)); }
295
296 std::vector<float> execFFT(int whichrow, const std::vector<bool>& mask, bool getRealImag=false, bool getAmplitudeOnly=false)
297 { return table_->execFFT(whichrow, mask, getRealImag, getAmplitudeOnly); }
298
299
300
301private:
302 casa::CountedPtr<Scantable> table_;
303};
304
305} // namespace
306#endif
307
Note: See TracBrowser for help on using the repository browser.