source: trunk/src/SDMath.h @ 303

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

add resample function
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.1 KB
Line 
1//#---------------------------------------------------------------------------
2//# SDMath.h: A collection of single dish mathematical operations
3//#---------------------------------------------------------------------------
4//# Copyright (C) 2004
5//# ATNF
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//#---------------------------------------------------------------------------
31#ifndef SDMATH_H
32#define SDMATH_H
33
34#include <string>
35#include <vector>
36#include <casa/aips.h>
37#include <casa/Utilities/CountedPtr.h>
38#include <coordinates/Coordinates/VelocityAligner.h>
39
40#include "SDDefs.h"
41
42class casa::Table;
43class casa::MEpoch;
44class casa::MPosition;
45template<class T> class casa::PtrBlock;
46//template<class T> class casa::VelocityAligner;
47
48
49namespace asap {
50
51class SDMemTable;
52
53class SDMath {
54
55 public:
56
57// Default constructor
58   SDMath();
59
60// Copy Constructor (copy semantics)
61   SDMath (const SDMath& other);
62
63// Assignment  (copy semantics)
64   SDMath &operator=(const SDMath& other);
65
66// Destructor
67   ~SDMath();
68
69// Binary Table operators. op=ADD, SUB, MUL, DIV, QUOTIENT
70   casa::CountedPtr<SDMemTable> binaryOperate (const casa::CountedPtr<SDMemTable>& left,
71                                               const casa::CountedPtr<SDMemTable>& right,
72                                               const casa::String& op, casa::Bool preserve,
73                                               casa::Bool tSys) const;
74
75// Average in time
76   casa::CountedPtr<SDMemTable>  average(const casa::Block<casa::CountedPtr<SDMemTable> >& in,
77                                         const casa::Vector<casa::Bool>& mask,
78                                         casa::Bool scanAverage,
79                                         const casa::String& weightStr,
80                                         casa::Bool alignVelocity=casa::False) const;
81
82// Statistics. If row<0, all rows are done otherwise, just the
83// specified row.
84   std::vector<float> statistic(const casa::CountedPtr<SDMemTable>& in,
85                                const casa::Vector<casa::Bool>& mask,
86                                const casa::String& which, casa::Int row) const;
87
88// Bin up spectra
89   SDMemTable* bin(const SDMemTable& in, casa::Int width) const;
90
91// Resample spectra
92   SDMemTable* resample(const SDMemTable& in, const casa::String& method,
93                        casa::Float factor) const;
94
95// Smooth
96   SDMemTable* smooth (const SDMemTable& in, const casa::String& kernel,
97                       casa::Float width, casa::Bool doAll) const;
98
99// Flux conversion between Jansky and Kelvin
100   SDMemTable* convertFlux (const SDMemTable& in, casa::Float area,
101                            casa::Float eta, casa::Bool doAll) const;
102
103// Gain-elevation correction
104   SDMemTable* gainElevation (const SDMemTable& in, const casa::Vector<casa::Float>& coeffs,
105                              const casa::String& fileName,
106                              const casa::String& method, casa::Bool doAll) const;
107
108// Velocity Alignment
109   SDMemTable* velocityAlignment (const SDMemTable& in, const casa::String& refTime) const;
110
111// Opacity correction
112   SDMemTable* opacity (const SDMemTable& in, casa::Float tau, casa::Bool doAll) const;
113
114// Simple unary mathematical operations.  what=0 (mul) or 1 (add)
115   SDMemTable* unaryOperate(const SDMemTable& in, casa::Float offset,
116                            casa::Bool doAll, casa::uInt what, casa::Bool tSys) const;
117
118// Average polarizations
119   SDMemTable* averagePol(const SDMemTable& in, const casa::Vector<casa::Bool>& mask) const;
120
121 private:
122
123// Weighting type for time averaging
124
125  enum WeightType {NONE,VAR,TSYS};
126
127// Function to use accumulate data during time averaging
128
129  void accumulate (casa::Double& timeSum, casa::Double& intSum, casa::Int& nAccum,
130                   casa::MaskedArray<casa::Float>& sum, casa::Array<casa::Float>& sumSq,
131                   casa::Array<casa::Float>& nPts, casa::Array<casa::Float>& tSysSum,
132                   const casa::Array<casa::Float>& tSys,  const casa::Array<casa::Float>& nInc,
133                   const casa::Vector<casa::Bool>& mask, casa::Double time, casa::Double interval,
134                   const casa::Block<casa::CountedPtr<SDMemTable> >& in,
135                   casa::uInt iTab, casa::uInt iRow, casa::uInt axis, casa::uInt nAxesSub,
136                   casa::Bool useMask, WeightType wtType) const;
137
138// Function to fill Scan Container when averaging in time
139
140  void fillSDC (SDContainer& sc, const casa::Array<casa::Bool>& mask,
141                const casa::Array<casa::Float>& data,
142                const casa::Array<casa::Float>& tSys,
143                casa::Int scanID, casa::Double timeStamp,
144                casa::Double interval, const casa::String& sourceName,
145                const casa::Vector<casa::uInt>& freqID) const;
146
147// Put the data and mask into the SDContainer
148   void putDataInSDC (SDContainer& sc, const casa::Array<casa::Float>& data,
149                      const casa::Array<casa::Bool>& mask) const;
150
151// Function to normalize data when averaging in time
152
153  void normalize (casa::MaskedArray<casa::Float>& data,
154                  const casa::Array<casa::Float>& sumSq,
155                  const casa::Array<casa::Float>& nPts,
156                  WeightType wtType, casa::Int axis, casa::Int nAxes) const;
157
158// Function to get the current cursor location
159   void getCursorLocation (casa::IPosition& start, casa::IPosition& end,
160                           const SDMemTable& in) const;
161
162// Convert weight string to enum value
163
164   void convertWeightString (WeightType& wt, const casa::String& weightStr) const;
165
166// Convert interpolation type string
167   void convertInterpString(casa::Int& type, const casa::String& interp) const;
168
169// Correct data from an ascii Table
170   void correctFromAsciiTable(SDMemTable* pTabOut, const SDMemTable& in,
171                              const casa::String& fileName,
172                              const casa::String& col0, const casa::String& col1,
173                              const casa::String& methodStr, casa::Bool doAll,
174                              const casa::Vector<casa::Float>& xOut) const;
175
176// Correct data from a Table
177   void correctFromTable(SDMemTable* pTabOut, const SDMemTable& in, const casa::Table& tTable,
178                         const casa::String& col0, const casa::String& col1,
179                         const casa::String& methodStr, casa::Bool doAll,
180                         const casa::Vector<casa::Float>& xOut) const;
181
182// Correct data from a Vector
183   void correctFromVector (SDMemTable* pTabOut, const SDMemTable& in,
184                           casa::Bool doAll, const casa::Vector<casa::Float>& factor) const;
185
186// Read ascii file into a Table
187
188   casa::Table readAsciiFile (const casa::String& fileName) const;
189
190// Generate source table
191   void generateSourceTable (casa::Vector<casa::String>& srcTab,
192                             casa::Vector<casa::uInt>& srcIdx,
193                             casa::Vector<casa::uInt>& firstRow,
194                             const casa::Vector<casa::String>& srcNames) const;
195
196// Generate velocity aligners
197   void generateVelocityAligners (casa::PtrBlock<casa::VelocityAligner<casa::Float>* >& vA,
198                                  const SDMemTable& in, casa::uInt nChan,
199                                  casa::uInt nFreqIDs, casa::uInt nSrcTab,
200                                  const casa::Vector<casa::uInt>& firstRow,
201                                  casa::MFrequency::Types velSystem,
202                                  const casa::String& velUnit,
203                                  casa::MDoppler::Types doppler,
204                                  const casa::MPosition& refPos,
205                                  const casa::MEpoch& refEpoch) const;
206
207// Align in Velocity
208   SDMemTable* velocityAlign (const SDMemTable& in,
209                              casa::MFrequency::Types velSystem,
210                              const casa::String& velUnit,
211                              casa::MDoppler::Types doppler,
212                              const casa::String& timeRef) const;
213
214// Convert time String to Epoch
215   casa::MEpoch epochFromString (const casa::String& str, casa::MEpoch::Types timeRef) const;
216
217// Format EPoch
218   casa::String formatEpoch(const casa::MEpoch& epoch)  const;
219};
220
221} // namespace
222
223#endif
Note: See TracBrowser for help on using the repository browser.