casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
casacore::MCFrequency Class Reference

MFrequency conversion routines. More...

#include <MCFrequency.h>

Inheritance diagram for casacore::MCFrequency:
casacore::MCBase

Public Member Functions

 MCFrequency ()
 Default constructor. More...
 
 ~MCFrequency ()
 
- Public Member Functions inherited from casacore::MCBase
virtual ~MCBase ()
 

Static Public Member Functions

static String showState ()
 Show the state of the conversion engine (mainly for debugging purposes) More...
 

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) More...
 
MCFrequencyoperator= (const MCFrequency &other)
 Assignment (not implemented) More...
 
virtual void getConvert (MConvertBase &mc, const MRBase &inref, const MRBase &outref)
 Create conversion function pointer. More...
 
virtual void initConvert (uInt which, MConvertBase &mc)
 Create help structures for Measure conversion routines. More...
 
virtual void clearConvert ()
 Delete the pointers used in the MeasConvert help structure cache. More...
 
virtual void doConvert (MeasValue &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
 Routine to convert frequency from one reference frame to another. More...
 
void doConvert (MVFrequency &in, MRBase &inref, MRBase &outref, const MConvertBase &mc)
 Conversion routine to cater for inheritance question. More...
 

Static Private Member Functions

static void doFillState ()
 Fill the global state. More...
 

Private Attributes

MVPositionMVPOS1
 
MVDirectionMVDIR1
 
AberrationABERFROM
 
AberrationABERTO
 

Static Private Attributes

static uInt ToRef_p [N_Routes][3]
 Transition list. More...
 
static uInt FromTo_p [MFrequency::N_Types][MFrequency::N_Types]
 Transition matrix. More...
 
static std::once_flag theirInitOnceFlag
 Object to ensure safe multi-threaded lazy single initialization. More...
 

Friends

class MeasConvert< MFrequency >
 Conversion of data. More...
 

Additional Inherited Members

- Public Types inherited from casacore::MCBase
enum  Routes { N_Routes }
 Each derived class should have a list of routines to be called: More...
 
- Static Protected Member Functions inherited from casacore::MCBase
static void makeState (uInt *state, const uInt ntyp, const uInt nrout, const uInt list[][3])
 
The following routines create a state transition matrix from a list

of all defined transitions. More...

 
static String showState (uInt *state, const uInt ntyp, const uInt nrout, const uInt list[][3])
 Return a fromatted String with matrix information (based on < 100 types) More...
 

Detailed Description

MFrequency conversion routines.

Intended use:

Internal

Review Status

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

Prerequisite

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

cout << "Redshift for 1380 MHz: " <<
MDoppler::Convert(MFrequency(Quantity(1380., "MHz"),
MDoppler::Z)() << endl;

Motivation

Definition at line 92 of file MCFrequency.h.

Member Enumeration Documentation

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 

Definition at line 117 of file MCFrequency.h.

Constructor & Destructor Documentation

casacore::MCFrequency::MCFrequency ( )

Default constructor.

casacore::MCFrequency::~MCFrequency ( )
casacore::MCFrequency::MCFrequency ( const MCFrequency other)
private

Copy constructor (not implemented)

Member Function Documentation

virtual void casacore::MCFrequency::clearConvert ( )
privatevirtual

Delete the pointers used in the MeasConvert help structure cache.

Implements casacore::MCBase.

virtual void casacore::MCFrequency::doConvert ( MeasValue in,
MRBase inref,
MRBase outref,
const MConvertBase mc 
)
privatevirtual

Routine to convert frequency from one reference frame to another.

Implements casacore::MCBase.

void casacore::MCFrequency::doConvert ( MVFrequency in,
MRBase inref,
MRBase outref,
const MConvertBase mc 
)
private

Conversion routine to cater for inheritance question.

static void casacore::MCFrequency::doFillState ( )
staticprivate

Fill the global state.

Called using theirInitOnce.

virtual void casacore::MCFrequency::getConvert ( MConvertBase mc,
const MRBase inref,
const MRBase outref 
)
privatevirtual

Create conversion function pointer.

Implements casacore::MCBase.

virtual void casacore::MCFrequency::initConvert ( uInt  which,
MConvertBase mc 
)
privatevirtual

Create help structures for Measure conversion routines.

Implements casacore::MCBase.

MCFrequency& casacore::MCFrequency::operator= ( const MCFrequency other)
private

Assignment (not implemented)

static String casacore::MCFrequency::showState ( )
static

Show the state of the conversion engine (mainly for debugging purposes)

Friends And Related Function Documentation

friend class MeasConvert< MFrequency >
friend

Conversion of data.

Definition at line 97 of file MCFrequency.h.

Member Data Documentation

Aberration* casacore::MCFrequency::ABERFROM
private

Definition at line 147 of file MCFrequency.h.

Aberration* casacore::MCFrequency::ABERTO
private

Definition at line 148 of file MCFrequency.h.

uInt casacore::MCFrequency::FromTo_p[MFrequency::N_Types][MFrequency::N_Types]
staticprivate

Transition matrix.

Definition at line 154 of file MCFrequency.h.

MVDirection* casacore::MCFrequency::MVDIR1
private

Definition at line 146 of file MCFrequency.h.

MVPosition* casacore::MCFrequency::MVPOS1
private

Definition at line 145 of file MCFrequency.h.

std::once_flag casacore::MCFrequency::theirInitOnceFlag
staticprivate

Object to ensure safe multi-threaded lazy single initialization.

Definition at line 156 of file MCFrequency.h.

uInt casacore::MCFrequency::ToRef_p[N_Routes][3]
staticprivate

Transition list.

Definition at line 152 of file MCFrequency.h.


The documentation for this class was generated from the following file: