source: trunk/src/SDMemTable.h@ 251

Last change on this file since 251 was 251, checked in by mar637, 20 years ago
  • added getRestFreqs
  • filled in some of getSDFreqTable - not fully usable!!!!
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.7 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 SDFrequencyTable getSDFreqTable() const;
82 // get spectrum,mask and tsys for the given row, at the selected
83 // cursor - all as stl vectors
84 virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const;
85 virtual std::vector<bool> getMask(casa::Int whichRow=0) const;
86
87 virtual casa::Float getTsys(casa::Int whichRow=0) const;
88 // get all as aips++ Vectors
89 virtual void getSpectrum(casa::Vector<casa::Float>& spectrum,
90 casa::Int whichRow=0) const;
91
92 //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const;
93 std::vector<double> getRestFreqs() const;
94
95 // get info for current row
96 std::string getTime(casa::Int whichRow=0) const ;
97 std::string getSourceName(casa::Int whichRow=0) const;
98 double getInterval(casa::Int whichRow=0) const;
99
100 virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0);
101 virtual void setRestFreqs(std::vector<double> freqs,
102 const std::string& theunit);
103 virtual void setCoordInfo(std::vector<string> theinfo);
104
105// Get/Set flux unit
106 std::string getFluxUnit() const;
107 void setFluxUnit (const std::string& unit);
108
109// Set Instrument
110 void setInstrument (const std::string& instrument);
111
112 // set the current value
113 virtual bool setIF(casa::Int whichIF=0);
114 virtual bool setBeam(casa::Int whichBeam=0);
115 virtual bool setPol(casa::Int whichPol=0);
116
117 //sets the user mask applied to all spectra
118 virtual bool setMask(std::vector<int> whichChans);
119 // Hard flags the current spectrum, not reversible
120 virtual void flag(int whichRow);
121
122 // return the currently selected values
123 virtual casa::Int getIF() const { return IFSel_; }
124 virtual casa::Int getBeam() const { return beamSel_; }
125 virtual casa::Int getPol() const { return polSel_; }
126 virtual std::vector<std::string> getCoordInfo() const;
127
128 // number of scans in table
129 virtual casa::Int nScan() const;
130
131 // get a summary of the table
132 virtual std::string summary();
133
134 std::vector<std::string> history(int whichRow=0) const;
135 bool appendHistory(const std::string& hist, int whichRow=0);
136 // write to disk as aips++ table
137 void makePersistent(const std::string& filename);
138
139 // get a new SDMemTable containing all rows with the same give SCANID
140 SDMemTable getScan(casa::Int scanID) const;
141 SDMemTable getSource(const std::string& source) const;
142
143 const casa::TableRecord& getHeader() const {return table_.keywordSet();}
144 // get a handle to the "raw" aips++ table
145 const casa::Table& table() const { return table_; }
146
147 // return the number of values
148 casa::Int nBeam() const;
149 casa::Int nIF() const;
150 casa::Int nPol() const;
151 casa::Int nChan() const;
152
153 // return the number of rows (integrations) in the table
154 casa::Int nRow() const { return table_.nrow(); }
155
156 // return a row as a Masked array, internally converting uChar flags
157 // to bool mask
158 casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
159 casa::Bool useSelection =
160 casa::False) const;
161
162 casa::SpectralCoordinate getCoordinate(casa::uInt whichIdx) const;
163 casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
164 casa::uInt whichIdx);
165
166 casa::Int nCoordinates() const;
167
168
169 std::vector<double> getAbcissa(int whichRow=0) const;
170 std::string getAbcissaString(casa::Int whichRow=0) const;
171
172// Get MDirection for this row
173 casa::MDirection getDirection(casa::Int whichRow=0) const;
174
175// Get gloabl Direction reference
176 casa::MDirection::Types getDirectionReference () const;
177
178// Get global Time reference
179 casa::MEpoch::Types getTimeReference () const;
180
181// Helper function to check instrument (antenna) name and give enum
182 static Instrument convertInstrument (const casa::String& instrument,
183 casa::Bool throwIt);
184
185private:
186 // utility func for nice printout
187 casa::String formatSec(casa::Double x);
188 void setup();
189 // the current cursor into the array
190 casa::Int IFSel_,beamSel_,polSel_;
191 std::vector<bool> chanMask_;
192 // the underlying memory table
193 casa::Table table_;
194};
195
196}// namespace
197#endif
Note: See TracBrowser for help on using the repository browser.