casacore
MCuvw.h
Go to the documentation of this file.
1 //# MCuvw.h: Muvw conversion routines
2 //# Copyright (C) 1998-2000,2002,2004,2007
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be addressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //#
27 //# $Id$
28 
29 #ifndef MEASURES_MCUVW_H
30 #define MEASURES_MCUVW_H
31 
32 //# Includes
33 #include <casacore/casa/aips.h>
34 #include <casacore/measures/Measures/Muvw.h>
35 #include <casacore/measures/Measures/MeasBase.h>
36 #include <casacore/measures/Measures/MeasRef.h>
37 #include <casacore/measures/Measures/MCBase.h>
38 #include <casacore/measures/Measures/MConvertBase.h>
39 #include <casacore/measures/Measures/MeasMath.h>
40 #include <casacore/casa/Arrays/ArrayFwd.h>
41 #include <casacore/casa/Quanta/MVDirection.h>
42 
43 #include <mutex>
44 
45 namespace casacore { //# NAMESPACE CASACORE - BEGIN
46 
47 //# Forward Declarations
48 class MCuvw;
49 class String;
50 
51 //# Typedefs
52 
53 // <summary> Muvw conversion routines </summary>
54 
55 // <use visibility=local>
56 
57 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMuvw" demos="">
58 // </reviewed>
59 
60 // <prerequisite>
61 // <li> <linkto class=Measure>Measure</linkto> class
62 // <li> <linkto class=MCBase>MCBase</linkto> base class
63 // <li> <linkto class=MConvertBase>overall conversion</linkto> class
64 // </prerequisite>
65 //
66 // <etymology>
67 // Measure, Convert and uvw
68 // </etymology>
69 //
70 // <synopsis>
71 // Contains state machinery and caching for actual conversions
72 // </synopsis>
73 //
74 // <example>
75 // See <linkto module=Measures>Measures</linkto> module description for
76 // conversion examples.
77 // </example>
78 //
79 // <motivation>
80 // </motivation>
81 //
82 // <todo asof="1998/04/21">
83 // <li> Cater for EW baselines
84 // </todo>
85 
86 class MCuvw : public MCBase {
87 
88 public:
89 
90  //# Friends
91  // Conversion of data
92  friend class MeasConvert<Muvw>;
93 
94  //# Constructors
95  // Default constructor
96  MCuvw();
97 
98  //# Destructor
99  ~MCuvw();
100 
101  //# Member functions
102  // Show the state of the conversion engine (mainly for debugging purposes)
103  static String showState();
104 
105 private:
106  //# Enumerations
107  // The list of actual routines provided.
108  // <note role=warning> Each <src>AA_BB</src> in the list points to routine
109  // that can be used in the FromTo list in the getConvert routine.
110  // In addition the type to which each is converted should be in the
111  // ToRef array, again in the proper order. </note>
112  enum Routes {
161  N_Routes
162  };
163 
164  //# Typedefs
165 
166  //# Operators
167 
168  //# General Member Functions
169 
170  //# Enumerations
171 
172  //# Cached Data
173  // Calculation class
175  // Belonging direction
177 
178  //# State machine data
179  // Transition list
180  static uInt ToRef_p[N_Routes][3];
181  // Transition matrix
183  // Object to ensure safe multi-threaded lazy single initialization
184  static std::once_flag theirInitOnceFlag;
185 
186  //# Constructors
187  // Copy constructor (not implemented)
188  MCuvw(const MCuvw &other);
189  // Assignment (not implemented)
190  MCuvw &operator=(const MCuvw &other);
191 
192  //# Member functions
193 
194  // Create conversion function pointer
195  virtual void getConvert(MConvertBase &mc,
196  const MRBase &inref,
197  const MRBase &outref);
198 
199  // Create help structures for Measure conversion routines
200  virtual void initConvert(uInt which, MConvertBase &mc);
201 
202  // Delete the pointers used in the MeasConvert help structure cache
203  virtual void clearConvert();
204 
205  // Routines to convert uvws from one reference frame to another
206  virtual void doConvert(MeasValue &in,
207  MRBase &inref,
208  MRBase &outref,
209  const MConvertBase &mc);
210  // Conversion routine to cater for inheritance question
211  void doConvert(MVuvw &in,
212  MRBase &inref,
213  MRBase &outref,
214  const MConvertBase &mc);
215  // Get the correct belonging direction from the frame
216  // <group>
217  void getAPP();
218  void getJ2000();
219  void getB1950();
220  // </group>
221  // Rotate from direction to pole
222  void toPole(MVPosition &in);
223  // Rotate from pole to direction
224  void fromPole(MVPosition &in);
225 
226 private:
227  // Fill the global state. Called using theirInitOnce.
228  static void doFillState();
229 };
230 
231 
232 } //# NAMESPACE CASACORE - END
233 
234 #endif
235 
Routes
Each derived class should have a list of routines to be called:
Definition: MCBase.h:134
static void doFillState()
Fill the global state.
void toPole(MVPosition &in)
Rotate from direction to pole.
MCuvw(const MCuvw &other)
Copy constructor (not implemented)
virtual void getConvert(MConvertBase &mc, const MRBase &inref, const MRBase &outref)
Create conversion function pointer.
@ J2000_B1950_VLA
Definition: MCuvw.h:118
@ AZELGEO_AZELSWGEO
Definition: MCuvw.h:142
@ B1950_VLA_B1950
Definition: MCuvw.h:122
@ B1950_VLA_J2000
Definition: MCuvw.h:120
@ AZELSWGEO_AZELGEO
Definition: MCuvw.h:144
@ B1950_B1950_VLA
Definition: MCuvw.h:121
static std::once_flag theirInitOnceFlag
Object to ensure safe multi-threaded lazy single initialization.
Definition: MCuvw.h:184
static uInt FromTo_p[Muvw::N_Types][Muvw::N_Types]
Transition matrix.
Definition: MCuvw.h:182
void getAPP()
Get the correct belonging direction from the frame.
void doConvert(MVuvw &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
Conversion routine to cater for inheritance question.
void fromPole(MVPosition &in)
Rotate from pole to direction.
virtual void clearConvert()
Delete the pointers used in the MeasConvert help structure cache.
virtual void doConvert(MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
Routines to convert uvws from one reference frame to another.
virtual void initConvert(uInt which, MConvertBase &mc)
Create help structures for Measure conversion routines.
MeasMath measMath
Calculation class.
Definition: MCuvw.h:174
MVDirection MVDIR1
Belonging direction.
Definition: MCuvw.h:176
MCuvw()
Default constructor.
static uInt ToRef_p[N_Routes][3]
Transition list.
Definition: MCuvw.h:180
MCuvw & operator=(const MCuvw &other)
Assignment (not implemented)
static String showState()
Show the state of the conversion engine (mainly for debugging purposes)
String: the storage and methods of handling collections of characters.
Definition: String.h:225
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51