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

Last change on this file since 1430 was 1400, checked in by TakTsutsumi, 17 years ago

added unflag parameter to flag function

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