source: trunk/src/SDMemTable.h@ 153

Last change on this file since 153 was 147, checked in by kil064, 20 years ago

add defualt value False to arg. clear in copy constrcutor

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.8 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 a SDMemTable, give a scanid constraint
64 // see also getScan()
65 SDMemTable(const casa::Table& tab, const std::string& expr);
66
67 SDMemTable &operator=(const SDMemTable& other);
68
69 virtual ~SDMemTable();
70
71 // put data from meta conatiner into the table
72 bool putSDContainer(const SDContainer& sdc);
73 bool putSDHeader(const SDHeader& sdh);
74 bool putSDFreqTable(const SDFrequencyTable& sdft);
75
76 //get the dat wrapped up in a meta container
77 SDContainer getSDContainer(casa::uInt whichRow=0) const;
78 SDHeader getSDHeader() const;
79 SDFrequencyTable getSDFreqTable() const;
80 // get spectrum,mask and tsys for the given row, at the selected
81 // cursor - all as stl vectors
82 virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const;
83 virtual std::vector<bool> getMask(casa::Int whichRow=0) const;
84
85 virtual casa::Float getTsys(casa::Int whichRow=0) const;
86 // get all as aips++ Vectors
87 virtual void getSpectrum(casa::Vector<casa::Float>& spectrum,
88 casa::Int whichRow=0);
89
90 //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const;
91
92 // get info for current row
93 std::string getTime(casa::Int whichRow=0) const ;
94 std::string getSourceName(casa::Int whichRow=0) const;
95 double getInterval(casa::Int whichRow=0) const;
96
97 virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0);
98 virtual void setRestFreqs(std::vector<double> freqs,
99 const std::string& theunit);
100 virtual void setCoordInfo(std::vector<string> theinfo);
101 // set the current value
102 virtual bool setIF(casa::Int whichIF=0);
103 virtual bool setBeam(casa::Int whichBeam=0);
104 virtual bool setPol(casa::Int whichPol=0);
105
106 //sets the user mask applied to all spectra
107 virtual bool setMask(std::vector<int> whichChans);
108 // Hard flags the current spectrum, not reversible
109 virtual void flag(int whichRow);
110
111 // return the currently selected values
112 virtual casa::Int getIF() { return IFSel_; }
113 virtual casa::Int getBeam() { return beamSel_; }
114 virtual casa::Int getPol() { return polSel_; }
115 virtual std::vector<string> getCoordInfo() const;
116
117 // number of scans in table
118 virtual casa::Int nScan() const;
119
120 // print a summary to stdout
121 virtual std::string summary();
122
123 // write to disk as aips++ table
124 void makePersistent(const std::string& filename);
125
126 // get a new SDMemTable containing all rows with the same give SCANID
127 SDMemTable getScan(casa::Int scanID);
128 SDMemTable getSource(const std::string& source);
129
130 const casa::TableRecord& getHeader() const {return table_.keywordSet();}
131 // get a handle to the "raw" aips++ table
132 const casa::Table& table() const { return table_; }
133
134 // return the number of values
135 casa::Int nBeam() const;
136 casa::Int nIF() const;
137 casa::Int nPol() const;
138 casa::Int nChan() const;
139
140 // return the number of rows (integrations) in the table
141 casa::Int nRow() const { return table_.nrow(); }
142
143 // return a row as a Masked array, internally converting uChar flags
144 // to bool mask
145 casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
146 casa::Bool useSelection = casa::False);
147
148 casa::SpectralCoordinate getCoordinate(casa::uInt whichIdx) const;
149 casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
150 casa::uInt whichIdx);
151
152 casa::Int nCoordinates() const;
153
154 std::vector<double> getAbscissa(int whichRow=0);
155 std::string getAbscissaString(casa::Int whichRow=0);
156
157private:
158 // utility func for nice printout
159 casa::String formatSec(casa::Double x);
160 void setup();
161 // the current cursor into the array
162 casa::Int IFSel_,beamSel_,polSel_;
163 std::vector<bool> chanMask_;
164 // the underlying memory table
165 casa::Table table_;
166};
167
168}// namespace
169#endif
Note: See TracBrowser for help on using the repository browser.