source: trunk/src/SDMemTable.h@ 301

Last change on this file since 301 was 293, checked in by kil064, 20 years ago

better documentation for a couple of functions

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.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/BasicSL/String.h>
40#include <tables/Tables/Table.h>
41#include <casa/Arrays/MaskedArray.h>
42#include "SDDefs.h"
43
44#include <coordinates/Coordinates/SpectralCoordinate.h>
45
46namespace asap {
47
48class SDContainer;
49class SDHeader;
50class SDFrequencyTable;
51
52
53class SDMemTable {
54public:
55 // create a new (empty) SDMemTable
56 SDMemTable();
57 // create a SDMemTable from an (aips++) table on disk
58 SDMemTable(const std::string& name);
59
60 // Copy Construct a SDMemTable, if clear==True only header and
61 // skeleton are copied, otherwise the whole table is copied.
62 SDMemTable(const SDMemTable& other, casa::Bool clear=casa::False);
63
64 // Copy Construct (copy semantics) a SDMemTable, give a scanid constraint
65 // see also getScan()
66 SDMemTable(const casa::Table& tab, const std::string& expr);
67
68 // Assignment operator (copy semantics)
69 SDMemTable &operator=(const SDMemTable& other);
70
71 virtual ~SDMemTable();
72
73 // put data from meta conatiner into the table
74 bool putSDContainer(const SDContainer& sdc);
75 bool putSDHeader(const SDHeader& sdh);
76 bool putSDFreqTable(const SDFrequencyTable& sdft);
77
78 //get the data wrapped up in a meta container
79 SDContainer getSDContainer(casa::uInt whichRow=0) const;
80 SDHeader getSDHeader() const;
81
82 // Get SD Frequency table. Note that this function is largely
83 // unimplemented. Only the number of freqIDs is filled in presently.
84 SDFrequencyTable getSDFreqTable() const;
85 // get spectrum,mask and tsys for the given row, at the selected
86 // cursor - all as stl vectors
87 virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const;
88 virtual std::vector<bool> getMask(casa::Int whichRow=0) const;
89
90 virtual casa::Float getTsys(casa::Int whichRow=0) const;
91 // get all as aips++ Vectors
92 virtual void getSpectrum(casa::Vector<casa::Float>& spectrum,
93 casa::Int whichRow=0) const;
94
95 //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const;
96 std::vector<double> getRestFreqs() const;
97
98 // get info for current row
99 // if whichRow == -1 the Header time is given
100 std::string getTime(casa::Int whichRow=0,
101 casa::Bool showDate=casa::False) const ;
102 casa::MEpoch getEpoch(casa::Int whichRow=0) const;
103 casa::MDirection getDirection(casa::Int whichRow=0,
104 casa::Bool refBeam=casa::False) const;
105//
106 std::string getSourceName(casa::Int whichRow=0) const;
107 double getInterval(casa::Int whichRow=0) const;
108
109 virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0);
110 virtual void setRestFreqs(std::vector<double> freqs,
111 const std::string& theunit);
112 virtual void setCoordInfo(std::vector<string> theinfo);
113
114// Get/Set flux unit
115 std::string getFluxUnit() const;
116 void setFluxUnit (const std::string& unit);
117
118// Set Instrument
119 void setInstrument (const std::string& instrument);
120
121 // set the current value
122 virtual bool setIF(casa::Int whichIF=0);
123 virtual bool setBeam(casa::Int whichBeam=0);
124 virtual bool setPol(casa::Int whichPol=0);
125
126 //sets the user mask applied to all spectra
127 virtual bool setMask(std::vector<int> whichChans);
128 // Hard flags the current spectrum, not reversible
129 virtual void flag(int whichRow);
130
131 // return the currently selected values
132 virtual casa::Int getIF() const { return IFSel_; }
133 virtual casa::Int getBeam() const { return beamSel_; }
134 virtual casa::Int getPol() const { return polSel_; }
135
136 // returns unit, conversion frame, doppler, base-frame
137 virtual std::vector<std::string> getCoordInfo() const;
138
139 // number of scans in table
140 virtual casa::Int nScan() const;
141
142 // get a summary of the table
143 virtual std::string summary() const;
144
145 std::vector<std::string> history(int whichRow=0) const;
146 bool appendHistory(const std::string& hist, int whichRow=0);
147 // write to disk as aips++ table
148 void makePersistent(const std::string& filename);
149
150 // get a new SDMemTable containing all rows with the same give SCANID
151 SDMemTable getScan(casa::Int scanID) const;
152 SDMemTable getSource(const std::string& source) const;
153
154 const casa::TableRecord& getHeader() const {return table_.keywordSet();}
155 // get a handle to the "raw" aips++ table
156 const casa::Table& table() const { return table_; }
157
158 // return the number of values
159 casa::Int nBeam() const;
160 casa::Int nIF() const;
161 casa::Int nPol() const;
162 casa::Int nChan() const;
163
164 // return the number of rows (integrations) in the table
165 casa::Int nRow() const { return table_.nrow(); }
166
167 // return a row as a Masked array, internally converting uChar flags
168 // to bool mask
169 casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
170 casa::Bool useSelection =
171 casa::False) const;
172
173 // Return SC, setting only the basic construction state (i.e.
174 // no conversion or velocity or rest frequency state)
175 casa::SpectralCoordinate getSpectralCoordinate(casa::uInt whichIdx) const;
176
177 // Return SC. Set velocity conversion state (unit,doppler),
178 // set rest frequencies. If row number given (>-0), also set
179 // frame conversion layer (needs direction & time which require row)
180 casa::SpectralCoordinate getSpectralCoordinate(casa::uInt whichIdx, casa::uInt row) const;
181
182 // Set just the reference value, pixel and increment into the table
183 // No other state is extracted.
184 casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
185 casa::uInt whichIdx);
186
187 casa::Int nCoordinates() const;
188
189 std::vector<double> getAbcissa(int whichRow=0) const;
190 std::string getAbcissaString(casa::Int whichRow=0) const;
191
192// Get global reference types
193 casa::MDirection::Types getDirectionReference() const;
194 casa::MEpoch::Types getTimeReference() const;
195
196// Get global antenna position
197 casa::MPosition getAntennaPosition() const;
198
199// Helper function to check instrument (antenna) name and give enum
200 static Instrument convertInstrument(const casa::String& instrument,
201 casa::Bool throwIt);
202
203private:
204 // utility func for nice printout
205 casa::String formatSec(casa::Double x) const;
206 casa::String formatDirection(const casa::MDirection& md) const;
207 void setup();
208 // the current cursor into the array
209 casa::Int IFSel_,beamSel_,polSel_;
210 std::vector<bool> chanMask_;
211 // the underlying memory table
212 casa::Table table_;
213};
214
215}// namespace
216#endif
Note: See TracBrowser for help on using the repository browser.