source: trunk/src/SDMemTable.h@ 225

Last change on this file since 225 was 218, checked in by kil064, 20 years ago

add function 'setFluxUnit'

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 6.4 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
43#include <coordinates/Coordinates/SpectralCoordinate.h>
44
45namespace asap {
46
47class SDContainer;
48class SDHeader;
49class SDFrequencyTable;
50
51
52class SDMemTable {
53public:
54 // create a new (empty) SDMemTable
55 SDMemTable();
56 // create a SDMemTable from an (aips++) table on disk
57 SDMemTable(const std::string& name);
58
59 // Copy Construct a SDMemTable, if clear==True only header and
60 // skeleton are copied, otherwise the whole table is copied.
61 SDMemTable(const SDMemTable& other, casa::Bool clear=casa::False);
62
63 // Copy Construct (copy semantics) a SDMemTable, give a scanid constraint
64 // see also getScan()
65 SDMemTable(const casa::Table& tab, const std::string& expr);
66
67 // Assignment operator (copy semantics)
68 SDMemTable &operator=(const SDMemTable& other);
69
70 virtual ~SDMemTable();
71
72 // put data from meta conatiner into the table
73 bool putSDContainer(const SDContainer& sdc);
74 bool putSDHeader(const SDHeader& sdh);
75 bool putSDFreqTable(const SDFrequencyTable& sdft);
76
77 //get the data wrapped up in a meta container
78 SDContainer getSDContainer(casa::uInt whichRow=0) const;
79 SDHeader getSDHeader() const;
80 SDFrequencyTable getSDFreqTable() const;
81 // get spectrum,mask and tsys for the given row, at the selected
82 // cursor - all as stl vectors
83 virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const;
84 virtual std::vector<bool> getMask(casa::Int whichRow=0) const;
85
86 virtual casa::Float getTsys(casa::Int whichRow=0) const;
87 // get all as aips++ Vectors
88 virtual void getSpectrum(casa::Vector<casa::Float>& spectrum,
89 casa::Int whichRow=0) const;
90
91 //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const;
92
93 // get info for current row
94 std::string getTime(casa::Int whichRow=0) const ;
95 std::string getSourceName(casa::Int whichRow=0) const;
96 double getInterval(casa::Int whichRow=0) const;
97
98 virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0);
99 virtual void setRestFreqs(std::vector<double> freqs,
100 const std::string& theunit);
101 virtual void setCoordInfo(std::vector<string> theinfo);
102
103// Get/Set flux unit
104 std::string getFluxUnit() const;
105 void setFluxUnit (const std::string& unit);
106
107 // set the current value
108 virtual bool setIF(casa::Int whichIF=0);
109 virtual bool setBeam(casa::Int whichBeam=0);
110 virtual bool setPol(casa::Int whichPol=0);
111
112 //sets the user mask applied to all spectra
113 virtual bool setMask(std::vector<int> whichChans);
114 // Hard flags the current spectrum, not reversible
115 virtual void flag(int whichRow);
116
117 // return the currently selected values
118 virtual casa::Int getIF() const { return IFSel_; }
119 virtual casa::Int getBeam() const { return beamSel_; }
120 virtual casa::Int getPol() const { return polSel_; }
121 virtual std::vector<std::string> getCoordInfo() const;
122
123 // number of scans in table
124 virtual casa::Int nScan() const;
125
126 // get a summary of the table
127 virtual std::string summary();
128
129 std::vector<std::string> history(int whichRow=0) const;
130 bool appendHistory(const std::string& hist, int whichRow=0);
131 // write to disk as aips++ table
132 void makePersistent(const std::string& filename);
133
134 // get a new SDMemTable containing all rows with the same give SCANID
135 SDMemTable getScan(casa::Int scanID) const;
136 SDMemTable getSource(const std::string& source) const;
137
138 const casa::TableRecord& getHeader() const {return table_.keywordSet();}
139 // get a handle to the "raw" aips++ table
140 const casa::Table& table() const { return table_; }
141
142 // return the number of values
143 casa::Int nBeam() const;
144 casa::Int nIF() const;
145 casa::Int nPol() const;
146 casa::Int nChan() const;
147
148 // return the number of rows (integrations) in the table
149 casa::Int nRow() const { return table_.nrow(); }
150
151 // return a row as a Masked array, internally converting uChar flags
152 // to bool mask
153 casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
154 casa::Bool useSelection =
155 casa::False) const;
156
157 casa::SpectralCoordinate getCoordinate(casa::uInt whichIdx) const;
158 casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
159 casa::uInt whichIdx);
160
161 casa::Int nCoordinates() const;
162
163
164 std::vector<double> getAbcissa(int whichRow=0) const;
165 std::string getAbcissaString(casa::Int whichRow=0) const;
166
167// Get MDirection for this row
168 casa::MDirection getDirection(casa::Int whichRow=0) const;
169
170// Get gloabl Direction reference
171 casa::MDirection::Types getDirectionReference () const;
172
173// Get global Time reference
174 casa::MEpoch::Types getTimeReference () const;
175
176private:
177 // utility func for nice printout
178 casa::String formatSec(casa::Double x);
179 void setup();
180 // the current cursor into the array
181 casa::Int IFSel_,beamSel_,polSel_;
182 std::vector<bool> chanMask_;
183 // the underlying memory table
184 casa::Table table_;
185};
186
187}// namespace
188#endif
Note: See TracBrowser for help on using the repository browser.