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