source: trunk/src/SDMemTable.h @ 164

Last change on this file since 164 was 164, checked in by kil064, 19 years ago

make a few more functions 'const'

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 5.9 KB
RevLine 
[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++
[80]38#include <casa/aips.h>
39#include <casa/BasicSL/String.h>
40#include <tables/Tables/Table.h>
41#include <casa/Arrays/MaskedArray.h>
[2]42
[80]43#include <coordinates/Coordinates/SpectralCoordinate.h>
[39]44
[83]45namespace asap {
[2]46
47class SDContainer;
48class SDHeader;
49class SDFrequencyTable;
50
51
52class SDMemTable {
53public:
[19]54  // create a new (empty) SDMemTable
[18]55  SDMemTable();
[50]56  // create a SDMemTable from an (aips++) table on disk
[18]57  SDMemTable(const std::string& name);
[19]58
59  // Copy Construct a SDMemTable, if clear==True only header and
60  // skeleton are copied, otherwise the whole table is copied.
[147]61  SDMemTable(const SDMemTable& other, casa::Bool clear=casa::False);
[2]62
[161]63  // Copy Construct (copy semantics) a SDMemTable, give a scanid constraint
[19]64  // see also getScan()
[125]65  SDMemTable(const casa::Table& tab, const std::string& expr);
[161]66
67  // Assignment operator (copy semantics) 
[138]68  SDMemTable &operator=(const SDMemTable& other);
69 
[2]70  virtual ~SDMemTable();
[19]71
72  // put data from meta conatiner into the table
[39]73  bool putSDContainer(const SDContainer& sdc);
74  bool putSDHeader(const SDHeader& sdh);
75  bool putSDFreqTable(const SDFrequencyTable& sdft);
[21]76
[161]77  //get the data wrapped up in a meta container
[125]78  SDContainer getSDContainer(casa::uInt whichRow=0) const;
[39]79  SDHeader getSDHeader() const;
80  SDFrequencyTable getSDFreqTable() const;
[19]81  // get spectrum,mask and tsys for the given row, at the selected
[21]82  // cursor - all as stl vectors
[125]83  virtual std::vector<float> getSpectrum(casa::Int whichRow=0) const;
84  virtual std::vector<bool> getMask(casa::Int whichRow=0) const;
[21]85
[125]86  virtual casa::Float getTsys(casa::Int whichRow=0) const;
[21]87  // get all as aips++ Vectors
[125]88  virtual void getSpectrum(casa::Vector<casa::Float>& spectrum,
[164]89                           casa::Int whichRow=0) const;
[2]90
[88]91  //virtual void getMask(Vector<Bool>& mask,Int whichRow=0) const;
92
[21]93  // get info for current row
[125]94  std::string getTime(casa::Int whichRow=0) const ;
95  std::string getSourceName(casa::Int whichRow=0) const;
96  double getInterval(casa::Int whichRow=0) const;
[50]97
[88]98  virtual void setSpectrum(std::vector<float> spectrum, int whichRow=0);
[125]99  virtual void setRestFreqs(std::vector<double> freqs,
100                            const std::string& theunit);
[105]101  virtual void setCoordInfo(std::vector<string> theinfo);
[19]102  // set the current value
[125]103  virtual bool setIF(casa::Int whichIF=0);
104  virtual bool setBeam(casa::Int whichBeam=0);
105  virtual bool setPol(casa::Int whichPol=0);
[88]106
107  //sets the user mask applied to all spectra
[68]108  virtual bool setMask(std::vector<int> whichChans);
[88]109  // Hard flags the current spectrum, not reversible
110  virtual void flag(int whichRow);
111
[19]112  // return the currently selected values
[154]113  virtual casa::Int getIF() const { return IFSel_; }
114  virtual casa::Int getBeam() const { return beamSel_; }
115  virtual casa::Int getPol() const { return polSel_; }
[105]116  virtual std::vector<string> getCoordInfo() const;
[88]117
[50]118  // number of scans in table
[125]119  virtual casa::Int nScan() const;
[50]120
[19]121  // print a summary to stdout
[105]122  virtual std::string summary();
[88]123
[19]124  // write to disk as aips++ table
[2]125  void makePersistent(const std::string& filename);
[19]126
[88]127  // get a new SDMemTable containing all rows with the same give SCANID
[164]128  SDMemTable getScan(casa::Int scanID) const;
129  SDMemTable getSource(const std::string& source) const;
[18]130
[125]131  const casa::TableRecord& getHeader() const {return table_.keywordSet();}
[19]132  // get a handle to the "raw" aips++ table
[138]133  const casa::Table& table() const { return table_; }
[2]134
[19]135  // return the number of values
[125]136  casa::Int nBeam() const;
137  casa::Int nIF() const;
138  casa::Int nPol() const;
139  casa::Int nChan() const;
[18]140
[22]141  // return the number of rows (integrations) in the table
[125]142  casa::Int nRow() const { return table_.nrow(); }
[22]143
[19]144  // return a row as a Masked array, internally converting uChar flags
145  // to bool mask
[125]146  casa::MaskedArray<casa::Float> rowAsMaskedArray(casa::uInt whichRow,
[164]147                                                  casa::Bool useSelection = casa::False) const;
[19]148
[125]149  casa::SpectralCoordinate getCoordinate(casa::uInt whichIdx) const;
150  casa::Bool setCoordinate(const casa::SpectralCoordinate& speccord,
151                           casa::uInt whichIdx);
[50]152
[125]153  casa::Int nCoordinates() const;
[88]154
[164]155  std::vector<double> getAbcissa(int whichRow=0) const;
156  std::string getAbcissaString(casa::Int whichRow=0) const;
[105]157
[2]158private:
[105]159  // utility func for nice printout
[125]160  casa::String formatSec(casa::Double x);
[2]161  void setup();
[19]162  // the current cursor into the array
[125]163  casa::Int IFSel_,beamSel_,polSel_;
[88]164  std::vector<bool> chanMask_;
[50]165  // the underlying memory table
[125]166  casa::Table table_;
[2]167};
168
169}// namespace
170#endif
Note: See TracBrowser for help on using the repository browser.