casacore
MCRadialVelocity.h
Go to the documentation of this file.
1 //# MCRadialVelocity.h: MRadialVelocity conversion routines
2 //# Copyright (C) 1995,1996,1997,1998,1999,2000,2002,2003
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_MCRADIALVELOCITY_H
30 #define MEASURES_MCRADIALVELOCITY_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/MRadialVelocity.h>
39 #include <casacore/casa/OS/Mutex.h>
40 
41 namespace casacore { //# NAMESPACE CASACORE - BEGIN
42 
43 //# Forward Declarations
44 class MCRadialVelocity;
45 class MDoppler;
46 class MVPosition;
47 class MVDirection;
48 class Aberration;
49 class String;
50 
51 //# Typedefs
52 
53 // <summary> MRadialVelocity 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 RadialVelocity
68 // </etymology>
69 //
70 // <synopsis>
71 // Contains state machinery and cashing for actual conversions
72 //
73 // <example>
74 // Get the Doppler shift for an oberved HI RadialVelocity of 100 km/s
75 // <srcblock>
76 // #include <casacore/measures/Measures.h>
77 // #include <casacore/measures/Measures/MRadialVelocity.h>
78 // #include <casacore/measures/Measures/MDoppler.h>
79 // cout << "Redshift for 100 km/s: " <<
80 // MDoppler::Convert( MRadialVelocity( Quantity(100., "km/s"),
81 // MRadialVelocity::TOPO).toDoppler(QC::HI),
82 // MDoppler::Z)() << endl;
83 // </srcblock>
84 // </example>
85 //
86 // <motivation>
87 // </motivation>
88 //
89 // <todo asof="2003/03/03">
90 // </todo>
91 
92 class MCRadialVelocity : public MCBase {
93 
94 public:
95  //# Friends
96  // Conversion of data
98 
99  //# Constructors
100  // Default constructor
102 
103  //# Destructor
105 
106  //# Member functions
107  // Show the state of the conversion engine (mainly for debugging purposes)
108  static String showState();
109 
110 private:
111  //# Enumerations
112  // The list of actual routines provided.
113  // <note role=warning> Each <src>AA_BB</src> in the list points to routine
114  // that can be used in the FromTo list in the getConvert routine.
115  // In addition the type to which each is converted should be in the
116  // ToRef array, again in the proper order. </note>
117  enum Routes {
133 
134  //# Typedefs
135 
136  //# Operators
137 
138  //# General Member Functions
139 
140  //# Enumerations
141 
142  //# Cached Data
147 
148  //# State machine data
149  // Transition list
150  static uInt ToRef_p[N_Routes][3];
151  // Transition matrix
153  // Mutex for thread-safety.
155 
156  // Fill the global state in a thread-safe way.
157  static void fillState()
158  { theirMutexedInit.exec(); }
159 
160  //# Constructors
161  // Copy constructor (not implemented)
162  MCRadialVelocity(const MCRadialVelocity &other);
163  // Assignment (not implemented)
165 
166  //# Member functions
167  // Create conversion function pointer
168  virtual void getConvert(MConvertBase &mc,
169  const MRBase &inref,
170  const MRBase &outref);
171 
172  // Create help structures for Measure conversion routines
173  virtual void initConvert(uInt which, MConvertBase &mc);
174 
175  // Delete the pointers used in the MeasConvert help structure cache
176  virtual void clearConvert();
177 
178  // Routine to convert RadialVelocity from one reference frame to another
179  virtual void doConvert(MeasValue &in,
180  MRBase &inref,
181  MRBase &outref,
182  const MConvertBase &mc);
183  // Conversion routine to cater for inheritance question
184  void doConvert(MVRadialVelocity &in,
185  MRBase &inref,
186  MRBase &outref,
187  const MConvertBase &mc);
188 
189 private:
190  // Fill the global state in a thread-safe way.
191  static void doFillState (void*);
192 };
193 
194 
195 } //# NAMESPACE CASACORE - END
196 
197 #endif
Conversion of Measures.
Definition: MBaseline.h:44
Routes
Each derived class should have a list of routines to be called:
Definition: MCBase.h:134
MCRadialVelocity & operator=(const MCRadialVelocity &other)
Assignment (not implemented)
Base for Reference frame for physical measures.
Definition: MRBase.h:103
Base for specific measure conversions.
Definition: MCBase.h:119
static void doFillState(void *)
Fill the global state in a thread-safe way.
A Measure: radial velocity.
Thread-safe initialization of global variables.
Definition: Mutex.h:161
static uInt FromTo_p[MRadialVelocity::N_Types][MRadialVelocity::N_Types]
Transition matrix.
Internal value for MRadialVelocity.
virtual void clearConvert()
Delete the pointers used in the MeasConvert help structure cache.
Base class for values in a Measure.
Definition: MeasValue.h:107
MRadialVelocity conversion routines.
static MutexedInit theirMutexedInit
Mutex for thread-safety.
A 3D vector in space.
Definition: MVPosition.h:113
virtual void getConvert(MConvertBase &mc, const MRBase &inref, const MRBase &outref)
Create conversion function pointer.
void exec()
Execute the initialization function if not done yet.
Definition: Mutex.h:171
virtual void doConvert(MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
Routine to convert RadialVelocity from one reference frame to another.
Aberration class and calculations.
Definition: Aberration.h:109
static void fillState()
Fill the global state in a thread-safe way.
String: the storage and methods of handling collections of characters.
Definition: String.h:223
static uInt ToRef_p[N_Routes][3]
Transition list.
Vector of three direction cosines.
Definition: MVDirection.h:106
static String showState()
Show the state of the conversion engine (mainly for debugging purposes)
MCRadialVelocity()
Default constructor.
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51
virtual void initConvert(uInt which, MConvertBase &mc)
Create help structures for Measure conversion routines.
Conversion of Measures Base.
Definition: MConvertBase.h:147