source: trunk/src/Scantable.h @ 1430

Last change on this file since 1430 was 1430, checked in by Malte Marquarding, 16 years ago

merged in unflag option from alma branch

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