source: trunk/src/SDMemTable.h@ 509

Last change on this file since 509 was 504, checked in by kil064, 20 years ago

remiove pa offset from getStokesSpectrum

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.2 KB
Line 
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
49namespace asap {
50
51class SDContainer;
52class SDHeader;
53class SDFrequencyTable;
54class SDFitTable;
55
56
57
58class SDMemTable {
59public:
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 I,P,PA,V (doPol=True)
101 // (determined by the polSel cursor location 0->3)
102 // 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 over-ridden
107 // with arg. polIdx). If doStokes is False,
108 // returns label for raw correlations (linear or circular). If True returns label for
109 // 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, casa::Int polIdx=-1) const;
112
113 // Convert Stokes to linear or circular polarizations (specified by polIdx=0:3).
114 // Presently, only conversion to RR or LL is supported.
115 virtual std::vector<float> stokesToPolSpectrum (casa::Int whichRow, casa::Bool toLinear,
116 casa::uInt polIdx) const;
117
118 // Get all Stokes at the specified Beam/IF cursor location (ignoring
119 // the internal cursor). -1 means all on that axis. Really, this function
120 // should not be here, and the SDContainer should hold the stokes spectrum
121 // as well. However, because the Stokes column is virtual, and its shape
122 // is not the same as nPol(), I have put it here for direct access as needed
123 virtual casa::Array<casa::Float> getStokesSpectrum(casa::Int whichRow=0,
124 casa::Int iBeam=-1,
125 casa::Int iIF=-1) const;
126
127 // Get Tsys at cursor location
128 virtual casa::Float getTsys(casa::Int whichRow=0) const;
129
130 // get all as aips++ Vectors
131 virtual void getSpectrum(casa::Vector<casa::Float>& spectrum,
132 casa::Int whichRow=0) const;
133 //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const;
134
135 // Get rest frequencies
136 std::vector<double> getRestFreqs() const;
137
138 // get info for current row
139 // if whichRow == -1 the Header time is given
140 std::string getTime(casa::Int whichRow=0,
141 casa::Bool showDate=casa::False) const ;
142 casa::MEpoch getEpoch(casa::Int whichRow=0) const;
143 casa::MDirection getDirection(casa::Int whichRow=0,
144 casa::Bool refBeam=casa::False) const;
145
146 std::string getSourceName(casa::Int whichRow=0) const;
147 double getInterval(casa::Int whichRow=0) const;
148
149 virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0);
150 virtual void setCoordInfo(std::vector<string> theinfo);
151
152 // Set RestFreqID. source="" and IF=-1 means select all
153 virtual casa::Bool setRestFreqs(const casa::Vector<casa::Double>& restFreqs,
154 const casa::String& unit,
155 const std::vector<std::string>& lines,
156 const casa::String& source,
157 casa::Int whichIF=-1);
158
159 // List lines
160 void spectralLines() const;
161
162 // Get/Set flux unit
163 std::string getFluxUnit() const;
164 void setFluxUnit (const std::string& unit);
165
166 // Set Instrument
167 void setInstrument (const std::string& instrument);
168
169 // set the current value
170 virtual bool setIF(casa::Int whichIF=0);
171 virtual bool setBeam(casa::Int whichBeam=0);
172 virtual bool setPol(casa::Int whichPol=0);
173
174 // REset cursor to 0
175 virtual void resetCursor();
176
177 //sets the user mask applied to all spectra
178 virtual bool setMask(std::vector<int> whichChans);
179 // Hard flags the current spectrum, not reversible
180 virtual void flag(int whichRow);
181
182 // return the currently selected values
183 virtual casa::Int getIF() const { return IFSel_; }
184 virtual casa::Int getBeam() const { return beamSel_; }
185 virtual casa::Int getPol() const { return polSel_; }
186
187 // returns unit, conversion frame, doppler, base-frame
188 virtual std::vector<std::string> getCoordInfo() const;
189
190 // number of scans in table
191 virtual casa::Int nScan() const;
192
193 // get a summary of the table
194 virtual std::string summary(bool verbose=false) const;
195
196 // get/set the history
197 std::vector<std::string> getHistory() const;
198 void addHistory(const std::string& hist);
199
200 casa::Table getHistoryTable() const;
201 void appendToHistoryTable(const casa::Table& otherHist);
202
203 // write to disk as aips++ table
204 void makePersistent(const std::string& filename);
205
206 // get a new SDMemTable containing all rows with the same give SCANID
207 SDMemTable getScan(casa::Int scanID) const;
208 SDMemTable getSource(const std::string& source) const;
209
210 const casa::TableRecord& getHeader() const {return table_.keywordSet();}
211 // get a handle to the "raw" aips++ table
212 const casa::Table& table() const { return table_; }
213
214 // return the number of values
215 casa::Int nBeam() const;
216 casa::Int nIF() const;
217 casa::Int nPol() const;
218 casa::Int nChan() const;
219
220 // return the number of rows (integrations) in the table
221 casa::Int nRow() const { return table_.nrow(); }
222
223 // return a row as a Masked array, internally converting uChar flags
224 // to bool mask
225 casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
226 casa::Bool toStokes=casa::False) const;
227
228 // Return SC, setting only the basic construction state (i.e.
229 // no conversion or velocity or rest frequency state).
230 // Specify the index of the FreqID you want
231 casa::SpectralCoordinate getSpectralCoordinate(casa::uInt whichIdx) const;
232
233 // Return SC. Set velocity conversion state (unit,doppler), and
234 // rest frequency. If row number given (>=0), also set
235 // frame conversion layer (needs direction & time which require row)
236 casa::SpectralCoordinate getSpectralCoordinate(casa::uInt freqID,
237 casa::uInt restFreqID,
238 casa::uInt row) const;
239
240 // Set just the reference value, pixel and increment into the table
241 // No other state is extracted.
242 casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
243 casa::uInt whichIdx);
244
245 casa::Int nCoordinates() const;
246
247 std::vector<double> getAbcissa(int whichRow=0) const;
248 std::string getAbcissaString(casa::Int whichRow=0) const;
249
250// Get global reference types
251 casa::MDirection::Types getDirectionReference() const;
252 casa::MEpoch::Types getTimeReference() const;
253
254// Get global antenna position
255 casa::MPosition getAntennaPosition() const;
256
257 bool putSDFitTable(const SDFitTable& sdft);
258 SDFitTable getSDFitTable() const;
259 SDFitTable getSDFitTable(casa::uInt whichRow) const;
260
261 void addFit(casa::uInt whichRow,
262 const casa::Vector<casa::Double>& p,
263 const casa::Vector<casa::Bool>& m,
264 const casa::Vector<casa::String>& f,
265 const casa::Vector<casa::Int>& c);
266
267
268private:
269 // utility func for nice printout
270 casa::String formatSec(casa::Double x) const;
271 casa::String formatDirection(const casa::MDirection& md) const;
272 std::vector<float> getFloatSpectrum(const casa::Array<casa::Float>& arr) const;
273 void setup();
274 void attach();
275 void renumber();
276
277 // Generate start and end for shape and current cursor selection
278 void getCursorSlice(casa::IPosition& start, casa::IPosition& end,
279 const casa::IPosition& shape) const;
280
281 // the current cursor into the array
282 casa::Int IFSel_,beamSel_,polSel_;
283 std::vector<bool> chanMask_;
284 // the underlying memory table
285 casa::Table table_;
286 // The current table version
287 static const casa::uInt version_ = 1;
288
289 // Cached Columns to avoid reconstructing them for each row get/put
290 casa::ScalarColumn<casa::Double> timeCol_, integrCol_;
291 casa::ScalarColumn<casa::Float> azCol_, elCol_, paraCol_;
292 casa::ScalarColumn<casa::String> srcnCol_, fldnCol_, tcaltCol_;
293 casa::ScalarColumn<casa::Int> scanCol_, rbeamCol_;
294 casa::ArrayColumn<casa::Float> specCol_, tsCol_, tcalCol_;
295 casa::ArrayColumn<casa::Double> dirCol_;
296 casa::ArrayColumn<casa::uChar> flagsCol_;
297 casa::ArrayColumn<casa::uInt> freqidCol_, restfreqidCol_;
298 casa::ArrayColumn<casa::String> histCol_;
299 casa::ArrayColumn<casa::Int> fitCol_;
300 casa::ROArrayColumn<casa::Float> stokesCol_;
301};
302
303}// namespace
304#endif
Note: See TracBrowser for help on using the repository browser.