source: trunk/src/Scantable.h@ 1412

Last change on this file since 1412 was 1411, checked in by Malte Marquarding, 17 years ago

added getEpoch member function

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.5 KB
Line 
1//
2// C++ Interface: Scantable
3//
4// Description:
5//
6//
7// Author: Malte Marquarding <asap@atnf.csiro.au>, (C) 2005
8//
9// Copyright: See COPYING file that comes with this distribution
10//
11//
12#ifndef ASAPSCANTABLE_H
13#define ASAPSCANTABLE_H
14
15// STL
16#include <string>
17#include <vector>
18// AIPS++
19#include <casa/aips.h>
20#include <casa/Arrays/MaskedArray.h>
21#include <casa/BasicSL/String.h>
22#include <casa/Utilities/CountedPtr.h>
23
24#include <coordinates/Coordinates/SpectralCoordinate.h>
25
26#include <tables/Tables/Table.h>
27#include <tables/Tables/ArrayColumn.h>
28#include <tables/Tables/ScalarColumn.h>
29
30#include <measures/TableMeasures/ScalarMeasColumn.h>
31
32#include "Logger.h"
33#include "STHeader.h"
34#include "STFrequencies.h"
35#include "STWeather.h"
36#include "STFocus.h"
37#include "STTcal.h"
38#include "STMolecules.h"
39#include "STSelector.h"
40#include "STHistory.h"
41#include "STPol.h"
42#include "STFit.h"
43#include "STFitEntry.h"
44
45namespace asap {
46
47/**
48 * This class contains and wraps a casa::Table, which is used to store
49 * all the information. This can be either a MemoryTable or a
50 * disk based Table.
51 * It provides access functions to the underlying table
52 * It contains n subtables:
53 * @li weather
54 * @li frequencies
55 * @li molecules
56 * @li tcal
57 * @li focus
58 * @li fits
59 *
60 * @brief The main ASAP data container
61 * @author Malte Marquarding
62 * @date
63 * @version
64*/
65class Scantable : private Logger
66{
67
68friend class STMath;
69
70public:
71 /**
72 * Default constructor
73 */
74 explicit Scantable(casa::Table::TableType ttype = casa::Table::Memory);
75
76 /**
77 * Create a Scantable object form an existing table on disk
78 * @param[in] name the name of the existing Scantable
79 */
80 explicit Scantable(const std::string& name, casa::Table::TableType ttype = casa::Table::Memory);
81
82 /// @fixme this is only sensible for MemoryTables....
83 Scantable(const Scantable& other, bool clear=true);
84
85 /**
86 * Destructor
87 */
88 virtual ~Scantable();
89
90 /**
91 * get a const reference to the underlying casa::Table
92 * @return const \ref casa::Table reference
93 */
94 const casa::Table& table() const;
95
96 /**
97 * get a reference to the underlying casa::Table with the Selection
98 * object applied if set
99 * @return casa::Table reference
100 */
101 casa::Table& table();
102
103
104 /**
105 * Get a handle to the selection object
106 * @return constant STSelector reference
107 */
108 const STSelector& getSelection() const { return selector_; }
109
110 /**
111 * Set the data to be a subset as defined by the STSelector
112 * @param selection a STSelector object
113 */
114 void setSelection(const STSelector& selection);
115
116 /**
117 * unset the selection of the data
118 */
119 void unsetSelection();
120 /**
121 * set the header
122 * @param[in] sth an STHeader object
123 */
124 void setHeader( const STHeader& sth );
125
126 /**
127 * get the header information
128 * @return an STHeader object
129 */
130 STHeader getHeader( ) const;
131
132 /**
133 * Checks if the "other" Scantable is conformant with this,
134 * i.e. if header values are the same.
135 * @param[in] other another Scantable
136 * @return true or false
137 */
138 bool conformant( const Scantable& other);
139
140 /**
141 *
142 * @param stype The type of the source, 0 = on, 1 = off
143 */
144 void setSourceType(int stype);
145
146
147 /**
148 * The number of scans in the table
149 * @return number of scans in the table
150 */
151 int nscan() const;
152
153 casa::MEpoch::Types getTimeReference() const;
154
155
156 casa::MEpoch getEpoch(int whichrow) const;
157
158 /**
159 * Get global antenna position
160 * @return casa::MPosition
161 */
162 casa::MPosition getAntennaPosition() const;
163
164 /**
165 * the @ref casa::MDirection for a specific row
166 * @param[in] whichrow the row number
167 * return casa::MDirection
168 */
169 casa::MDirection getDirection( int whichrow ) const;
170
171 /**
172 * get the direction type as a string, e.g. "J2000"
173 * @param[in] whichrow the row number
174 * return the direction string
175 */
176 std::string getDirectionString( int whichrow ) const;
177
178 /**
179 * set the direction type as a string, e.g. "J2000"
180 * @param[in] refstr the direction type
181 */
182 void setDirectionRefString(const std::string& refstr="");
183 /**
184 * get the direction reference string
185 * @return a string describing the direction reference
186 */
187 std::string getDirectionRefString() const; /**
188 * get the direction type as a string, e.g. "J2000"
189 * param[in] whichrow the row number
190 * return the direction string
191 */
192
193
194 /**
195 * Return the Flux unit of the data, e.g. "Jy" or "K"
196 * @return string
197 */
198 std::string getFluxUnit() const;
199
200 /**
201 * Set the Flux unit of the data
202 * @param unit a string representing the unit, e.g "Jy" or "K"
203 */
204 void setFluxUnit( const std::string& unit );
205
206 /**
207 * Set the Stokes type of the data
208 * @param feedtype a string representing the type, e.g "circular" or "linear"
209 */
210 void setFeedType( const std::string& feedtype );
211
212 /**
213 *
214 * @param instrument a string representing an insturment. see xxx
215 */
216 void setInstrument( const std::string& instrument );
217
218 /**
219 * (Re)calculate the azimuth and elevationnfor all rows
220 */
221 void calculateAZEL();
222
223 /**
224 * "hard" flag the data, this flags everything selected in setSelection()
225 * param[in] msk a boolean mask of length nchan describing the points to
226 * to be flagged
227 */
228 void flag( const std::vector<bool>& msk = std::vector<bool>());
229
230 /**
231 * Return a list of row numbers with respect to the original table.
232 * @return a list of unsigned ints
233 */
234 std::vector<unsigned int> rownumbers() const;
235
236
237 /**
238 * Get the number of beams in the data or a specific scan
239 * @param scanno the scan number to get the number of beams for.
240 * If scanno<0 the number is retrieved from the header.
241 * @return an integer number
242 */
243 int nbeam(int scanno=-1) const;
244 /**
245 * Get the number of IFs in the data or a specific scan
246 * @param scanno the scan number to get the number of IFs for.
247 * If scanno<0 the number is retrieved from the header.
248 * @return an integer number
249 */
250 int nif(int scanno=-1) const;
251 /**
252 * Get the number of polarizations in the data or a specific scan
253 * @param scanno the scan number to get the number of polarizations for.
254 * If scanno<0 the number is retrieved from the header.
255 * @return an integer number
256 */
257 int npol(int scanno=-1) const;
258
259 std::string getPolType() const;
260
261
262 /**
263 * Get the number of integartion cycles
264 * @param scanno the scan number to get the number of rows for.
265 * If scanno<0 the number is retrieved from the header.
266 * @return the number of rows (for the specified scanno)
267 */
268 int nrow(int scanno=-1) const;
269
270 int getBeam(int whichrow) const;
271 std::vector<uint> getBeamNos() { return getNumbers(beamCol_); }
272
273 int getIF(int whichrow) const;
274 std::vector<uint> getIFNos() { return getNumbers(ifCol_); }
275
276 int getPol(int whichrow) const;
277 std::vector<uint> getPolNos() { return getNumbers(polCol_); }
278
279 std::vector<uint> getScanNos() { return getNumbers(scanCol_); }
280 int getScan(int whichrow) const { return scanCol_(whichrow); }
281
282 /**
283 * Get the number of channels in the data or a specific IF. This currently
284 * varies only with IF number
285 * @param ifno the IF number to get the number of channels for.
286 * If ifno<0 the number is retrieved from the header.
287 * @return an integer number
288 */
289 int nchan(int ifno=-1) const;
290 int getChannels(int whichrow) const;
291
292 int ncycle(int scanno=-1) const;
293 int getCycle(int whichrow) const { return cycleCol_(whichrow); }
294
295 double getInterval(int whichrow) const
296 { return integrCol_(whichrow); }
297
298 float getTsys(int whichrow) const
299 { return casa::Vector<casa::Float>(tsysCol_(whichrow))(0); }
300 float getElevation(int whichrow) const
301 { return elCol_(whichrow); }
302 float getAzimuth(int whichrow) const
303 { return azCol_(whichrow); }
304 float getParAngle(int whichrow) const
305 { return paraCol_(whichrow); }
306
307 std::string getSourceName(int whichrow) const
308 { return srcnCol_(whichrow); }
309
310 std::vector<bool> getMask(int whichrow) const;
311 std::vector<float> getSpectrum(int whichrow,
312 const std::string& poltype = "" ) const;
313
314 void setSpectrum(const std::vector<float>& spec, int whichrow);
315
316 std::string getPolarizationLabel(int index, const std::string& ptype) const
317 { return STPol::getPolLabel(index, ptype ); }
318
319 /**
320 * Write the Scantable to disk
321 * @param filename the output file name
322 */
323 void makePersistent(const std::string& filename);
324
325 std::vector<std::string> getHistory() const
326 { return historyTable_.getHistory(); };
327
328 void addHistory(const std::string& hist) { historyTable_.addEntry(hist); }
329
330 void appendToHistoryTable(const STHistory& otherhist)
331 { historyTable_.append(otherhist); }
332
333 std::string summary(bool verbose=false);
334 std::string getTime(int whichrow=-1, bool showdate=true) const;
335 double getIntTime(int whichrow) const { return integrCol_(whichrow); }
336
337 // returns unit, conversion frame, doppler, base-frame
338
339 /**
340 * Get the frequency set up
341 * This is forwarded to the STFrequencies subtable
342 * @return unit, frame, doppler
343 */
344 std::vector<std::string> getCoordInfo() const
345 { return freqTable_.getInfo(); };
346
347 void setCoordInfo(std::vector<string> theinfo)
348 { return freqTable_.setInfo(theinfo); };
349
350
351 std::vector<double> getAbcissa(int whichrow) const;
352
353 std::string getAbcissaLabel(int whichrow) const;
354 std::vector<double> getRestFrequencies() const
355 { return moleculeTable_.getRestFrequencies(); }
356
357 void setRestFrequencies(double rf, const std::string& name = "",
358 const std::string& = "Hz");
359 void setRestFrequencies(const std::string& name);
360
361 void shift(int npix);
362
363 void convertDirection(const std::string& newframe);
364
365 STFrequencies& frequencies() { return freqTable_; }
366 const STFrequencies& frequencies() const { return freqTable_; }
367 STWeather& weather() { return weatherTable_; }
368 const STWeather& weather() const { return weatherTable_; }
369 STFocus& focus() { return focusTable_; }
370 const STFocus& focus() const { return focusTable_; }
371 STTcal& tcal() { return tcalTable_; }
372 const STTcal& tcal() const { return tcalTable_; }
373 STMolecules& molecules() { return moleculeTable_; }
374 const STMolecules& molecules() const { return moleculeTable_; }
375 STHistory& history() { return historyTable_; }
376 const STHistory& history() const { return historyTable_; }
377 STFit& fit() { return fitTable_; }
378 const STFit& fit() const { return fitTable_; }
379
380 std::vector<std::string> columnNames() const;
381
382 void addFit(const STFitEntry& fit, int row);
383 STFitEntry getFit(int row) const
384 { STFitEntry fe; fitTable_.getEntry(fe, mfitidCol_(row)); return fe; }
385
386 //Added by TT
387 /**
388 * Get the antenna name
389 * @return antenna name string
390 */
391 std::string getAntennaName() const;
392
393 /**
394 * For GBT MS data only. check a scan list
395 * against the information found in GBT_GO table for
396 * scan number orders to get correct pairs.
397 * @param[in] scan list
398 * @return status
399 */
400 int checkScanInfo(const std::vector<int>& scanlist) const;
401
402 /**
403 * Get the direction as a vector, for a specific row
404 * @param[in] whichrow the row numbyyer
405 * @return the direction in a vector
406 */
407 std::vector<double> getDirectionVector(int whichrow) const;
408
409private:
410
411 casa::Matrix<casa::Float> getPolMatrix( casa::uInt whichrow ) const;
412
413 /**
414 * Turns a time vale into a formatted string
415 * @param x
416 * @return
417 */
418 std::string formatSec(casa::Double x) const;
419
420 std::string formatTime(const casa::MEpoch& me, bool showdate)const;
421
422 /**
423 * Turns a casa::MDirection into a nicely formatted string
424 * @param md an casa::MDirection
425 * @return
426 */
427 std::string formatDirection(const casa::MDirection& md) const;
428
429
430 /**
431 * Create a unique file name for the paged (temporary) table
432 * @return just the name
433 */
434 static casa::String generateName();
435
436 /**
437 * attach to cached columns
438 */
439 void attach();
440
441 /**
442 * Set up the main casa::Table
443 */
444 void setupMainTable();
445
446 void attachSubtables();
447 void copySubtables(const Scantable& other);
448
449 /**
450 * Convert an "old" asap1 style row index into a new index
451 * @param[in] therow
452 * @return and index into @table_
453 */
454 int rowToScanIndex(int therow);
455
456 std::vector<uint> getNumbers(casa::ScalarColumn<casa::uInt>& col);
457
458 static const casa::uInt version_ = 2;
459
460 STSelector selector_;
461
462 casa::Table::TableType type_;
463
464 // the actual data
465 casa::Table table_;
466 casa::Table originalTable_;
467
468 STTcal tcalTable_;
469 STFrequencies freqTable_;
470 STWeather weatherTable_;
471 STFocus focusTable_;
472 STMolecules moleculeTable_;
473 STHistory historyTable_;
474 STFit fitTable_;
475
476 // Cached Columns to avoid reconstructing them for each row get/put
477 casa::ScalarColumn<casa::Double> integrCol_;
478 casa::MDirection::ScalarColumn dirCol_;
479 casa::MEpoch::ScalarColumn timeCol_;
480 casa::ScalarColumn<casa::Float> azCol_;
481 casa::ScalarColumn<casa::Float> elCol_;
482 casa::ScalarColumn<casa::Float> paraCol_;
483 casa::ScalarColumn<casa::String> srcnCol_, fldnCol_;
484 casa::ScalarColumn<casa::uInt> scanCol_, beamCol_, ifCol_, polCol_, cycleCol_;
485 casa::ScalarColumn<casa::Int> rbeamCol_, srctCol_;
486 casa::ArrayColumn<casa::Float> specCol_, tsysCol_;
487 casa::ArrayColumn<casa::uChar> flagsCol_;
488
489 // id in frequencies table
490 casa::ScalarColumn<casa::uInt> mfreqidCol_;
491 // id in tcal table
492 casa::ScalarColumn<casa::uInt> mtcalidCol_;
493
494 casa::ArrayColumn<casa::String> histitemCol_;
495 casa::ScalarColumn<casa::Int> mfitidCol_;
496 casa::ScalarColumn<casa::uInt> mweatheridCol_;
497
498 casa::ScalarColumn<casa::uInt> mfocusidCol_;
499
500 casa::ScalarColumn<casa::uInt> mmolidCol_;
501
502 static std::map<std::string, STPol::STPolFactory *> factories_;
503 void initFactories();
504
505};
506
507
508} // namespace
509
510#endif
Note: See TracBrowser for help on using the repository browser.