[2] | 1 | //#--------------------------------------------------------------------------- |
---|
| 2 | //# SDMemTable.h: A MemoryTable container for single dish integrations |
---|
| 3 | //#--------------------------------------------------------------------------- |
---|
| 4 | //# Copyright (C) 2004 |
---|
[125] | 5 | //# ATNF |
---|
[2] | 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 | //#--------------------------------------------------------------------------- |
---|
[125] | 31 | #ifndef SDMEMTABLE_H |
---|
| 32 | #define SDMEMTABLE_H |
---|
[2] | 33 | |
---|
| 34 | // STL |
---|
| 35 | #include <string> |
---|
| 36 | #include <vector> |
---|
| 37 | // AIPS++ |
---|
[236] | 38 | #include <casa/aips.h> |
---|
[322] | 39 | #include <casa/Arrays/MaskedArray.h> |
---|
[80] | 40 | #include <casa/BasicSL/String.h> |
---|
[322] | 41 | #include <coordinates/Coordinates/SpectralCoordinate.h> |
---|
[80] | 42 | #include <tables/Tables/Table.h> |
---|
[322] | 43 | #include <tables/Tables/ArrayColumn.h> |
---|
| 44 | #include <tables/Tables/ScalarColumn.h> |
---|
| 45 | |
---|
[236] | 46 | #include "SDDefs.h" |
---|
[2] | 47 | |
---|
[39] | 48 | |
---|
[322] | 49 | |
---|
[83] | 50 | namespace asap { |
---|
[2] | 51 | |
---|
| 52 | class SDContainer; |
---|
| 53 | class SDHeader; |
---|
| 54 | class SDFrequencyTable; |
---|
| 55 | |
---|
| 56 | |
---|
[322] | 57 | |
---|
| 58 | |
---|
[2] | 59 | class SDMemTable { |
---|
| 60 | public: |
---|
[19] | 61 | // create a new (empty) SDMemTable |
---|
[18] | 62 | SDMemTable(); |
---|
[50] | 63 | // create a SDMemTable from an (aips++) table on disk |
---|
[18] | 64 | SDMemTable(const std::string& name); |
---|
[19] | 65 | |
---|
| 66 | // Copy Construct a SDMemTable, if clear==True only header and |
---|
| 67 | // skeleton are copied, otherwise the whole table is copied. |
---|
[147] | 68 | SDMemTable(const SDMemTable& other, casa::Bool clear=casa::False); |
---|
[2] | 69 | |
---|
[161] | 70 | // Copy Construct (copy semantics) a SDMemTable, give a scanid constraint |
---|
[19] | 71 | // see also getScan() |
---|
[125] | 72 | SDMemTable(const casa::Table& tab, const std::string& expr); |
---|
[161] | 73 | |
---|
| 74 | // Assignment operator (copy semantics) |
---|
[138] | 75 | SDMemTable &operator=(const SDMemTable& other); |
---|
| 76 | |
---|
[2] | 77 | virtual ~SDMemTable(); |
---|
[19] | 78 | |
---|
| 79 | // put data from meta conatiner into the table |
---|
[39] | 80 | bool putSDContainer(const SDContainer& sdc); |
---|
| 81 | bool putSDHeader(const SDHeader& sdh); |
---|
| 82 | bool putSDFreqTable(const SDFrequencyTable& sdft); |
---|
[21] | 83 | |
---|
[161] | 84 | //get the data wrapped up in a meta container |
---|
[386] | 85 | |
---|
[125] | 86 | SDContainer getSDContainer(casa::uInt whichRow=0) const; |
---|
[39] | 87 | SDHeader getSDHeader() const; |
---|
[293] | 88 | |
---|
[306] | 89 | // Get SD Frequency table. |
---|
[39] | 90 | SDFrequencyTable getSDFreqTable() const; |
---|
[306] | 91 | |
---|
[19] | 92 | // get spectrum,mask and tsys for the given row, at the selected |
---|
[21] | 93 | // cursor - all as stl vectors |
---|
[125] | 94 | virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const; |
---|
| 95 | virtual std::vector<bool> getMask(casa::Int whichRow=0) const; |
---|
[426] | 96 | // Get STokes at cursor location. One of either I,Q,U,V or I,P,PA,V (doPol=True) |
---|
| 97 | // If the latter, you can add a PA offset (degrees) |
---|
[418] | 98 | virtual std::vector<float> getStokesSpectrum(casa::Int whichRow=0, |
---|
[426] | 99 | casa::Bool doPol=casa::False, |
---|
| 100 | casa::Float paOffset=0.0) const; |
---|
[21] | 101 | |
---|
[125] | 102 | virtual casa::Float getTsys(casa::Int whichRow=0) const; |
---|
[21] | 103 | // get all as aips++ Vectors |
---|
[125] | 104 | virtual void getSpectrum(casa::Vector<casa::Float>& spectrum, |
---|
[164] | 105 | casa::Int whichRow=0) const; |
---|
[418] | 106 | //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const; |
---|
[2] | 107 | |
---|
[251] | 108 | std::vector<double> getRestFreqs() const; |
---|
| 109 | |
---|
[281] | 110 | // get info for current row |
---|
| 111 | // if whichRow == -1 the Header time is given |
---|
| 112 | std::string getTime(casa::Int whichRow=0, |
---|
| 113 | casa::Bool showDate=casa::False) const ; |
---|
[286] | 114 | casa::MEpoch getEpoch(casa::Int whichRow=0) const; |
---|
| 115 | casa::MDirection getDirection(casa::Int whichRow=0, |
---|
| 116 | casa::Bool refBeam=casa::False) const; |
---|
| 117 | // |
---|
[125] | 118 | std::string getSourceName(casa::Int whichRow=0) const; |
---|
| 119 | double getInterval(casa::Int whichRow=0) const; |
---|
[50] | 120 | |
---|
[88] | 121 | virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0); |
---|
[105] | 122 | virtual void setCoordInfo(std::vector<string> theinfo); |
---|
[206] | 123 | |
---|
[392] | 124 | // Set RestFreqID. source="" and IF=-1 means select all |
---|
| 125 | virtual casa::Bool setRestFreqs (const casa::Vector<casa::Double>& restFreqs, |
---|
| 126 | const casa::String& unit, |
---|
[401] | 127 | const std::vector<std::string>& lines, |
---|
[392] | 128 | const casa::String& source, |
---|
| 129 | casa::Int whichIF=-1); |
---|
[386] | 130 | |
---|
[401] | 131 | // List lines |
---|
| 132 | void spectralLines() const; |
---|
| 133 | |
---|
[218] | 134 | // Get/Set flux unit |
---|
[206] | 135 | std::string getFluxUnit() const; |
---|
[218] | 136 | void setFluxUnit (const std::string& unit); |
---|
[206] | 137 | |
---|
[236] | 138 | // Set Instrument |
---|
| 139 | void setInstrument (const std::string& instrument); |
---|
| 140 | |
---|
[19] | 141 | // set the current value |
---|
[125] | 142 | virtual bool setIF(casa::Int whichIF=0); |
---|
| 143 | virtual bool setBeam(casa::Int whichBeam=0); |
---|
| 144 | virtual bool setPol(casa::Int whichPol=0); |
---|
[88] | 145 | |
---|
[303] | 146 | // REset cursor to 0 |
---|
| 147 | virtual void resetCursor(); |
---|
| 148 | |
---|
[88] | 149 | //sets the user mask applied to all spectra |
---|
[68] | 150 | virtual bool setMask(std::vector<int> whichChans); |
---|
[88] | 151 | // Hard flags the current spectrum, not reversible |
---|
| 152 | virtual void flag(int whichRow); |
---|
| 153 | |
---|
[19] | 154 | // return the currently selected values |
---|
[154] | 155 | virtual casa::Int getIF() const { return IFSel_; } |
---|
| 156 | virtual casa::Int getBeam() const { return beamSel_; } |
---|
| 157 | virtual casa::Int getPol() const { return polSel_; } |
---|
[263] | 158 | |
---|
| 159 | // returns unit, conversion frame, doppler, base-frame |
---|
[206] | 160 | virtual std::vector<std::string> getCoordInfo() const; |
---|
[88] | 161 | |
---|
[50] | 162 | // number of scans in table |
---|
[125] | 163 | virtual casa::Int nScan() const; |
---|
[50] | 164 | |
---|
[206] | 165 | // get a summary of the table |
---|
[380] | 166 | virtual std::string summary(bool verbose=false) const; |
---|
[88] | 167 | |
---|
[206] | 168 | std::vector<std::string> history(int whichRow=0) const; |
---|
| 169 | bool appendHistory(const std::string& hist, int whichRow=0); |
---|
[19] | 170 | // write to disk as aips++ table |
---|
[2] | 171 | void makePersistent(const std::string& filename); |
---|
[19] | 172 | |
---|
[88] | 173 | // get a new SDMemTable containing all rows with the same give SCANID |
---|
[164] | 174 | SDMemTable getScan(casa::Int scanID) const; |
---|
| 175 | SDMemTable getSource(const std::string& source) const; |
---|
[18] | 176 | |
---|
[125] | 177 | const casa::TableRecord& getHeader() const {return table_.keywordSet();} |
---|
[19] | 178 | // get a handle to the "raw" aips++ table |
---|
[138] | 179 | const casa::Table& table() const { return table_; } |
---|
[2] | 180 | |
---|
[19] | 181 | // return the number of values |
---|
[125] | 182 | casa::Int nBeam() const; |
---|
| 183 | casa::Int nIF() const; |
---|
| 184 | casa::Int nPol() const; |
---|
| 185 | casa::Int nChan() const; |
---|
[18] | 186 | |
---|
[22] | 187 | // return the number of rows (integrations) in the table |
---|
[125] | 188 | casa::Int nRow() const { return table_.nrow(); } |
---|
[22] | 189 | |
---|
[19] | 190 | // return a row as a Masked array, internally converting uChar flags |
---|
| 191 | // to bool mask |
---|
[125] | 192 | casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow, |
---|
[206] | 193 | casa::Bool useSelection = |
---|
| 194 | casa::False) const; |
---|
[19] | 195 | |
---|
[286] | 196 | // Return SC, setting only the basic construction state (i.e. |
---|
[306] | 197 | // no conversion or velocity or rest frequency state). |
---|
| 198 | // Specify the index of the FreqID you want |
---|
[286] | 199 | casa::SpectralCoordinate getSpectralCoordinate(casa::uInt whichIdx) const; |
---|
| 200 | |
---|
[386] | 201 | // Return SC. Set velocity conversion state (unit,doppler), and |
---|
| 202 | // rest frequency. If row number given (>=0), also set |
---|
[286] | 203 | // frame conversion layer (needs direction & time which require row) |
---|
[386] | 204 | casa::SpectralCoordinate getSpectralCoordinate(casa::uInt freqID, |
---|
| 205 | casa::uInt restFreqID, |
---|
| 206 | casa::uInt row) const; |
---|
[286] | 207 | |
---|
| 208 | // Set just the reference value, pixel and increment into the table |
---|
| 209 | // No other state is extracted. |
---|
[125] | 210 | casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord, |
---|
| 211 | casa::uInt whichIdx); |
---|
[50] | 212 | |
---|
[125] | 213 | casa::Int nCoordinates() const; |
---|
[88] | 214 | |
---|
[164] | 215 | std::vector<double> getAbcissa(int whichRow=0) const; |
---|
| 216 | std::string getAbcissaString(casa::Int whichRow=0) const; |
---|
[212] | 217 | |
---|
[286] | 218 | // Get global reference types |
---|
[281] | 219 | casa::MDirection::Types getDirectionReference() const; |
---|
| 220 | casa::MEpoch::Types getTimeReference() const; |
---|
[212] | 221 | |
---|
[286] | 222 | // Get global antenna position |
---|
| 223 | casa::MPosition getAntennaPosition() const; |
---|
| 224 | |
---|
[418] | 225 | // Rotate phase of XY correlation by specified value (degrees) |
---|
| 226 | void rotateXYPhase (casa::Float angle); |
---|
| 227 | |
---|
[236] | 228 | // Helper function to check instrument (antenna) name and give enum |
---|
[281] | 229 | static Instrument convertInstrument(const casa::String& instrument, |
---|
| 230 | casa::Bool throwIt); |
---|
[236] | 231 | |
---|
[2] | 232 | private: |
---|
[105] | 233 | // utility func for nice printout |
---|
[260] | 234 | casa::String formatSec(casa::Double x) const; |
---|
[281] | 235 | casa::String formatDirection(const casa::MDirection& md) const; |
---|
[418] | 236 | std::vector<float> getFloatSpectrum (const casa::Array<casa::Float>& arr) const; |
---|
[2] | 237 | void setup(); |
---|
[322] | 238 | void attach(); |
---|
[380] | 239 | void renumber(); |
---|
[19] | 240 | // the current cursor into the array |
---|
[125] | 241 | casa::Int IFSel_,beamSel_,polSel_; |
---|
[88] | 242 | std::vector<bool> chanMask_; |
---|
[50] | 243 | // the underlying memory table |
---|
[125] | 244 | casa::Table table_; |
---|
[322] | 245 | |
---|
| 246 | // Cached Columns to avoid reconstructing them for each row get/put |
---|
| 247 | casa::ScalarColumn<casa::Double> timeCol_, integrCol_; |
---|
| 248 | casa::ScalarColumn<casa::Float> azCol_, elCol_, paraCol_; |
---|
| 249 | casa::ScalarColumn<casa::String> srcnCol_, fldnCol_, tcaltCol_; |
---|
| 250 | casa::ScalarColumn<casa::Int> scanCol_, rbeamCol_; |
---|
| 251 | casa::ArrayColumn<casa::Float> specCol_, tsCol_, tcalCol_; |
---|
| 252 | casa::ArrayColumn<casa::Double> dirCol_; |
---|
| 253 | casa::ArrayColumn<casa::uChar> flagsCol_; |
---|
[386] | 254 | casa::ArrayColumn<casa::uInt> freqidCol_, restfreqidCol_; |
---|
[322] | 255 | casa::ArrayColumn<casa::String> histCol_; |
---|
[418] | 256 | casa::ArrayColumn<casa::Float> stokesCol_; |
---|
[2] | 257 | }; |
---|
| 258 | |
---|
| 259 | }// namespace |
---|
| 260 | #endif |
---|