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/Quanta/MVDirection.h>
41 #include <casacore/casa/OS/Mutex.h>
42 
43 namespace casacore { //# NAMESPACE CASACORE - BEGIN
44 
45 //# Forward Declarations
46 class MCuvw;
47 class String;
48 template <class T> class Vector;
49 
50 //# Typedefs
51 
52 // <summary> Muvw conversion routines </summary>
53 
54 // <use visibility=local>
55 
56 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMuvw" demos="">
57 // </reviewed>
58 
59 // <prerequisite>
60 // <li> <linkto class=Measure>Measure</linkto> class
61 // <li> <linkto class=MCBase>MCBase</linkto> base class
62 // <li> <linkto class=MConvertBase>overall conversion</linkto> class
63 // </prerequisite>
64 //
65 // <etymology>
66 // Measure, Convert and uvw
67 // </etymology>
68 //
69 // <synopsis>
70 // Contains state machinery and caching for actual conversions
71 // </synopsis>
72 //
73 // <example>
74 // See <linkto module=Measures>Measures</linkto> module description for
75 // conversion examples.
76 // </example>
77 //
78 // <motivation>
79 // </motivation>
80 //
81 // <todo asof="1998/04/21">
82 // <li> Cater for EW baselines
83 // </todo>
84 
85 class MCuvw : public MCBase {
86 
87 public:
88 
89  //# Friends
90  // Conversion of data
91  friend class MeasConvert<Muvw>;
92 
93  //# Constructors
94  // Default constructor
95  MCuvw();
96 
97  //# Destructor
98  ~MCuvw();
99 
100  //# Member functions
101  // Show the state of the conversion engine (mainly for debugging purposes)
102  static String showState();
103 
104 private:
105  //# Enumerations
106  // The list of actual routines provided.
107  // <note role=warning> Each <src>AA_BB</src> in the list points to routine
108  // that can be used in the FromTo list in the getConvert routine.
109  // In addition the type to which each is converted should be in the
110  // ToRef array, again in the proper order. </note>
111  enum Routes {
160  N_Routes
161  };
162 
163  //# Typedefs
164 
165  //# Operators
166 
167  //# General Member Functions
168 
169  //# Enumerations
170 
171  //# Cached Data
172  // Calculation class
174  // Belonging direction
176 
177  //# State machine data
178  // Transition list
179  static uInt ToRef_p[N_Routes][3];
180  // Transition matrix
182  // Object to ensure safe multi-threaded lazy single initialization
184 
185  //# Constructors
186  // Copy constructor (not implemented)
187  MCuvw(const MCuvw &other);
188  // Assignment (not implemented)
189  MCuvw &operator=(const MCuvw &other);
190 
191  //# Member functions
192 
193  // Create conversion function pointer
194  virtual void getConvert(MConvertBase &mc,
195  const MRBase &inref,
196  const MRBase &outref);
197 
198  // Create help structures for Measure conversion routines
199  virtual void initConvert(uInt which, MConvertBase &mc);
200 
201  // Delete the pointers used in the MeasConvert help structure cache
202  virtual void clearConvert();
203 
204  // Routines to convert uvws from one reference frame to another
205  virtual void doConvert(MeasValue &in,
206  MRBase &inref,
207  MRBase &outref,
208  const MConvertBase &mc);
209  // Conversion routine to cater for inheritance question
210  void doConvert(MVuvw &in,
211  MRBase &inref,
212  MRBase &outref,
213  const MConvertBase &mc);
214  // Get the correct belonging direction from the frame
215  // <group>
216  void getAPP();
217  void getJ2000();
218  void getB1950();
219  // </group>
220  // Rotate from direction to pole
221  void toPole(MVPosition &in);
222  // Rotate from pole to direction
223  void fromPole(MVPosition &in);
224 
225 private:
226  // Fill the global state. Called using theirInitOnce.
227  static void doFillState();
228 };
229 
230 
231 } //# NAMESPACE CASACORE - END
232 
233 #endif
234 
casacore::MCuvw::APP_B1950
@ APP_B1950
Definition: MCuvw.h:133
casacore::Muvw::N_Types
@ N_Types
Definition: Muvw.h:153
casacore::MCuvw::MECLIP_JMEAN
@ MECLIP_JMEAN
Definition: MCuvw.h:149
casacore::MCuvw::getConvert
virtual void getConvert(MConvertBase &mc, const MRBase &inref, const MRBase &outref)
Create conversion function pointer.
casacore::MeasMath
Measure conversion aid routines.
Definition: MeasMath.h:96
casacore::MCuvw::BMEAN_BTRUE
@ BMEAN_BTRUE
Definition: MCuvw.h:127
casacore::MCuvw::HADEC_AZEL
@ HADEC_AZEL
Definition: MCuvw.h:135
casacore::MCuvw::showState
static String showState()
Show the state of the conversion engine (mainly for debugging purposes)
casacore::MCuvw::J2000_JMEAN
@ J2000_JMEAN
Definition: MCuvw.h:122
casacore::MCuvw::toPole
void toPole(MVPosition &in)
Rotate from direction to pole.
casacore::MCuvw::AZELSWGEO_AZELGEO
@ AZELSWGEO_AZELGEO
Definition: MCuvw.h:143
casacore::MCuvw::B1950_VLA_J2000
@ B1950_VLA_J2000
Definition: MCuvw.h:119
casacore::MCuvw::clearConvert
virtual void clearConvert()
Delete the pointers used in the MeasConvert help structure cache.
casacore::MCuvw::J2000_B1950
@ J2000_B1950
Definition: MCuvw.h:116
casacore::MCuvw::theirInitOnce
static CallOnce0 theirInitOnce
Object to ensure safe multi-threaded lazy single initialization.
Definition: MCuvw.h:183
casacore::MCuvw::TOPO_APP
@ TOPO_APP
Definition: MCuvw.h:157
casacore::MCuvw::MCuvw
MCuvw(const MCuvw &other)
Copy constructor (not implemented)
casacore::MCuvw::ICRS_J2000
@ ICRS_J2000
Definition: MCuvw.h:158
casacore::MVDirection
Vector of three direction cosines.
Definition: MVDirection.h:106
casacore::MCuvw::AZELGEO_HADEC
@ AZELGEO_HADEC
Definition: MCuvw.h:138
casacore::MCuvw::MVDIR1
MVDirection MVDIR1
Belonging direction.
Definition: MCuvw.h:175
casacore::MCuvw::GAL_B1950
@ GAL_B1950
Definition: MCuvw.h:113
casacore::MCuvw::AZELSW_AZEL
@ AZELSW_AZEL
Definition: MCuvw.h:142
casacore::MCuvw::B1950_VLA_B1950
@ B1950_VLA_B1950
Definition: MCuvw.h:121
casacore::MCuvw::HADEC_AZELGEO
@ HADEC_AZELGEO
Definition: MCuvw.h:136
casacore::MCuvw::ECLIP_J2000
@ ECLIP_J2000
Definition: MCuvw.h:147
casacore::MCuvw::AZELGEO_AZELSWGEO
@ AZELGEO_AZELSWGEO
Definition: MCuvw.h:141
casacore::MCuvw::getB1950
void getB1950()
casacore::MCuvw::B1950_J2000
@ B1950_J2000
Definition: MCuvw.h:118
casacore::MeasValue
Base class for values in a Measure.
Definition: MeasValue.h:107
casacore::MCuvw::operator=
MCuvw & operator=(const MCuvw &other)
Assignment (not implemented)
casacore::MCuvw::SUPERGAL_GAL
@ SUPERGAL_GAL
Definition: MCuvw.h:153
casacore::MCBase
Base for specific measure conversions.
Definition: MCBase.h:119
casacore::MCuvw::JNAT_J2000
@ JNAT_J2000
Definition: MCuvw.h:131
casacore::MCuvw::doConvert
virtual void doConvert(MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
Routines to convert uvws from one reference frame to another.
casacore::MCuvw::measMath
MeasMath measMath
Calculation class.
Definition: MCuvw.h:173
casacore::MRBase
Base for Reference frame for physical measures.
Definition: MRBase.h:103
casacore::MCuvw::TECLIP_JTRUE
@ TECLIP_JTRUE
Definition: MCuvw.h:151
casacore::Muvw
A Measure: uvw on Earth.
Definition: Muvw.h:115
casacore::MCuvw::fromPole
void fromPole(MVPosition &in)
Rotate from pole to direction.
casacore::MCuvw
Muvw conversion routines
Definition: MCuvw.h:85
casacore::MCuvw::doConvert
void doConvert(MVuvw &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
Conversion routine to cater for inheritance question.
casacore::MCuvw::HADEC_TOPO
@ HADEC_TOPO
Definition: MCuvw.h:139
casacore::MCuvw::JTRUE_JMEAN
@ JTRUE_JMEAN
Definition: MCuvw.h:128
casacore::MCuvw::AZEL_HADEC
@ AZEL_HADEC
Definition: MCuvw.h:137
casacore::uInt
unsigned int uInt
Definition: aipstype.h:51
casacore::MCuvw::N_Routes
@ N_Routes
Definition: MCuvw.h:160
casacore::MCuvw::APP_JNAT
@ APP_JNAT
Definition: MCuvw.h:144
casacore::MCuvw::FromTo_p
static uInt FromTo_p[Muvw::N_Types][Muvw::N_Types]
Transition matrix.
Definition: MCuvw.h:181
casacore::MCuvw::BMEAN_B1950
@ BMEAN_B1950
Definition: MCuvw.h:126
casacore::MeasConvert
Conversion of Measures.
Definition: MBaseline.h:44
casacore::MCuvw::BTRUE_BMEAN
@ BTRUE_BMEAN
Definition: MCuvw.h:129
casacore::MCuvw::doFillState
static void doFillState()
Fill the global state.
casacore::MCuvw::J2000_GAL
@ J2000_GAL
Definition: MCuvw.h:114
casacore::MCuvw::B1950_BMEAN
@ B1950_BMEAN
Definition: MCuvw.h:123
casacore::MCuvw::J2000_ICRS
@ J2000_ICRS
Definition: MCuvw.h:159
casacore::MCuvw::JMEAN_JTRUE
@ JMEAN_JTRUE
Definition: MCuvw.h:125
casacore
this file contains all the compiler specific defines
Definition: mainpage.dox:28
casacore::MCuvw::B1950_GAL
@ B1950_GAL
Definition: MCuvw.h:115
casacore::MCuvw::J2000_ECLIP
@ J2000_ECLIP
Definition: MCuvw.h:146
casacore::MCuvw::JTRUE_TECLIP
@ JTRUE_TECLIP
Definition: MCuvw.h:150
casacore::MCuvw::TOPO_HADEC
@ TOPO_HADEC
Definition: MCuvw.h:156
casacore::MCuvw::B1950_B1950_VLA
@ B1950_B1950_VLA
Definition: MCuvw.h:120
casacore::MVuvw
A 3D vector on Earth.
Definition: MVuvw.h:110
casacore::MVPosition
A 3D vector in space.
Definition: MVPosition.h:113
casacore::MCuvw::B1950_APP
@ B1950_APP
Definition: MCuvw.h:132
casacore::String
String: the storage and methods of handling collections of characters.
Definition: String.h:223
casacore::MCuvw::GAL_J2000
@ GAL_J2000
Definition: MCuvw.h:112
casacore::MCuvw::ITRF_HADEC
@ ITRF_HADEC
Definition: MCuvw.h:154
casacore::MCuvw::~MCuvw
~MCuvw()
casacore::MCuvw::AZEL_AZELSW
@ AZEL_AZELSW
Definition: MCuvw.h:140
casacore::Vector
A 1-D Specialization of the Array class.
Definition: ArrayIO.h:45
casacore::MCuvw::HADEC_ITRF
@ HADEC_ITRF
Definition: MCuvw.h:155
casacore::MCuvw::getAPP
void getAPP()
Get the correct belonging direction from the frame.
casacore::MCuvw::J2000_B1950_VLA
@ J2000_B1950_VLA
Definition: MCuvw.h:117
casacore::MCuvw::APP_TOPO
@ APP_TOPO
Definition: MCuvw.h:134
casacore::MCuvw::JMEAN_J2000
@ JMEAN_J2000
Definition: MCuvw.h:124
casacore::MCuvw::J2000_JNAT
@ J2000_JNAT
Definition: MCuvw.h:130
casacore::MCuvw::getJ2000
void getJ2000()
casacore::MCuvw::MCuvw
MCuvw()
Default constructor.
casacore::CallOnce0
Wrapper around std::call_once.
Definition: Mutex.h:215
casacore::MCuvw::initConvert
virtual void initConvert(uInt which, MConvertBase &mc)
Create help structures for Measure conversion routines.
casacore::MCuvw::JMEAN_MECLIP
@ JMEAN_MECLIP
Definition: MCuvw.h:148
casacore::MConvertBase
Conversion of Measures Base.
Definition: MConvertBase.h:147
casacore::MCBase::Routes
Routes
Each derived class should have a list of routines to be called:
Definition: MCBase.h:134
casacore::MCuvw::JNAT_APP
@ JNAT_APP
Definition: MCuvw.h:145
casacore::MCuvw::GAL_SUPERGAL
@ GAL_SUPERGAL
Definition: MCuvw.h:152
casacore::MCuvw::ToRef_p
static uInt ToRef_p[N_Routes][3]
Transition list.
Definition: MCuvw.h:179