casacore::MCFrequency Class Reference

#include <MCFrequency.h>

Inheritance diagram for casacore::MCFrequency:

Public Member Functions
	MCFrequency ()
	Default constructor.
	~MCFrequency ()
Static Public Member Functions
static String	showState ()
	Show the state of the conversion engine (mainly for debugging purposes).
Private Types
enum	Routes { LSRD_BARY, BARY_LSRD, BARY_GEO, GEO_TOPO, GEO_BARY, TOPO_GEO, LSRD_GALACTO, GALACTO_LSRD, LSRK_BARY, BARY_LSRK, BARY_LGROUP, LGROUP_BARY, BARY_CMB, CMB_BARY, REST_LSRK, LSRK_REST, N_Routes }
	The list of actual routines provided. More...
Private Member Functions
	MCFrequency (const MCFrequency &other)
	Copy constructor (not implemented).
MCFrequency &	operator= (const MCFrequency &other)
	Assignment (not implemented).
virtual void	getConvert (MConvertBase &mc, const MRBase &inref, const MRBase &outref)
	Create conversion function pointer.
virtual void	initConvert (uInt which, MConvertBase &mc)
	Create help structures for Measure conversion routines.
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)
	Routine to convert frequency from one reference frame to another.
void	doConvert (MVFrequency &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
	Conversion routine to cater for inheritance question.
Static Private Member Functions
static void	fillState ()
	Fill the global state in a thread-safe way.
static void	doFillState (void *)
	Fill the global state in a thread-safe way.
Private Attributes
MVPosition *	MVPOS1
MVDirection *	MVDIR1
Aberration *	ABERFROM
Aberration *	ABERTO
Static Private Attributes
static uInt	ToRef_p [N_Routes][3]
	Transition list.
static uInt	FromTo_p [MFrequency::N_Types][MFrequency::N_Types]
	Transition matrix.
static MutexedInit	theirMutexedInit
	Mutex for thread-safety.
Friends
class	MeasConvert< MFrequency >
	Conversion of data.

Detailed Description

MFrequency conversion routines.

Intended use:

Internal

Review Status

Reviewed By:: UNKNOWN
Date Reviewed:: before2004/08/25
Test programs:: tMeasure

Prerequisite

Measure class
MCBase base class
overall conversion class

Etymology

Measure, Convert and Frequency

Synopsis

Contains state machinery and caching for actual conversions

Example

Get the Doppler shift for an oberved HI frequency of 1380 MHz

 #include <casacore/measures/Measures.h>
 #include <casacore/measures/Measures/MDoppler.h>
 #include <casacore/measures/Measures/MFrequency.h>
 cout << "Redshift for 1380 MHz: " <<
 MDoppler::Convert( MFrequency( Quantity(1380., "MHz"),
 MFrequency::TOPO).toDoppler(QC::HI),
 MDoppler::Z)() << endl;

Motivation

Definition at line 93 of file MCFrequency.h.

Member Enumeration Documentation

enum casacore::MCFrequency::Routes [private]

The list of actual routines provided.

Warning: Each AA_BB in the list points to routine that can be used in the FromTo list in the getConvert routine; In addition the type to which each is converted should be in the ToRef array, again in the proper order;

Enumerator:

LSRD_BARY
BARY_LSRD
BARY_GEO
GEO_TOPO
GEO_BARY
TOPO_GEO
LSRD_GALACTO
GALACTO_LSRD
LSRK_BARY
BARY_LSRK
BARY_LGROUP
LGROUP_BARY
BARY_CMB
CMB_BARY
REST_LSRK
LSRK_REST
N_Routes