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