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 | |
---|
39 | namespace asap { |
---|
40 | |
---|
41 | class SDMemTable; |
---|
42 | |
---|
43 | class SDMath { |
---|
44 | |
---|
45 | public: |
---|
46 | |
---|
47 | // Default constructor |
---|
48 | SDMath(); |
---|
49 | |
---|
50 | // Copy Constructor (copy semantics) |
---|
51 | SDMath (const SDMath& other); |
---|
52 | |
---|
53 | // Assignment (copy semantics) |
---|
54 | SDMath &operator=(const SDMath& other); |
---|
55 | |
---|
56 | // Destructor |
---|
57 | ~SDMath(); |
---|
58 | |
---|
59 | // Quotient |
---|
60 | casa::CountedPtr<SDMemTable> quotient(const casa::CountedPtr<SDMemTable>& on, |
---|
61 | const casa::CountedPtr<SDMemTable>& off); |
---|
62 | |
---|
63 | // Average in time |
---|
64 | casa::CountedPtr<SDMemTable> average(const casa::Block<casa::CountedPtr<SDMemTable> >& in, |
---|
65 | const casa::Vector<casa::Bool>& mask, |
---|
66 | casa::Bool scanAverage, const std::string& weightStr); |
---|
67 | |
---|
68 | // Statistics |
---|
69 | std::vector<float> statistic(const casa::CountedPtr<SDMemTable>& in, |
---|
70 | const std::vector<bool>& mask, const casa::String& which); |
---|
71 | |
---|
72 | // Bin up spectra |
---|
73 | SDMemTable* bin(const SDMemTable& in, casa::Int width); |
---|
74 | |
---|
75 | // Smooth |
---|
76 | SDMemTable* smooth (const SDMemTable& in, const casa::String& kernel, |
---|
77 | casa::Float width, casa::Bool doAll); |
---|
78 | |
---|
79 | // Simple mathematical operations. what=0 (mul) or 1 (add) |
---|
80 | SDMemTable* simpleOperate(const SDMemTable& in, casa::Float offset, |
---|
81 | casa::Bool doAll, casa::uInt what); |
---|
82 | |
---|
83 | // Average polarizations |
---|
84 | SDMemTable* averagePol(const SDMemTable& in, const casa::Vector<casa::Bool>& mask); |
---|
85 | |
---|
86 | private: |
---|
87 | |
---|
88 | // Weighting type for time averaging |
---|
89 | |
---|
90 | enum WeightType {NONE,VAR,TSYS}; |
---|
91 | |
---|
92 | // Function to use accumulate data during time averaging |
---|
93 | |
---|
94 | void accumulate (casa::Double& timeSum, casa::Double& intSum, casa::Int& nAccum, |
---|
95 | casa::MaskedArray<casa::Float>& sum, casa::Array<casa::Float>& sumSq, |
---|
96 | casa::Array<casa::Float>& nPts, casa::Array<casa::Float>& tSysSum, |
---|
97 | const casa::Array<casa::Float>& tSys, const casa::Array<casa::Float>& nInc, |
---|
98 | const casa::Vector<casa::Bool>& mask, casa::Double time, casa::Double interval, |
---|
99 | const casa::Block<casa::CountedPtr<SDMemTable> >& in, |
---|
100 | casa::uInt iTab, casa::uInt iRow, casa::uInt axis, casa::uInt nAxesSub, |
---|
101 | casa::Bool useMask, WeightType wtType); |
---|
102 | |
---|
103 | // Function to fill Scan Container when averaging in time |
---|
104 | |
---|
105 | void fillSDC (SDContainer& sc, const casa::Array<casa::Bool>& mask, |
---|
106 | const casa::Array<casa::Float>& data, |
---|
107 | const casa::Array<casa::Float>& tSys, |
---|
108 | casa::Int scanID, casa::Double timeStamp, |
---|
109 | casa::Double interval, const casa::String& sourceName, |
---|
110 | const casa::Vector<casa::uInt>& freqID); |
---|
111 | |
---|
112 | // Put the data and mask into the SDContainer |
---|
113 | void putDataInSDC (SDContainer& sc, const casa::Array<casa::Float>& data, |
---|
114 | const casa::Array<casa::Bool>& mask); |
---|
115 | |
---|
116 | // Function to normalize data when averaging in time |
---|
117 | |
---|
118 | void normalize (casa::MaskedArray<casa::Float>& data, |
---|
119 | const casa::Array<casa::Float>& sumSq, |
---|
120 | const casa::Array<casa::Float>& nPts, |
---|
121 | WeightType wtType, casa::Int axis, casa::Int nAxes); |
---|
122 | |
---|
123 | // Function to get the current cursor location |
---|
124 | void getCursorLocation (casa::IPosition& start, casa::IPosition& end, |
---|
125 | const SDMemTable& in); |
---|
126 | |
---|
127 | // Convert weight string to enum value |
---|
128 | |
---|
129 | void convertWeightString (WeightType& wt, const std::string& weightStr); |
---|
130 | }; |
---|
131 | |
---|
132 | } // namespace |
---|
133 | |
---|
134 | #endif |
---|