source: trunk/src/SDMemTable.h@ 474

Last change on this file since 474 was 472, checked in by kil064, 20 years ago

add a new getStokesSPectrum function (for the writer) which gets all
Stokes or a beam/IF slice

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