source: trunk/src/SDContainer.h@ 415

Last change on this file since 415 was 396, checked in by kil064, 20 years ago

add a secondary index argument to the SDDataDesc container

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.0 KB
Line 
1//#---------------------------------------------------------------------------
2//# SDContainer.h: A container class 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 SDCONTAINER_H
32#define SDCONTAINER_H
33
34#include <vector>
35
36#include <casa/aips.h>
37#include <casa/BasicSL/String.h>
38#include <casa/Arrays/Array.h>
39#include <casa/Arrays/Vector.h>
40#include <casa/Containers/Block.h>
41#include <measures/Measures/MDirection.h>
42
43template<class T> class casa::Matrix;
44
45namespace asap {
46
47
48struct SDHeader {
49 casa::Int nchan;
50 casa::Int npol;
51 casa::Int nif;
52 casa::Int nbeam;
53 casa::String observer;
54 casa::String project;
55 casa::String obstype;
56 casa::String antennaname;
57 casa::Vector<casa::Double> antennaposition;
58 casa::Float equinox;
59 casa::String freqref;
60 casa::Double reffreq;
61 casa::Double bandwidth;
62 casa::Double utc;
63 casa::String fluxunit;
64 casa::String epoch;
65 void print() const ;
66};
67
68class SDFrequencyTable {
69
70public:
71
72 SDFrequencyTable() : nFreq_(0) {;}
73 virtual ~SDFrequencyTable() {;}
74
75// Add a new entry or match an existing one. Returns the index into the table
76 casa::uInt addFrequency(casa::Double refPix, casa::Double refVal,
77 casa::Double inc);
78//
79 casa::Int length() const { return nFreq_;} // # of stored Frequencies
80 void setLength(casa::uInt length) {nFreq_ = length;}
81
82// Get attributes
83 casa::Double referencePixel(casa::uInt which) const { return refPix_[which];}
84 casa::Double referenceValue(casa::uInt which) const { return refVal_[which];}
85 casa::Double increment(casa::uInt which) const { return increment_[which];}
86 casa::Float equinox() const { return equinox_; }
87 casa::String refFrame() const { return refFrame_; }
88//
89 void restFrequencies(casa::Vector<casa::Double>& rfs,
90 casa::String& rfunit ) const ;
91
92// Set attributes
93 void setEquinox(casa::Float eq) { equinox_ = eq; }
94 void setRefFrame(const casa::String& reff) { refFrame_ = reff; }
95//
96 void deleteRestFrequencies () {restFreqs_.resize(0);}
97 casa::uInt addRestFrequency(casa::Double);
98 void setRestFrequencyUnit(const casa::String& theunit) {restFreqUnit_ = theunit;}
99
100private:
101 casa::uInt nFreq_;
102 casa::Vector<casa::Double> refPix_;
103 casa::Vector<casa::Double> refVal_; // Hz
104 casa::Vector<casa::Double> increment_; // Hz
105 casa::Float equinox_;
106 casa::String refFrame_;
107 casa::Vector<casa::Double> restFreqs_; // Hz
108 casa::String restFreqUnit_;
109};
110
111
112class SDContainer {
113
114public:
115 SDContainer(casa::uInt nBeam, casa::uInt nIF, casa::uInt nPol,
116 casa::uInt nChan);
117 SDContainer(casa::IPosition shp);
118
119 virtual ~SDContainer();
120
121 casa::Bool resize(casa::IPosition shp);
122
123 casa::Bool setSpectrum(const casa::Matrix<casa::Float>& spec,
124 casa::uInt whichBeam, casa::uInt whichIF);
125 casa::Bool putSpectrum(const casa::Array<casa::Float>& spec);
126
127 casa::Bool setFlags(const casa::Matrix<casa::uChar>& flgs,
128 casa::uInt whichBeam, casa::uInt whichIF);
129 casa::Bool putFlags(const casa::Array<casa::uChar>& spec);
130
131 casa::Bool setTsys(const casa::Vector<casa::Float>& ts,
132 casa::uInt whichBeam, casa::uInt whichIF);
133 casa::Bool putTsys(const casa::Array<casa::Float>& spec);
134
135 casa::Bool setDirection(const casa::Vector<casa::Double>& point,
136 casa::uInt whichBeam);
137 casa::Bool putDirection(const casa::Array<casa::Double>& dir);
138
139 casa::Bool setFrequencyMap(casa::uInt freqslot, casa::uInt whichIF);
140 casa::Bool putFreqMap(const casa::Vector<casa::uInt>& freqs);
141
142 casa::Bool setRestFrequencyMap(casa::uInt freqslot, casa::uInt whichIF);
143 casa::Bool putRestFreqMap(const casa::Vector<casa::uInt>& freqs);
144
145 casa::Array<casa::Float> getSpectrum(casa::uInt whichBeam,
146 casa::uInt whichIF) const;
147 casa::Array<casa::uChar> getFlags(casa::uInt whichBeam,
148 casa::uInt whichIF) const;
149 casa::Array<casa::Float> getTsys(casa::uInt whichBeam,
150 casa::uInt whichIF) const;
151 casa::Array<casa::Double> getDirection(casa::uInt whichBeam) const;
152
153 const casa::Array<casa::Float>& getSpectrum() const { return spectrum_; }
154 const casa::Array<casa::uChar>& getFlags() const { return flags_; }
155 const casa::Array<casa::Float>& getTsys() const { return tsys_; }
156 const casa::Array<casa::Double>& getDirection() const { return direction_; }
157
158 const casa::Vector<casa::uInt>& getFreqMap() const { return freqidx_; }
159 const casa::Vector<casa::uInt>& getRestFreqMap() const { return restfreqidx_; }
160
161 const casa::Vector<casa::String>& getHistory() const { return history_; }
162 casa::Bool putHistory(const casa::Vector<casa::String>& hist);
163 casa::Bool appendHistory(const casa::String& hist);
164
165 casa::Double timestamp;
166 //Double bandwidth;
167 casa::String sourcename;
168 casa::String fieldname;
169 casa::Double interval;
170 casa::Int scanid;
171 casa::Vector<casa::Float> tcal;
172 casa::String tcaltime;
173 casa::Float azimuth;
174 casa::Float elevation;
175 casa::Float parangle;
176 casa::Int refbeam;
177
178private:
179 casa::uInt nBeam_,nIF_,nPol_,nChan_;
180
181 // (nBeam,nIF,nPol,nChannel)
182 casa::Array<casa::Float> spectrum_;
183 casa::Array<casa::uChar> flags_;
184 // (nBeam,nIF,nPol,[nChannel]) Tsys is not really a function of
185 // channel, but this makes it easier to work with at the expense of
186 // a little memory
187 casa::Array<casa::Float> tsys_;
188 casa::Array<casa::Float> tcal_;
189
190 //(nIF) indx into "global" frequency table
191 casa::Vector<casa::uInt> freqidx_;
192 // (nIF) indx into "global" rest frequency table
193 casa::Vector<casa::uInt> restfreqidx_;
194 //(nBeam,2) maybe use Measures here...
195 casa::Array<casa::Double> direction_;
196 casa::Vector<casa::String> history_;
197 void setSlice (casa::IPosition& start, casa::IPosition& end,
198 const casa::IPosition& shpIn, const casa::IPosition& shpOut,
199 casa::uInt whichBeam, casa::uInt whichIF, casa::Bool checkPol) const;
200};
201
202
203
204class SDDataDesc {
205
206public:
207
208// COnstructor
209 SDDataDesc() : n_(0) {;}
210 ~SDDataDesc() {;}
211
212// Add an entry if source name and Integer ID (can be anything you like, such
213// as FreqID) are unique. You can add secondary entries direction
214// and another integer index which are just stored along with the
215// the primary entries
216 casa::uInt addEntry (const casa::String& source, casa::uInt ID,
217 const casa::MDirection& secDir, casa::uInt secID);
218
219// Number of entries
220 casa::Int length() const { return n_;}
221
222// Get attributes
223 casa::String source (casa::uInt which) const {return source_[which];}
224 casa::uInt ID(casa::uInt which) const {return ID_[which];}
225 casa::uInt secID(casa::uInt which) const {return secID_[which];}
226 casa::MDirection secDir (casa::uInt which) const {return secDir_[which];}
227
228// Summary
229 void summary() const;
230
231private:
232 casa::uInt n_;
233 casa::Vector<casa::String> source_;
234 casa::Vector<casa::uInt> ID_, secID_;
235 casa::Block<casa::MDirection> secDir_;
236//
237 SDDataDesc(const SDDataDesc& other);
238
239};
240
241} // namespace
242#endif
Note: See TracBrowser for help on using the repository browser.