source: trunk/src/SDMath.h@ 316

Last change on this file since 316 was 315, checked in by kil064, 20 years ago

add arg 'weightStr' to function SDMath::averagePol
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 8.9 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/FrequencyAligner.h>
39
40#include "SDDefs.h"
41
42class casa::Table;
43class casa::MEpoch;
44class casa::MPosition;
45template<class T> class casa::PtrBlock;
46
47
48namespace asap {
49
50class SDMemTable;
51
52class SDMath {
53
54 public:
55
56// Default constructor
57 SDMath();
58
59// Copy Constructor (copy semantics)
60 SDMath (const SDMath& other);
61
62// Assignment (copy semantics)
63 SDMath &operator=(const SDMath& other);
64
65// Destructor
66 ~SDMath();
67
68// Binary Table operators. op=ADD, SUB, MUL, DIV, QUOTIENT
69 casa::CountedPtr<SDMemTable> binaryOperate (const casa::CountedPtr<SDMemTable>& left,
70 const casa::CountedPtr<SDMemTable>& right,
71 const casa::String& op, casa::Bool preserve,
72 casa::Bool tSys) const;
73
74// Average in time
75 casa::CountedPtr<SDMemTable> average(const casa::Block<casa::CountedPtr<SDMemTable> >& in,
76 const casa::Vector<casa::Bool>& mask,
77 casa::Bool scanAverage,
78 const casa::String& weightStr,
79 casa::Bool align=casa::False) const;
80
81// Statistics. If row<0, all rows are done otherwise, just the
82// specified row.
83 std::vector<float> statistic(const casa::CountedPtr<SDMemTable>& in,
84 const casa::Vector<casa::Bool>& mask,
85 const casa::String& which, casa::Int row) const;
86
87// Bin up spectra
88 SDMemTable* bin(const SDMemTable& in, casa::Int width) const;
89
90// Resample spectra
91 SDMemTable* resample(const SDMemTable& in, const casa::String& method,
92 casa::Float factor) const;
93
94// Smooth
95 SDMemTable* smooth (const SDMemTable& in, const casa::String& kernel,
96 casa::Float width, casa::Bool doAll) const;
97
98// Flux conversion between Jansky and Kelvin
99 SDMemTable* convertFlux (const SDMemTable& in, casa::Float area,
100 casa::Float eta, casa::Bool doAll) const;
101
102// Gain-elevation correction
103 SDMemTable* gainElevation (const SDMemTable& in, const casa::Vector<casa::Float>& coeffs,
104 const casa::String& fileName,
105 const casa::String& method, casa::Bool doAll) const;
106
107// Frequency Alignment
108 SDMemTable* frequencyAlignment (const SDMemTable& in, const casa::String& refTime) const;
109
110// Opacity correction
111 SDMemTable* opacity (const SDMemTable& in, casa::Float tau, casa::Bool doAll) const;
112
113// Simple unary mathematical operations. what=0 (mul) or 1 (add)
114 SDMemTable* unaryOperate(const SDMemTable& in, casa::Float offset,
115 casa::Bool doAll, casa::uInt what, casa::Bool tSys) const;
116
117// Average polarizations
118 SDMemTable* averagePol(const SDMemTable& in, const casa::Vector<casa::Bool>& mask,
119 const casa::String& wtStr) 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 frequency aligners
197 void generateFrequencyAligners (casa::PtrBlock<casa::FrequencyAligner<casa::Float>* >& a,
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 system,
202 const casa::MPosition& refPos,
203 const casa::MEpoch& refEpoch) const;
204
205// Align in Frequency
206 SDMemTable* frequencyAlign (const SDMemTable& in,
207 casa::MFrequency::Types system,
208 const casa::String& timeRef) const;
209
210// Convert time String to Epoch
211 casa::MEpoch epochFromString (const casa::String& str, casa::MEpoch::Types timeRef) const;
212
213// Format EPoch
214 casa::String formatEpoch(const casa::MEpoch& epoch) const;
215};
216
217} // namespace
218
219#endif
Note: See TracBrowser for help on using the repository browser.