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