1 | //#--------------------------------------------------------------------------- |
---|
2 | //# SDMemTable.h: A MemoryTable container for single dish integrations |
---|
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: |
---|
30 | //#--------------------------------------------------------------------------- |
---|
31 | #ifndef SDMEMTABLE_H |
---|
32 | #define SDMEMTABLE_H |
---|
33 | |
---|
34 | // STL |
---|
35 | #include <string> |
---|
36 | #include <vector> |
---|
37 | // AIPS++ |
---|
38 | #include <casa/aips.h> |
---|
39 | #include <casa/Arrays/MaskedArray.h> |
---|
40 | #include <casa/BasicSL/String.h> |
---|
41 | #include <coordinates/Coordinates/SpectralCoordinate.h> |
---|
42 | #include <tables/Tables/Table.h> |
---|
43 | #include <tables/Tables/ArrayColumn.h> |
---|
44 | #include <tables/Tables/ScalarColumn.h> |
---|
45 | |
---|
46 | #include "SDDefs.h" |
---|
47 | #include "SDFitTable.h" |
---|
48 | |
---|
49 | namespace asap { |
---|
50 | |
---|
51 | class SDContainer; |
---|
52 | class SDHeader; |
---|
53 | class SDFrequencyTable; |
---|
54 | class SDFitTable; |
---|
55 | |
---|
56 | |
---|
57 | |
---|
58 | class SDMemTable { |
---|
59 | public: |
---|
60 | // create a new (empty) SDMemTable |
---|
61 | SDMemTable(); |
---|
62 | // create a SDMemTable from an (aips++) table on disk |
---|
63 | SDMemTable(const std::string& name); |
---|
64 | |
---|
65 | // Copy Construct a SDMemTable, if clear==True only header and |
---|
66 | // skeleton are copied, otherwise the whole table is copied. |
---|
67 | SDMemTable(const SDMemTable& other, casa::Bool clear=casa::False); |
---|
68 | |
---|
69 | // Copy Construct (copy semantics) a SDMemTable, give a scanid constraint |
---|
70 | // see also getScan() |
---|
71 | SDMemTable(const casa::Table& tab, const std::string& expr); |
---|
72 | |
---|
73 | // Assignment operator (copy semantics) |
---|
74 | SDMemTable &operator=(const SDMemTable& other); |
---|
75 | |
---|
76 | virtual ~SDMemTable(); |
---|
77 | |
---|
78 | // put data from meta conatiner into the table |
---|
79 | bool putSDContainer(const SDContainer& sdc); |
---|
80 | bool putSDHeader(const SDHeader& sdh); |
---|
81 | bool putSDFreqTable(const SDFrequencyTable& sdft); |
---|
82 | |
---|
83 | //get the data wrapped up in a meta container |
---|
84 | |
---|
85 | SDContainer getSDContainer(casa::uInt whichRow=0) const; |
---|
86 | SDHeader getSDHeader() const; |
---|
87 | |
---|
88 | // Get SD Frequency table. |
---|
89 | SDFrequencyTable getSDFreqTable() const; |
---|
90 | |
---|
91 | // get spectrum,mask and tsys for the given row, at the selected |
---|
92 | // cursor - all as stl vectors |
---|
93 | virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const; |
---|
94 | virtual std::vector<bool> getMask(casa::Int whichRow=0) const; |
---|
95 | |
---|
96 | // Get length of STokes spectrum. XX & YY -> I |
---|
97 | // Anything else the length stays the same. |
---|
98 | int nStokes() const; |
---|
99 | |
---|
100 | // Get specific Stokes at cursor location. One of either I,Q,U,V or |
---|
101 | // I,P,PA,V (doPol=True) (determined by the polSel cursor location |
---|
102 | // 0->3) If the latter, you can add a PA offset (degrees) |
---|
103 | virtual std::vector<float> getStokesSpectrum(casa::Int whichRow=0, |
---|
104 | casa::Bool doPol=casa::False) const; |
---|
105 | |
---|
106 | // Returns Label for polarization selected by polSel_ (or |
---|
107 | // over-ridden with arg. polIdx). If doStokes is False, returns |
---|
108 | // label for raw correlations (linear or circular). If True returns |
---|
109 | // label for Stokes. If doPol=False, I,Q,U,V else I,P,PA,V |
---|
110 | std::string getPolarizationLabel(casa::Bool linear, casa::Bool stokes, |
---|
111 | casa::Bool linPol, |
---|
112 | casa::Int polIdx=-1) const; |
---|
113 | |
---|
114 | // Convert Stokes to linear or circular polarizations (specified by |
---|
115 | // polIdx=0:3). Presently, only conversion to RR or LL is |
---|
116 | // supported. |
---|
117 | virtual std::vector<float> stokesToPolSpectrum(casa::Int whichRow, |
---|
118 | casa::Bool toLinear, |
---|
119 | casa::Int polIdx) const; |
---|
120 | |
---|
121 | // Get all Stokes at the specified Beam/IF cursor location (ignoring |
---|
122 | // the internal cursor). -1 means all on that axis. Really, this function |
---|
123 | // should not be here, and the SDContainer should hold the stokes spectrum |
---|
124 | // as well. However, because the Stokes column is virtual, and its shape |
---|
125 | // is not the same as nPol(), I have put it here for direct access as needed |
---|
126 | virtual casa::Array<casa::Float> getStokesSpectrum(casa::Int whichRow=0, |
---|
127 | casa::Int iBeam=-1, |
---|
128 | casa::Int iIF=-1) const; |
---|
129 | |
---|
130 | // Get Tsys at cursor location |
---|
131 | virtual casa::Float getTsys(casa::Int whichRow=0) const; |
---|
132 | |
---|
133 | // get all as aips++ Vectors |
---|
134 | virtual void getSpectrum(casa::Vector<casa::Float>& spectrum, |
---|
135 | casa::Int whichRow=0) const; |
---|
136 | //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const; |
---|
137 | |
---|
138 | // Get rest frequencies |
---|
139 | std::vector<double> getRestFreqs() const; |
---|
140 | |
---|
141 | // get info for current row |
---|
142 | // if whichRow == -1 the Header time is given |
---|
143 | std::string getTime(casa::Int whichRow=0, |
---|
144 | casa::Bool showDate=casa::False) const ; |
---|
145 | casa::MEpoch getEpoch(casa::Int whichRow=0) const; |
---|
146 | casa::MDirection getDirection(casa::Int whichRow=0, |
---|
147 | casa::Bool refBeam=casa::False) const; |
---|
148 | |
---|
149 | std::string getSourceName(casa::Int whichRow=0) const; |
---|
150 | double getInterval(casa::Int whichRow=0) const; |
---|
151 | |
---|
152 | virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0); |
---|
153 | virtual void setCoordInfo(std::vector<string> theinfo); |
---|
154 | |
---|
155 | // Set RestFreqID. source="" and IF=-1 means select all |
---|
156 | virtual casa::Bool setRestFreqs(const casa::Vector<casa::Double>& restFreqs, |
---|
157 | const casa::String& unit, |
---|
158 | const std::vector<std::string>& lines, |
---|
159 | const casa::String& source, |
---|
160 | casa::Int whichIF=-1); |
---|
161 | |
---|
162 | // List lines |
---|
163 | void spectralLines() const; |
---|
164 | |
---|
165 | // Get/Set flux unit |
---|
166 | std::string getFluxUnit() const; |
---|
167 | void setFluxUnit (const std::string& unit); |
---|
168 | |
---|
169 | // Set Instrument |
---|
170 | void setInstrument (const std::string& instrument); |
---|
171 | |
---|
172 | // set the current value |
---|
173 | virtual bool setIF(casa::Int whichIF=0); |
---|
174 | virtual bool setBeam(casa::Int whichBeam=0); |
---|
175 | virtual bool setPol(casa::Int whichPol=0); |
---|
176 | |
---|
177 | // REset cursor to 0 |
---|
178 | virtual void resetCursor(); |
---|
179 | |
---|
180 | //sets the user mask applied to all spectra |
---|
181 | virtual bool setMask(std::vector<int> whichChans); |
---|
182 | // Hard flags the current spectrum, not reversible |
---|
183 | virtual void flag(int whichRow); |
---|
184 | |
---|
185 | // return the currently selected values |
---|
186 | virtual casa::Int getIF() const { return IFSel_; } |
---|
187 | virtual casa::Int getBeam() const { return beamSel_; } |
---|
188 | virtual casa::Int getPol() const { return polSel_; } |
---|
189 | |
---|
190 | // returns unit, conversion frame, doppler, base-frame |
---|
191 | virtual std::vector<std::string> getCoordInfo() const; |
---|
192 | |
---|
193 | // number of scans in table |
---|
194 | virtual casa::Int nScan() const; |
---|
195 | |
---|
196 | // get a summary of the table |
---|
197 | virtual std::string summary(bool verbose=false) const; |
---|
198 | |
---|
199 | // get/set the history |
---|
200 | std::vector<std::string> getHistory() const; |
---|
201 | void addHistory(const std::string& hist); |
---|
202 | |
---|
203 | casa::Table getHistoryTable() const; |
---|
204 | void appendToHistoryTable(const casa::Table& otherHist); |
---|
205 | |
---|
206 | // write to disk as aips++ table |
---|
207 | void makePersistent(const std::string& filename); |
---|
208 | |
---|
209 | // get a new SDMemTable containing all rows with the same give SCANID |
---|
210 | SDMemTable getScan(casa::Int scanID) const; |
---|
211 | SDMemTable getSource(const std::string& source) const; |
---|
212 | |
---|
213 | const casa::TableRecord& getHeader() const {return table_.keywordSet();} |
---|
214 | // get a handle to the "raw" aips++ table |
---|
215 | const casa::Table& table() const { return table_; } |
---|
216 | |
---|
217 | // return the number of values |
---|
218 | casa::Int nBeam() const; |
---|
219 | casa::Int nIF() const; |
---|
220 | casa::Int nPol() const; |
---|
221 | casa::Int nChan() const; |
---|
222 | |
---|
223 | // return the number of rows (integrations) in the table |
---|
224 | casa::Int nRow() const { return table_.nrow(); } |
---|
225 | |
---|
226 | // return a row as a Masked array, internally converting uChar flags |
---|
227 | // to bool mask |
---|
228 | casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow, |
---|
229 | casa::Bool toStokes=casa::False) const; |
---|
230 | |
---|
231 | // Return SC, setting only the basic construction state (i.e. |
---|
232 | // no conversion or velocity or rest frequency state). |
---|
233 | // Specify the index of the FreqID you want |
---|
234 | casa::SpectralCoordinate getSpectralCoordinate(casa::uInt whichIdx) const; |
---|
235 | |
---|
236 | // Return SC. Set velocity conversion state (unit,doppler), and |
---|
237 | // rest frequency. If row number given (>=0), also set |
---|
238 | // frame conversion layer (needs direction & time which require row) |
---|
239 | casa::SpectralCoordinate getSpectralCoordinate(casa::uInt freqID, |
---|
240 | casa::uInt restFreqID, |
---|
241 | casa::uInt row) const; |
---|
242 | |
---|
243 | // Set just the reference value, pixel and increment into the table |
---|
244 | // No other state is extracted. |
---|
245 | casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord, |
---|
246 | casa::uInt whichIdx); |
---|
247 | |
---|
248 | casa::Int nCoordinates() const; |
---|
249 | |
---|
250 | std::vector<double> getAbcissa(int whichRow=0) const; |
---|
251 | std::string getAbcissaString(casa::Int whichRow=0) const; |
---|
252 | |
---|
253 | // Get global reference types |
---|
254 | casa::MDirection::Types getDirectionReference() const; |
---|
255 | casa::MEpoch::Types getTimeReference() const; |
---|
256 | |
---|
257 | // Get global antenna position |
---|
258 | casa::MPosition getAntennaPosition() const; |
---|
259 | |
---|
260 | bool putSDFitTable(const SDFitTable& sdft); |
---|
261 | SDFitTable getSDFitTable() const; |
---|
262 | SDFitTable getSDFitTable(casa::uInt whichRow) const; |
---|
263 | |
---|
264 | void addFit(casa::uInt whichRow, |
---|
265 | const casa::Vector<casa::Double>& p, |
---|
266 | const casa::Vector<casa::Bool>& m, |
---|
267 | const casa::Vector<casa::String>& f, |
---|
268 | const casa::Vector<casa::Int>& c); |
---|
269 | |
---|
270 | |
---|
271 | private: |
---|
272 | // utility func for nice printout |
---|
273 | casa::String formatSec(casa::Double x) const; |
---|
274 | casa::String formatDirection(const casa::MDirection& md) const; |
---|
275 | std::vector<float> getFloatSpectrum(const casa::Array<casa::Float>& arr) const; |
---|
276 | void setup(); |
---|
277 | void attach(); |
---|
278 | void renumber(); |
---|
279 | |
---|
280 | // Generate start and end for shape and current cursor selection |
---|
281 | void getCursorSlice(casa::IPosition& start, casa::IPosition& end, |
---|
282 | const casa::IPosition& shape) const; |
---|
283 | |
---|
284 | // the current cursor into the array |
---|
285 | casa::Int IFSel_,beamSel_,polSel_; |
---|
286 | std::vector<bool> chanMask_; |
---|
287 | // the underlying memory table |
---|
288 | casa::Table table_; |
---|
289 | // The current table version |
---|
290 | static const casa::uInt version_ = 1; |
---|
291 | |
---|
292 | // Cached Columns to avoid reconstructing them for each row get/put |
---|
293 | casa::ScalarColumn<casa::Double> timeCol_, integrCol_; |
---|
294 | casa::ScalarColumn<casa::Float> azCol_, elCol_, paraCol_; |
---|
295 | casa::ScalarColumn<casa::String> srcnCol_, fldnCol_, tcaltCol_; |
---|
296 | casa::ScalarColumn<casa::Int> scanCol_, rbeamCol_; |
---|
297 | casa::ArrayColumn<casa::Float> specCol_, tsCol_, tcalCol_; |
---|
298 | casa::ArrayColumn<casa::Double> dirCol_; |
---|
299 | casa::ArrayColumn<casa::uChar> flagsCol_; |
---|
300 | casa::ArrayColumn<casa::uInt> freqidCol_, restfreqidCol_; |
---|
301 | casa::ArrayColumn<casa::String> histCol_; |
---|
302 | casa::ArrayColumn<casa::Int> fitCol_; |
---|
303 | casa::ROArrayColumn<casa::Float> stokesCol_; |
---|
304 | }; |
---|
305 | |
---|
306 | }// namespace |
---|
307 | #endif |
---|