source: branches/alma/src/Scantable.h@ 1639

Last change on this file since 1639 was 1634, checked in by Takeshi Nakazato, 15 years ago

New Development: No

JIRA Issue: Yes CAS-1422

Ready to Release: Yes

Interface Changes: No

What Interface Changed: Please list interface changes

Test Programs: List test programs

Put in Release Notes: No

Module(s): Module Names change impacts.

Description: Describe your changes here...

Bug fix

  1. Changed code to update Tsys after calibration
  2. Changed code to update FluxUnit after calibration
  3. Removed additional log messages


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