casacore
MCDirection.h
Go to the documentation of this file.
1 //# MCDirection.h: MDirection conversion routines
2 //# Copyright (C) 1995-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_MCDIRECTION_H
30 #define MEASURES_MCDIRECTION_H
31 
32 //# Includes
33 #include <casacore/casa/aips.h>
34 #include <casacore/measures/Measures/MeasBase.h>
35 #include <casacore/measures/Measures/MeasRef.h>
36 #include <casacore/measures/Measures/MCBase.h>
37 #include <casacore/measures/Measures/MConvertBase.h>
38 #include <casacore/measures/Measures/MDirection.h>
39 #include <casacore/measures/Measures/MeasMath.h>
40 #include <casacore/casa/OS/Mutex.h>
41 
42 namespace casacore { //# NAMESPACE CASACORE - BEGIN
43 
44 //# Forward Declarations
45 class MCDirection;
46 class MVPosition;
47 class String;
48 
49 template <class T> class Vector;
50 
51 //# Typedefs
52 
53 // <summary> MDirection conversion routines </summary>
54 
55 // <use visibility=local>
56 
57 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMeasure" 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 Direction
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="2000/09/12">
83 // <li> nothing I know
84 // </todo>
85 
86 class MCDirection : public MCBase {
87 
88 public:
89 
90  //# Friends
91  // Conversion of data
92  friend class MeasConvert<MDirection>;
93 
94  //# Constructors
95  // Default constructor
97 
98  //# Destructor
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 {
162  // General for Planets
167  // Individual planets. Order should be the same as in MDirection.h
178 
179  //# Typedefs
180 
181  //# Operators
182 
183  //# General Member Functions
184 
185  //# Enumerations
186 
187  //# Cached Data
191 
192  //# State machine data
193  // Transition list
194  static uInt ToRef_p[N_Routes][3];
195  // Transition matrix
197  // Object to ensure safe multi-threaded lazy single initialization
199 
200  //# Constructors
201  // Copy constructor (not implemented)
202  MCDirection(const MCDirection &other);
203  // Assignment (not implemented)
205 
206  //# Member functions
207 
208  // Create conversion function pointer
209  virtual void getConvert(MConvertBase &mc,
210  const MRBase &inref,
211  const MRBase &outref);
212 
213  // Create help structures for Measure conversion routines
214  virtual void initConvert(uInt which, MConvertBase &mc);
215 
216  // Delete the pointers used in the MeasConvert help structure cache
217  virtual void clearConvert();
218 
219  // Routines to convert directions from one reference frame to another
220  virtual void doConvert(MeasValue &in,
221  MRBase &inref,
222  MRBase &outref,
223  const MConvertBase &mc);
224  // Conversion routine to cater for inheritance question
226  MRBase &inref,
227  MRBase &outref,
228  const MConvertBase &mc);
229 
230 private:
231  // Fill the global state. Called using theirInitOnce.
232  static void doFillState();
233 };
234 
235 
236 } //# NAMESPACE CASACORE - END
237 
238 #endif
239 
casacore::MeasMath
Measure conversion aid routines.
Definition: MeasMath.h:96
casacore::MCDirection::R_VENUS
@ R_VENUS
Definition: MCDirection.h:169
casacore::MCDirection::JNAT_J2000
@ JNAT_J2000
Definition: MCDirection.h:132
casacore::MCDirection::APP_JNAT
@ APP_JNAT
Definition: MCDirection.h:145
casacore::MCDirection::R_MOON
@ R_MOON
Definition: MCDirection.h:177
casacore::MCDirection::~MCDirection
~MCDirection()
casacore::MCDirection::R_JUPITER
@ R_JUPITER
Definition: MCDirection.h:171
casacore::MCDirection::TECLIP_JTRUE
@ TECLIP_JTRUE
Definition: MCDirection.h:152
casacore::MCDirection::AZELGEO_AZELSWGEO
@ AZELGEO_AZELSWGEO
Definition: MCDirection.h:142
casacore::MCDirection::BMEAN_BTRUE
@ BMEAN_BTRUE
Definition: MCDirection.h:128
casacore::MCDirection::JTRUE_TECLIP
@ JTRUE_TECLIP
Definition: MCDirection.h:151
casacore::MCDirection::VEC61
Vector< Double > * VEC61
Definition: MCDirection.h:189
casacore::MCDirection::R_MERCURY
@ R_MERCURY
Individual planets.
Definition: MCDirection.h:168
casacore::MCDirection::R_COMET
@ R_COMET
Definition: MCDirection.h:166
casacore::MCDirection::J2000_JNAT
@ J2000_JNAT
Definition: MCDirection.h:131
casacore::MCDirection::MVPOS2
MVPosition * MVPOS2
Definition: MCDirection.h:188
casacore::MCDirection::N_Routes
@ N_Routes
Definition: MCDirection.h:161
casacore::MCDirection::BTRUE_BMEAN
@ BTRUE_BMEAN
Definition: MCDirection.h:130
casacore::MCDirection::R_SATURN
@ R_SATURN
Definition: MCDirection.h:172
casacore::MCDirection::doConvert
void doConvert(MVDirection &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
Conversion routine to cater for inheritance question.
casacore::MCDirection::HADEC_ITRF
@ HADEC_ITRF
Definition: MCDirection.h:156
casacore::MCDirection::clearConvert
virtual void clearConvert()
Delete the pointers used in the MeasConvert help structure cache.
casacore::MCDirection::R_URANUS
@ R_URANUS
Definition: MCDirection.h:173
casacore::MVDirection
Vector of three direction cosines.
Definition: MVDirection.h:106
casacore::MCDirection::AZELSWGEO_AZELGEO
@ AZELSWGEO_AZELGEO
Definition: MCDirection.h:144
casacore::MCDirection::R_PLUTO
@ R_PLUTO
Definition: MCDirection.h:175
casacore::MCDirection::B1950_APP
@ B1950_APP
Definition: MCDirection.h:133
casacore::MCDirection::VEC63
Vector< Double > * VEC63
Definition: MCDirection.h:189
casacore::MCDirection::B1950_J2000
@ B1950_J2000
Definition: MCDirection.h:119
casacore::MCDirection::VEC62
Vector< Double > * VEC62
Definition: MCDirection.h:189
casacore::MeasValue
Base class for values in a Measure.
Definition: MeasValue.h:107
casacore::MCBase
Base for specific measure conversions.
Definition: MCBase.h:119
casacore::MCDirection::showState
static String showState()
Show the state of the conversion engine (mainly for debugging purposes)
casacore::MDirection::N_Types
@ N_Types
Definition: MDirection.h:211
casacore::MCDirection::R_COMET0
@ R_COMET0
Definition: MCDirection.h:165
casacore::MCDirection::APP_B1950
@ APP_B1950
Definition: MCDirection.h:134
casacore::MRBase
Base for Reference frame for physical measures.
Definition: MRBase.h:103
casacore::MCDirection::APP_TOPO
@ APP_TOPO
Definition: MCDirection.h:135
casacore::MCDirection::J2000_GAL
@ J2000_GAL
Definition: MCDirection.h:115
casacore::MCDirection::AZELSW_AZEL
@ AZELSW_AZEL
Definition: MCDirection.h:143
casacore::MCDirection::GAL_J2000
@ GAL_J2000
Definition: MCDirection.h:113
casacore::MCDirection::B1950_VLA_B1950
@ B1950_VLA_B1950
Definition: MCDirection.h:122
casacore::MCDirection::BMEAN_B1950
@ BMEAN_B1950
Definition: MCDirection.h:127
casacore::MCDirection::ICRS_J2000
@ ICRS_J2000
Definition: MCDirection.h:159
casacore::MCDirection::JTRUE_JMEAN
@ JTRUE_JMEAN
Definition: MCDirection.h:129
casacore::MCDirection::ECLIP_J2000
@ ECLIP_J2000
Definition: MCDirection.h:148
casacore::MCDirection::R_MARS
@ R_MARS
Definition: MCDirection.h:170
casacore::MCDirection::J2000_B1950
@ J2000_B1950
Definition: MCDirection.h:117
casacore::MCDirection::J2000_JMEAN
@ J2000_JMEAN
Definition: MCDirection.h:123
casacore::MCDirection::B1950_B1950_VLA
@ B1950_B1950_VLA
Definition: MCDirection.h:121
casacore::MCDirection::JMEAN_MECLIP
@ JMEAN_MECLIP
Definition: MCDirection.h:149
casacore::MCDirection::initConvert
virtual void initConvert(uInt which, MConvertBase &mc)
Create help structures for Measure conversion routines.
casacore::uInt
unsigned int uInt
Definition: aipstype.h:51
casacore::MCDirection::B1950_BMEAN
@ B1950_BMEAN
Definition: MCDirection.h:124
casacore::MCDirection::MVPOS1
MVPosition * MVPOS1
Definition: MCDirection.h:188
casacore::MCDirection::AZELGEO_HADEC
@ AZELGEO_HADEC
Definition: MCDirection.h:139
casacore::MCDirection::AZEL_HADEC
@ AZEL_HADEC
Definition: MCDirection.h:138
casacore::MCDirection::J2000_ECLIP
@ J2000_ECLIP
Definition: MCDirection.h:147
casacore::MCDirection::ITRF_HADEC
@ ITRF_HADEC
Definition: MCDirection.h:155
casacore::MCDirection::MECLIP_JMEAN
@ MECLIP_JMEAN
Definition: MCDirection.h:150
casacore::MCDirection::HADEC_AZEL
@ HADEC_AZEL
Definition: MCDirection.h:136
casacore::MCDirection::ToRef_p
static uInt ToRef_p[N_Routes][3]
Transition list.
Definition: MCDirection.h:194
casacore::MCDirection::R_PLANET0
@ R_PLANET0
General for Planets.
Definition: MCDirection.h:163
casacore::MeasConvert
Conversion of Measures.
Definition: MBaseline.h:44
casacore::MCDirection::R_PLANET
@ R_PLANET
Definition: MCDirection.h:164
casacore::MDirection
A Measure: astronomical direction.
Definition: MDirection.h:174
casacore::MCDirection::theirInitOnce
static CallOnce0 theirInitOnce
Object to ensure safe multi-threaded lazy single initialization.
Definition: MCDirection.h:198
casacore::MCDirection::getConvert
virtual void getConvert(MConvertBase &mc, const MRBase &inref, const MRBase &outref)
Create conversion function pointer.
casacore
this file contains all the compiler specific defines
Definition: mainpage.dox:28
casacore::MCDirection::JNAT_APP
@ JNAT_APP
Definition: MCDirection.h:146
casacore::MCDirection::MCDirection
MCDirection()
Default constructor.
casacore::MCDirection::J2000_B1950_VLA
@ J2000_B1950_VLA
Definition: MCDirection.h:118
casacore::MCDirection::AZEL_AZELSW
@ AZEL_AZELSW
Definition: MCDirection.h:141
casacore::MCDirection::B1950_GAL
@ B1950_GAL
Definition: MCDirection.h:116
casacore::MCDirection::TOPO_HADEC
@ TOPO_HADEC
Definition: MCDirection.h:157
casacore::MCDirection::GAL_SUPERGAL
@ GAL_SUPERGAL
Definition: MCDirection.h:153
casacore::MCDirection::doConvert
virtual void doConvert(MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
Routines to convert directions from one reference frame to another.
casacore::MCDirection::doFillState
static void doFillState()
Fill the global state.
casacore::MCDirection::SUPERGAL_GAL
@ SUPERGAL_GAL
Definition: MCDirection.h:154
casacore::MVPosition
A 3D vector in space.
Definition: MVPosition.h:113
casacore::MCDirection::R_NEPTUNE
@ R_NEPTUNE
Definition: MCDirection.h:174
casacore::MCDirection::B1950_VLA_J2000
@ B1950_VLA_J2000
Definition: MCDirection.h:120
casacore::MCDirection::GAL_B1950
@ GAL_B1950
Definition: MCDirection.h:114
casacore::MCDirection::FromTo_p
static uInt FromTo_p[MDirection::N_Types][MDirection::N_Types]
Transition matrix.
Definition: MCDirection.h:196
casacore::MCDirection::MCDirection
MCDirection(const MCDirection &other)
Copy constructor (not implemented)
casacore::String
String: the storage and methods of handling collections of characters.
Definition: String.h:223
casacore::MCDirection::HADEC_AZELGEO
@ HADEC_AZELGEO
Definition: MCDirection.h:137
casacore::MCDirection::HADEC_TOPO
@ HADEC_TOPO
Definition: MCDirection.h:140
casacore::MCDirection::TOPO_APP
@ TOPO_APP
Definition: MCDirection.h:158
casacore::MCDirection::JMEAN_JTRUE
@ JMEAN_JTRUE
Definition: MCDirection.h:126
casacore::MCDirection
MDirection conversion routines
Definition: MCDirection.h:86
casacore::MCDirection::measMath
MeasMath measMath
Definition: MCDirection.h:190
casacore::Vector
A 1-D Specialization of the Array class.
Definition: ArrayIO.h:45
casacore::MCDirection::operator=
MCDirection & operator=(const MCDirection &other)
Assignment (not implemented)
casacore::MCDirection::JMEAN_J2000
@ JMEAN_J2000
Definition: MCDirection.h:125
casacore::MCDirection::R_SUN
@ R_SUN
Definition: MCDirection.h:176
casacore::MCDirection::J2000_ICRS
@ J2000_ICRS
Definition: MCDirection.h:160
casacore::MCDirection::MVPOS3
MVPosition * MVPOS3
Definition: MCDirection.h:188
casacore::CallOnce0
Wrapper around std::call_once.
Definition: Mutex.h:215
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