source: trunk/src/SDMemTable.h@ 393

Last change on this file since 393 was 392, checked in by kil064, 20 years ago

merge SDMemTable::{selectRestFrequcy,setRestFrequencies} into one function,
setRestFrequencies

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.6 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
48
49
50namespace asap {
51
52class SDContainer;
53class SDHeader;
54class SDFrequencyTable;
55
56
57
58
59class SDMemTable {
60public:
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 setCoordInfo(std::vector<string> theinfo);
118
119// Set RestFreqID. source="" and IF=-1 means select all
120 virtual casa::Bool setRestFreqs (const casa::Vector<casa::Double>& restFreqs,
121 const casa::String& unit,
122 const casa::String& source,
123 casa::Int whichIF=-1);
124
125// Get/Set flux unit
126 std::string getFluxUnit() const;
127 void setFluxUnit (const std::string& unit);
128
129// Set Instrument
130 void setInstrument (const std::string& instrument);
131
132 // set the current value
133 virtual bool setIF(casa::Int whichIF=0);
134 virtual bool setBeam(casa::Int whichBeam=0);
135 virtual bool setPol(casa::Int whichPol=0);
136
137 // REset cursor to 0
138 virtual void resetCursor();
139
140 //sets the user mask applied to all spectra
141 virtual bool setMask(std::vector<int> whichChans);
142 // Hard flags the current spectrum, not reversible
143 virtual void flag(int whichRow);
144
145 // return the currently selected values
146 virtual casa::Int getIF() const { return IFSel_; }
147 virtual casa::Int getBeam() const { return beamSel_; }
148 virtual casa::Int getPol() const { return polSel_; }
149
150 // returns unit, conversion frame, doppler, base-frame
151 virtual std::vector<std::string> getCoordInfo() const;
152
153 // number of scans in table
154 virtual casa::Int nScan() const;
155
156 // get a summary of the table
157 virtual std::string summary(bool verbose=false) const;
158
159 std::vector<std::string> history(int whichRow=0) const;
160 bool appendHistory(const std::string& hist, int whichRow=0);
161 // write to disk as aips++ table
162 void makePersistent(const std::string& filename);
163
164 // get a new SDMemTable containing all rows with the same give SCANID
165 SDMemTable getScan(casa::Int scanID) const;
166 SDMemTable getSource(const std::string& source) const;
167
168 const casa::TableRecord& getHeader() const {return table_.keywordSet();}
169 // get a handle to the "raw" aips++ table
170 const casa::Table& table() const { return table_; }
171
172 // return the number of values
173 casa::Int nBeam() const;
174 casa::Int nIF() const;
175 casa::Int nPol() const;
176 casa::Int nChan() const;
177
178 // return the number of rows (integrations) in the table
179 casa::Int nRow() const { return table_.nrow(); }
180
181 // return a row as a Masked array, internally converting uChar flags
182 // to bool mask
183 casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
184 casa::Bool useSelection =
185 casa::False) const;
186
187 // Return SC, setting only the basic construction state (i.e.
188 // no conversion or velocity or rest frequency state).
189 // Specify the index of the FreqID you want
190 casa::SpectralCoordinate getSpectralCoordinate(casa::uInt whichIdx) const;
191
192 // Return SC. Set velocity conversion state (unit,doppler), and
193 // rest frequency. If row number given (>=0), also set
194 // frame conversion layer (needs direction & time which require row)
195 casa::SpectralCoordinate getSpectralCoordinate(casa::uInt freqID,
196 casa::uInt restFreqID,
197 casa::uInt row) const;
198
199 // Set just the reference value, pixel and increment into the table
200 // No other state is extracted.
201 casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
202 casa::uInt whichIdx);
203
204 casa::Int nCoordinates() const;
205
206 std::vector<double> getAbcissa(int whichRow=0) const;
207 std::string getAbcissaString(casa::Int whichRow=0) const;
208
209// Get global reference types
210 casa::MDirection::Types getDirectionReference() const;
211 casa::MEpoch::Types getTimeReference() const;
212
213// Get global antenna position
214 casa::MPosition getAntennaPosition() const;
215
216// Helper function to check instrument (antenna) name and give enum
217 static Instrument convertInstrument(const casa::String& instrument,
218 casa::Bool throwIt);
219
220private:
221 // utility func for nice printout
222 casa::String formatSec(casa::Double x) const;
223 casa::String formatDirection(const casa::MDirection& md) const;
224 void setup();
225 void attach();
226 void renumber();
227 // the current cursor into the array
228 casa::Int IFSel_,beamSel_,polSel_;
229 std::vector<bool> chanMask_;
230 // the underlying memory table
231 casa::Table table_;
232
233// Cached Columns to avoid reconstructing them for each row get/put
234 casa::ScalarColumn<casa::Double> timeCol_, integrCol_;
235 casa::ScalarColumn<casa::Float> azCol_, elCol_, paraCol_;
236 casa::ScalarColumn<casa::String> srcnCol_, fldnCol_, tcaltCol_;
237 casa::ScalarColumn<casa::Int> scanCol_, rbeamCol_;
238 casa::ArrayColumn<casa::Float> specCol_, tsCol_, tcalCol_;
239 casa::ArrayColumn<casa::Double> dirCol_;
240 casa::ArrayColumn<casa::uChar> flagsCol_;
241 casa::ArrayColumn<casa::uInt> freqidCol_, restfreqidCol_;
242 casa::ArrayColumn<casa::String> histCol_;
243};
244
245}// namespace
246#endif
Note: See TracBrowser for help on using the repository browser.