source: branches/Release2.1.1/src/STMath.h@ 2231

Last change on this file since 2231 was 1287, checked in by mar637, 18 years ago

doxygen tag fixes
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.7 KB
Line 
1//
2// C++ Interface: STMath
3//
4// Description:
5//
6//
7// Author: Malte Marquarding <asap@atnf.csiro.au>, (C) 2006
8//
9// Copyright: See COPYING file that comes with this distribution
10//
11//
12#ifndef ASAPSTMATH_H
13#define ASAPSTMATH_H
14
15#include <string>
16#include <map>
17
18#include <casa/aips.h>
19#include <casa/Utilities/CountedPtr.h>
20#include <casa/BasicSL/String.h>
21#include <casa/Arrays/Vector.h>
22#include <scimath/Mathematics/InterpolateArray1D.h>
23
24#include "Scantable.h"
25#include "STDefs.h"
26#include "STPol.h"
27#include "Logger.h"
28
29namespace asap {
30
31/**
32 * Mathmatical operations on Scantable objects
33 * @author Malte Marquarding
34*/
35class STMath : private Logger {
36public:
37 // typedef for long method name
38 typedef casa::InterpolateArray1D<casa::Double,
39 casa::Float>::InterpolationMethod imethod;
40
41 // typedef for std::map
42 typedef std::map<std::string, imethod> imap;
43
44/**
45 * whether to operate on the given Scantable or return a new one
46 * @param insitu the toggle for this behaviour
47 */
48 STMath(bool insitu=true);
49
50 virtual ~STMath();
51
52 /**
53 * get the currnt @attr inistu_ state
54 */
55 bool insitu() const { return insitu_;};
56
57 /**
58 * set the currnt @attr inistu state
59 * @param b the new state
60 */
61 void setInsitu(bool b) { insitu_ = b; };
62
63
64 /**
65 * average a vector of Scantables
66 * @param in the vector of Scantables to average
67 * @param mask an optional mask to apply on specific weights
68 * @param weight weighting scheme
69 * @param avmode the mode ov averaging. Per "SCAN" or "ALL".
70 * @return a casa::CountedPtr<Scantable> which either holds a new Scantable
71 * or returns the imput pointer.
72 */
73 casa::CountedPtr<Scantable>
74 average( const std::vector<casa::CountedPtr<Scantable> >& in,
75 const std::vector<bool>& mask = std::vector<bool>(),
76 const std::string& weight = "NONE",
77 const std::string& avmode = "SCAN");
78
79 /**
80 * median average a vector of Scantables. See also STMath::average
81 * @param in the Scantable to average
82 * @param mode the averaging mode. Currently only "MEDIAN"
83 * @param avmode the mode ov averaging. Per "SCAN" or "ALL".
84 * @return a casa::CountedPtr<Scantable> which either holds a new Scantable
85 * or returns the imput pointer.
86 */
87 casa::CountedPtr<Scantable>
88 averageChannel( const casa::CountedPtr<Scantable> & in,
89 const std::string& mode = "MEDIAN",
90 const std::string& avmode = "SCAN");
91
92 /**
93 * Average polarisations together. really only useful if only linears are
94 * available.
95 * @param in the input Scantable
96 * @param mask an optional mask if weight allows one
97 * @param weight weighting scheme
98 * @return
99 */
100 casa::CountedPtr< Scantable >
101 averagePolarisations( const casa::CountedPtr< Scantable > & in,
102 const std::vector<bool>& mask,
103 const std::string& weight );
104
105 /**
106 * Average beams together.
107 * @param in the input Scantable
108 * @param mask an optional mask if weight allows one
109 * @param weight weighting scheme
110 * @return
111 */
112 casa::CountedPtr< Scantable >
113 averageBeams( const casa::CountedPtr< Scantable > & in,
114 const std::vector<bool>& mask,
115 const std::string& weight );
116
117 casa::CountedPtr<Scantable>
118 unaryOperate( const casa::CountedPtr<Scantable>& in, float val,
119 const std::string& mode, bool tsys=false );
120
121 casa::CountedPtr<Scantable> autoQuotient(const casa::CountedPtr<Scantable>& in,
122 const std::string& mode = "NEAREST",
123 bool preserve = true);
124
125 casa::CountedPtr<Scantable> quotient( const casa::CountedPtr<Scantable>& on,
126 const casa::CountedPtr<Scantable>& off,
127 bool preserve = true );
128
129 casa::CountedPtr<Scantable>
130 freqSwitch( const casa::CountedPtr<Scantable>& in );
131
132 std::vector<float> statistic(const casa::CountedPtr<Scantable>& in,
133 const std::vector<bool>& mask,
134 const std::string& which);
135
136 casa::CountedPtr<Scantable> bin( const casa::CountedPtr<Scantable>& in,
137 int width=5);
138 casa::CountedPtr<Scantable>
139 resample(const casa::CountedPtr<Scantable>& in,
140 const std::string& method, float width);
141
142 casa::CountedPtr<Scantable>
143 smooth(const casa::CountedPtr<Scantable>& in, const std::string& kernel,
144 float width);
145
146 casa::CountedPtr<Scantable>
147 gainElevation(const casa::CountedPtr<Scantable>& in,
148 const std::vector<float>& coeff,
149 const std::string& fileName,
150 const std::string& method);
151 casa::CountedPtr<Scantable>
152 convertFlux(const casa::CountedPtr<Scantable>& in, float d,
153 float etaap, float jyperk);
154
155 casa::CountedPtr<Scantable> opacity(const casa::CountedPtr<Scantable>& in,
156 float tau);
157
158 casa::CountedPtr<Scantable>
159 merge(const std::vector<casa::CountedPtr<Scantable> >& in);
160
161 casa::CountedPtr<Scantable>
162 invertPhase( const casa::CountedPtr<Scantable>& in);
163
164 casa::CountedPtr<Scantable>
165 rotateXYPhase( const casa::CountedPtr<Scantable>& in, float phase);
166
167 casa::CountedPtr<Scantable>
168 rotateLinPolPhase( const casa::CountedPtr<Scantable>& in, float phase);
169
170 casa::CountedPtr<Scantable>
171 swapPolarisations(const casa::CountedPtr<Scantable>& in);
172
173 casa::CountedPtr<Scantable>
174 frequencyAlign( const casa::CountedPtr<Scantable>& in,
175 const std::string& refTime = "",
176 const std::string& method = "cubic" );
177
178 casa::CountedPtr<Scantable>
179 convertPolarisation( const casa::CountedPtr<Scantable>& in,
180 const std::string& newtype);
181
182 casa::CountedPtr<Scantable>
183 mxExtract( const casa::CountedPtr<Scantable>& in,
184 const std::string& srctype = "on");
185
186 /**
187 * "hard" flag the data, this flags everything selected in setSelection()
188 * @param frequency the frequency to remove
189 * @param width the number of lags to flag left to the side of the frequency
190 */
191 casa::CountedPtr<Scantable>
192 lagFlag( const casa::CountedPtr<Scantable>& in, double frequency,
193 double width);
194
195private:
196 casa::CountedPtr<Scantable> applyToPol( const casa::CountedPtr<Scantable>& in,
197 STPol::polOperation fptr,
198 casa::Float phase);
199
200 static imethod stringToIMethod(const std::string& in);
201 static WeightType stringToWeight(const std::string& in);
202
203 void scaleByVector(casa::Table& in,
204 const casa::Vector<casa::Float>& factor,
205 bool dotsys);
206
207 void scaleFromAsciiTable(casa::Table& in, const std::string& filename,
208 const std::string& method,
209 const casa::Vector<casa::Float>& xout,
210 bool dotsys);
211
212 void scaleFromTable(casa::Table& in, const casa::Table& table,
213 const std::string& method,
214 const casa::Vector<casa::Float>& xout, bool dotsys);
215
216 void convertBrightnessUnits(casa::CountedPtr<Scantable>& in,
217 bool tokelvin, float cfac);
218
219 casa::CountedPtr< Scantable >
220 getScantable(const casa::CountedPtr< Scantable >& in, bool droprows);
221
222 casa::MaskedArray<casa::Float>
223 maskedArray( const casa::Vector<casa::Float>& s,
224 const casa::Vector<casa::uChar>& f );
225 casa::Vector<casa::uChar>
226 flagsFromMA(const casa::MaskedArray<casa::Float>& ma);
227
228 bool insitu_;
229};
230
231}
232#endif
Note: See TracBrowser for help on using the repository browser.