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 |
|
---|
48 |
|
---|
49 |
|
---|
50 | namespace asap {
|
---|
51 |
|
---|
52 | class SDContainer;
|
---|
53 | class SDHeader;
|
---|
54 | class SDFrequencyTable;
|
---|
55 |
|
---|
56 |
|
---|
57 |
|
---|
58 |
|
---|
59 | class SDMemTable {
|
---|
60 | public:
|
---|
61 | // create a new (empty) SDMemTable
|
---|
62 | SDMemTable();
|
---|
63 | // create a SDMemTable from an (aips++) table on disk
|
---|
64 | SDMemTable(const std::string& name);
|
---|
65 |
|
---|
66 | // Copy Construct a SDMemTable, if clear==True only header and
|
---|
67 | // skeleton are copied, otherwise the whole table is copied.
|
---|
68 | SDMemTable(const SDMemTable& other, casa::Bool clear=casa::False);
|
---|
69 |
|
---|
70 | // Copy Construct (copy semantics) a SDMemTable, give a scanid constraint
|
---|
71 | // see also getScan()
|
---|
72 | SDMemTable(const casa::Table& tab, const std::string& expr);
|
---|
73 |
|
---|
74 | // Assignment operator (copy semantics)
|
---|
75 | SDMemTable &operator=(const SDMemTable& other);
|
---|
76 |
|
---|
77 | virtual ~SDMemTable();
|
---|
78 |
|
---|
79 | // put data from meta conatiner into the table
|
---|
80 | bool putSDContainer(const SDContainer& sdc);
|
---|
81 | bool putSDHeader(const SDHeader& sdh);
|
---|
82 | bool putSDFreqTable(const SDFrequencyTable& sdft);
|
---|
83 |
|
---|
84 | //get the data wrapped up in a meta container
|
---|
85 |
|
---|
86 | SDContainer getSDContainer(casa::uInt whichRow=0) const;
|
---|
87 | SDHeader getSDHeader() const;
|
---|
88 |
|
---|
89 | // Get SD Frequency table.
|
---|
90 | SDFrequencyTable getSDFreqTable() const;
|
---|
91 |
|
---|
92 | // get spectrum,mask and tsys for the given row, at the selected
|
---|
93 | // cursor - all as stl vectors
|
---|
94 | virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const;
|
---|
95 | virtual std::vector<bool> getMask(casa::Int whichRow=0) const;
|
---|
96 |
|
---|
97 | virtual casa::Float getTsys(casa::Int whichRow=0) const;
|
---|
98 | // get all as aips++ Vectors
|
---|
99 | virtual void getSpectrum(casa::Vector<casa::Float>& spectrum,
|
---|
100 | casa::Int whichRow=0) const;
|
---|
101 |
|
---|
102 | //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const;
|
---|
103 | std::vector<double> getRestFreqs() const;
|
---|
104 |
|
---|
105 | // get info for current row
|
---|
106 | // if whichRow == -1 the Header time is given
|
---|
107 | std::string getTime(casa::Int whichRow=0,
|
---|
108 | casa::Bool showDate=casa::False) const ;
|
---|
109 | casa::MEpoch getEpoch(casa::Int whichRow=0) const;
|
---|
110 | casa::MDirection getDirection(casa::Int whichRow=0,
|
---|
111 | casa::Bool refBeam=casa::False) const;
|
---|
112 | //
|
---|
113 | std::string getSourceName(casa::Int whichRow=0) const;
|
---|
114 | double getInterval(casa::Int whichRow=0) const;
|
---|
115 |
|
---|
116 | virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0);
|
---|
117 | virtual void setRestFreqs(std::vector<double> freqs,
|
---|
118 | const std::string& theunit);
|
---|
119 | virtual void setCoordInfo(std::vector<string> theinfo);
|
---|
120 |
|
---|
121 | // Select RestFreqID. FInds the restFreq ID for specified restFreq,
|
---|
122 | // and updates RESTFREQID column of table for specified IF index
|
---|
123 | // (-1 means all IFs) and source combination
|
---|
124 | virtual casa::Bool selectRestFreq (casa::Double restFreq, const casa::String& unit,
|
---|
125 | const casa::String& source,
|
---|
126 | casa::Int whichIF=-1);
|
---|
127 |
|
---|
128 | // Get/Set flux unit
|
---|
129 | std::string getFluxUnit() const;
|
---|
130 | void setFluxUnit (const std::string& unit);
|
---|
131 |
|
---|
132 | // Set Instrument
|
---|
133 | void setInstrument (const std::string& instrument);
|
---|
134 |
|
---|
135 | // set the current value
|
---|
136 | virtual bool setIF(casa::Int whichIF=0);
|
---|
137 | virtual bool setBeam(casa::Int whichBeam=0);
|
---|
138 | virtual bool setPol(casa::Int whichPol=0);
|
---|
139 |
|
---|
140 | // REset cursor to 0
|
---|
141 | virtual void resetCursor();
|
---|
142 |
|
---|
143 | //sets the user mask applied to all spectra
|
---|
144 | virtual bool setMask(std::vector<int> whichChans);
|
---|
145 | // Hard flags the current spectrum, not reversible
|
---|
146 | virtual void flag(int whichRow);
|
---|
147 |
|
---|
148 | // return the currently selected values
|
---|
149 | virtual casa::Int getIF() const { return IFSel_; }
|
---|
150 | virtual casa::Int getBeam() const { return beamSel_; }
|
---|
151 | virtual casa::Int getPol() const { return polSel_; }
|
---|
152 |
|
---|
153 | // returns unit, conversion frame, doppler, base-frame
|
---|
154 | virtual std::vector<std::string> getCoordInfo() const;
|
---|
155 |
|
---|
156 | // number of scans in table
|
---|
157 | virtual casa::Int nScan() const;
|
---|
158 |
|
---|
159 | // get a summary of the table
|
---|
160 | virtual std::string summary(bool verbose=false) const;
|
---|
161 |
|
---|
162 | std::vector<std::string> history(int whichRow=0) const;
|
---|
163 | bool appendHistory(const std::string& hist, int whichRow=0);
|
---|
164 | // write to disk as aips++ table
|
---|
165 | void makePersistent(const std::string& filename);
|
---|
166 |
|
---|
167 | // get a new SDMemTable containing all rows with the same give SCANID
|
---|
168 | SDMemTable getScan(casa::Int scanID) const;
|
---|
169 | SDMemTable getSource(const std::string& source) const;
|
---|
170 |
|
---|
171 | const casa::TableRecord& getHeader() const {return table_.keywordSet();}
|
---|
172 | // get a handle to the "raw" aips++ table
|
---|
173 | const casa::Table& table() const { return table_; }
|
---|
174 |
|
---|
175 | // return the number of values
|
---|
176 | casa::Int nBeam() const;
|
---|
177 | casa::Int nIF() const;
|
---|
178 | casa::Int nPol() const;
|
---|
179 | casa::Int nChan() const;
|
---|
180 |
|
---|
181 | // return the number of rows (integrations) in the table
|
---|
182 | casa::Int nRow() const { return table_.nrow(); }
|
---|
183 |
|
---|
184 | // return a row as a Masked array, internally converting uChar flags
|
---|
185 | // to bool mask
|
---|
186 | casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
|
---|
187 | casa::Bool useSelection =
|
---|
188 | casa::False) const;
|
---|
189 |
|
---|
190 | // Return SC, setting only the basic construction state (i.e.
|
---|
191 | // no conversion or velocity or rest frequency state).
|
---|
192 | // Specify the index of the FreqID you want
|
---|
193 | casa::SpectralCoordinate getSpectralCoordinate(casa::uInt whichIdx) const;
|
---|
194 |
|
---|
195 | // Return SC. Set velocity conversion state (unit,doppler), and
|
---|
196 | // rest frequency. If row number given (>=0), also set
|
---|
197 | // frame conversion layer (needs direction & time which require row)
|
---|
198 | casa::SpectralCoordinate getSpectralCoordinate(casa::uInt freqID,
|
---|
199 | casa::uInt restFreqID,
|
---|
200 | casa::uInt row) const;
|
---|
201 |
|
---|
202 | // Set just the reference value, pixel and increment into the table
|
---|
203 | // No other state is extracted.
|
---|
204 | casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
|
---|
205 | casa::uInt whichIdx);
|
---|
206 |
|
---|
207 | casa::Int nCoordinates() const;
|
---|
208 |
|
---|
209 | std::vector<double> getAbcissa(int whichRow=0) const;
|
---|
210 | std::string getAbcissaString(casa::Int whichRow=0) const;
|
---|
211 |
|
---|
212 | // Get global reference types
|
---|
213 | casa::MDirection::Types getDirectionReference() const;
|
---|
214 | casa::MEpoch::Types getTimeReference() const;
|
---|
215 |
|
---|
216 | // Get global antenna position
|
---|
217 | casa::MPosition getAntennaPosition() const;
|
---|
218 |
|
---|
219 | // Helper function to check instrument (antenna) name and give enum
|
---|
220 | static Instrument convertInstrument(const casa::String& instrument,
|
---|
221 | casa::Bool throwIt);
|
---|
222 |
|
---|
223 | private:
|
---|
224 | // utility func for nice printout
|
---|
225 | casa::String formatSec(casa::Double x) const;
|
---|
226 | casa::String formatDirection(const casa::MDirection& md) const;
|
---|
227 | void setup();
|
---|
228 | void attach();
|
---|
229 | void renumber();
|
---|
230 | // the current cursor into the array
|
---|
231 | casa::Int IFSel_,beamSel_,polSel_;
|
---|
232 | std::vector<bool> chanMask_;
|
---|
233 | // the underlying memory table
|
---|
234 | casa::Table table_;
|
---|
235 |
|
---|
236 | // Cached Columns to avoid reconstructing them for each row get/put
|
---|
237 | casa::ScalarColumn<casa::Double> timeCol_, integrCol_;
|
---|
238 | casa::ScalarColumn<casa::Float> azCol_, elCol_, paraCol_;
|
---|
239 | casa::ScalarColumn<casa::String> srcnCol_, fldnCol_, tcaltCol_;
|
---|
240 | casa::ScalarColumn<casa::Int> scanCol_, rbeamCol_;
|
---|
241 | casa::ArrayColumn<casa::Float> specCol_, tsCol_, tcalCol_;
|
---|
242 | casa::ArrayColumn<casa::Double> dirCol_;
|
---|
243 | casa::ArrayColumn<casa::uChar> flagsCol_;
|
---|
244 | casa::ArrayColumn<casa::uInt> freqidCol_, restfreqidCol_;
|
---|
245 | casa::ArrayColumn<casa::String> histCol_;
|
---|
246 | };
|
---|
247 |
|
---|
248 | }// namespace
|
---|
249 | #endif
|
---|