MEarthMagnetic conversion routines. More...

#include <MCEarthMagnetic.h>

Inheritance diagram for casacore::MCEarthMagnetic:

Public Member Functions
	MCEarthMagnetic ()
	Default constructor. More...

	~MCEarthMagnetic ()

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 { GAL_J2000, GAL_B1950, J2000_GAL, B1950_GAL, J2000_B1950, B1950_J2000, J2000_JMEAN, B1950_BMEAN, JMEAN_J2000, JMEAN_JTRUE, BMEAN_B1950, BMEAN_BTRUE, JTRUE_JMEAN, BTRUE_BMEAN, J2000_JNAT, JNAT_J2000, B1950_APP, APP_B1950, APP_TOPO, HADEC_AZEL, HADEC_AZELGEO, AZEL_HADEC, AZELGEO_HADEC, HADEC_TOPO, AZEL_AZELSW, AZELGEO_AZELSWGEO, AZELSW_AZEL, AZELSWGEO_AZELGEO, APP_JNAT, JNAT_APP, J2000_ECLIP, ECLIP_J2000, JMEAN_MECLIP, MECLIP_JMEAN, JTRUE_TECLIP, TECLIP_JTRUE, GAL_SUPERGAL, SUPERGAL_GAL, ITRF_HADEC, HADEC_ITRF, TOPO_HADEC, TOPO_APP, ICRS_J2000, J2000_ICRS, N_Routes, R_MODEL0, R_MODEL, R_IGRF }
	The list of actual routines provided. More...

Private Member Functions
	MCEarthMagnetic (const MCEarthMagnetic &other)
	Copy constructor (not implemented) More...

MCEarthMagnetic &	operator= (const MCEarthMagnetic &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)
	Routines to convert EarthMagnetics from one reference frame to another. More...

void	doConvert (MVEarthMagnetic &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
MVPosition *	MVPOS1

EarthField *	EFIELD

MeasMath	measMath

Static Private Attributes
static uInt	ToRef_p [N_Routes][3]
	Transition list. More...

static uInt	FromTo_p [MEarthMagnetic::N_Types][MEarthMagnetic::N_Types]
	Transition matrix. More...

static std::once_flag	theirInitOnceFlag
	Object to ensure safe multi-threaded lazy single initialization. More...

Friends
class	MeasConvert< MEarthMagnetic >
	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

MEarthMagnetic conversion routines.

Intended use:

Internal

Review Status

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

Prerequisite

Measure class
MCBase base class
overall conversion class

Etymology

Measure, Convert and EarthMagnetic

Synopsis

Contains state machinery and caching for actual conversions

Example

See Measures module description for conversion examples.

Motivation

To Do

Use MCDirection routines directly

Definition at line 87 of file MCEarthMagnetic.h.

Member Enumeration Documentation

enum casacore::MCEarthMagnetic::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
GAL_J2000
GAL_B1950
J2000_GAL
B1950_GAL
J2000_B1950
B1950_J2000
J2000_JMEAN
B1950_BMEAN
JMEAN_J2000
JMEAN_JTRUE
BMEAN_B1950
BMEAN_BTRUE
JTRUE_JMEAN
BTRUE_BMEAN
J2000_JNAT
JNAT_J2000
B1950_APP
APP_B1950
APP_TOPO
HADEC_AZEL
HADEC_AZELGEO
AZEL_HADEC
AZELGEO_HADEC
HADEC_TOPO
AZEL_AZELSW
AZELGEO_AZELSWGEO
AZELSW_AZEL
AZELSWGEO_AZELGEO
APP_JNAT
JNAT_APP
J2000_ECLIP
ECLIP_J2000
JMEAN_MECLIP
MECLIP_JMEAN
JTRUE_TECLIP
TECLIP_JTRUE
GAL_SUPERGAL
SUPERGAL_GAL
ITRF_HADEC
HADEC_ITRF
TOPO_HADEC
TOPO_APP
ICRS_J2000
J2000_ICRS
N_Routes
R_MODEL0	General for Models.
R_MODEL
R_IGRF	Individual models. Order should be the same as in MEarthMagnetic.h

Definition at line 113 of file MCEarthMagnetic.h.

Constructor & Destructor Documentation

casacore::MCEarthMagnetic::MCEarthMagnetic ( )

Default constructor.

casacore::MCEarthMagnetic::~MCEarthMagnetic ( )

casacore::MCEarthMagnetic::MCEarthMagnetic ( const MCEarthMagnetic & other )

private

Copy constructor (not implemented)

Member Function Documentation

virtual void casacore::MCEarthMagnetic::clearConvert ( )

privatevirtual

Delete the pointers used in the MeasConvert help structure cache.

Implements casacore::MCBase.

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

privatevirtual

Routines to convert EarthMagnetics from one reference frame to another.

Implements casacore::MCBase.

void casacore::MCEarthMagnetic::doConvert	(	MVEarthMagnetic &	in,
		MRBase &	inref,
		MRBase &	outref,
		const MConvertBase &	mc
	)

private

Conversion routine to cater for inheritance question.

static void casacore::MCEarthMagnetic::doFillState ( )

staticprivate

Fill the global state.

Called using theirInitOnce.

virtual void casacore::MCEarthMagnetic::getConvert	(	MConvertBase &	mc,
		const MRBase &	inref,
		const MRBase &	outref
	)

privatevirtual

Create conversion function pointer.

Implements casacore::MCBase.

virtual void casacore::MCEarthMagnetic::initConvert	(	uInt	which,
		MConvertBase &	mc
	)

privatevirtual

Create help structures for Measure conversion routines.

Implements casacore::MCBase.

MCEarthMagnetic& casacore::MCEarthMagnetic::operator= ( const MCEarthMagnetic & other )

private

Assignment (not implemented)

static String casacore::MCEarthMagnetic::showState ( )

static

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

Friends And Related Function Documentation

friend class MeasConvert< MEarthMagnetic >

friend

Conversion of data.

Definition at line 93 of file MCEarthMagnetic.h.

Member Data Documentation

EarthField* casacore::MCEarthMagnetic::EFIELD

private

Definition at line 176 of file MCEarthMagnetic.h.

uInt casacore::MCEarthMagnetic::FromTo_p[MEarthMagnetic::N_Types][MEarthMagnetic::N_Types]

staticprivate

Transition matrix.

Definition at line 183 of file MCEarthMagnetic.h.

MeasMath casacore::MCEarthMagnetic::measMath

private

Definition at line 177 of file MCEarthMagnetic.h.

MVPosition* casacore::MCEarthMagnetic::MVPOS1

private

Definition at line 175 of file MCEarthMagnetic.h.

std::once_flag casacore::MCEarthMagnetic::theirInitOnceFlag

staticprivate

Object to ensure safe multi-threaded lazy single initialization.

Definition at line 185 of file MCEarthMagnetic.h.

uInt casacore::MCEarthMagnetic::ToRef_p[N_Routes][3]

staticprivate

Transition list.

Definition at line 181 of file MCEarthMagnetic.h.

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

measures/Measures/MCEarthMagnetic.h

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation