casacore::MRadialVelocity Class Reference

A Measure: radial velocity. More...

#include <MRadialVelocity.h>

Inheritance diagram for casacore::MRadialVelocity:

Public Types
enum	Types { LSRK, LSRD, BARY, GEO, TOPO, GALACTO, LGROUP, CMB, N_Types, DEFAULT, LSR }
	Types of known MRadialVelocity Warning: The order defines the order in the translation matrix FromTo in the getConvert routine; Do not change the order without changing the array; Additions should be made before N_types, and an additional row and column should be coded in FromTo, and in showType(); . More...
typedef MVRadialVelocity	MVType
	Measure value container for this class (i.e.
typedef MCRadialVelocity	MCType
	Measure conversion routines for this class (i.e.
typedef MeasRef< MRadialVelocity >	Ref
	Measure reference (i.e.
typedef MeasConvert < MRadialVelocity >	Convert
	Measure conversion use (i.e.
typedef ScalarMeasColumn < MRadialVelocity >	ScalarColumn
	Measure table Columns (e.g., MRadialVelocity::ScalarColumn).
typedef ArrayMeasColumn < MRadialVelocity >	ArrayColumn
Public Member Functions
typedef	WHATEVER_SUN_TYPEDEF (MRadialVelocity) Types Types
	Reference enum Types (included originally for gcc 2.95).
	MRadialVelocity ()
	Tip: In the following constructors and other functions, all MeasRef* can be replaced with simple `Measure::TYPE` where no offsets or frames are needed in the reference;* Default constructor; generates a zero rest RadialVelocity
	MRadialVelocity (const MVRadialVelocity &dt)
	Create from data and reference.
	MRadialVelocity (const MVRadialVelocity &dt, const MRadialVelocity::Ref &rf)
	MRadialVelocity (const MVRadialVelocity &dt, MRadialVelocity::Types rf)
	MRadialVelocity (const Quantity &dt)
	MRadialVelocity (const Quantity &dt, const MRadialVelocity::Ref &rf)
	MRadialVelocity (const Quantity &dt, MRadialVelocity::Types rf)
	MRadialVelocity (const Measure *dt)
	MRadialVelocity (const MeasValue *dt)
virtual	~MRadialVelocity ()
virtual const String &	tellMe () const
	Tell me your type.
virtual uInt	type () const
	Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();.
Bool	giveMe (MRadialVelocity::Ref &mr, const String &in)
virtual Bool	setOffset (const Measure &in)
	Set the offset in the reference (False if non-matching Measure).
virtual Bool	setRefString (const String &in)
	Set the reference type to the specified String.
virtual const String &	getDefaultType () const
	Get the default reference type.
virtual const String *	allTypes (Int &nall, Int &nextra, const uInt *&typ) const
	Get a list of all known reference codes.
virtual void	checkTypes () const
	Check if all internal tables of types (both enum and String) are complete and correct.
virtual String	getRefString () const
	Get the reference type (for records, including codes like R_).
Quantity	get (const Unit &un) const
	Get radial velocity in specified units.
MDoppler	toDoppler ()
	Make a Doppler velocity (as an MDoppler::BETA default) from the RadialVelocity.
virtual Measure *	clone () const
	Make a copy.
Static Public Member Functions
static const String &	showMe ()
static void	assure (const Measure &in)
static MRadialVelocity::Types	castType (uInt tp)
	Translate reference code.
static const String &	showType (MRadialVelocity::Types tp)
static const String &	showType (uInt tp)
static Bool	getType (MRadialVelocity::Types &tp, const String &in)
	Translate string to reference code.
static const String *	allMyTypes (Int &nall, Int &nextra, const uInt *&typ)
static void	checkMyTypes ()
static uInt	myType ()
	Get my type (as Register).
static MDoppler	toDoppler (const Measure &in)
	Local use only.
static MRadialVelocity	fromDoppler (const MDoppler &dop)
	Make a RadialVelocity from the Doppler velocity (assuming LSRK default).
static MRadialVelocity	fromDoppler (const MDoppler &dop, MRadialVelocity::Types typ)
static MRadialVelocity	fromDoppler (const Measure &dop, MRadialVelocity::Types typ)
	For internal use only.
Friends
class	MeasConvert< MRadialVelocity >
	Conversion of data.

Detailed Description

A Measure: radial velocity.

Intended use:

Public interface

Review Status

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

Prerequisite

Measure class

Etymology

Synopsis

MRadialVelocity is a derived Measure class for radial velocity.
An MRadialVelocity can be generated from a simple value (or an MVRadialVelocity object), which is then interpreted as a RadialVelocity in m/s, and a reference, with an LSRK type as default.
It can also be generated from a Quantity, where the interpretation depends on the dimensionality of the Quantity:

velocity (e.g. AU/a)

The different reference types of a RadialVelocity are:

MRadialVelocity::LSRD --- Local Standard of Rest (J2000) -- as the dynamical definition (IAU, [9,12,7] km/s in galactic coordinates)
MRadialVelocity::LSRK -- LSR as a kinematical (radio) definition -- 20.0 km/s in direction ra,dec = [270,+30] deg (B1900.0)
MRadialVelocity::BARY -- Barycentric (J2000)
MRadialVelocity::GEO --- Geocentric
MRadialVelocity::TOPO -- Topocentric
MRadialVelocity::GALACTO -- Galacto centric (with rotation of 220 km/s in direction l,b = [90,0] deg.
MRadialVelocity::LGROUP -- Local group velocity -- 308km/s towards l,b = [105,-7] deg (F. Ghigo)
MRadialVelocity::CMB -- CMB velocity -- 369.5km/s towards l,b = [264.4, 48.4] deg (F. Ghigo)
MRadialVelocity::DEFAULT = LSRK

Conversion between the different types is done with the standard MeasConvert class (MRadialVelocity::Convert in this case).
Some of the conversions are only possible if frame information has been filled in. The following frame information is necessary if a conversion goes to or from the (different) specified types:

Epoch: TOPO, GEO
Position: TOPO
Direction all

Caution: For large radial velocities (of order c) the conversions are not precise, and not completely reversable, due to unknown transverse velocities, and the additive way in which corrections are done; They are correct to first order wrt relativistic effects
An MRadialVelocity can be created from an MDoppler by the fromDoppler() member. It can be converted to an MDoppler with the toDoppler(). Comparable methods are available for MFrequency as toRadial() and fromRadial.

Example

Get the Doppler shift for an oberved HI RadialVelocity of 100 km/s

 cout << "Redshift for 100 km/s: " <<
 MDoppler::Convert( MRadialVelocity( Quantity(100., "km/s"),
 MRadialVelocity::TOPO).toDoppler(),
 MDoppler::Z)() << endl;

Motivation

Definition at line 137 of file MRadialVelocity.h.

Member Typedef Documentation

typedef ArrayMeasColumn<MRadialVelocity> casacore::MRadialVelocity::ArrayColumn

Definition at line 178 of file MRadialVelocity.h.

typedef MeasConvert<MRadialVelocity> casacore::MRadialVelocity::Convert

Measure conversion use (i.e.

MRadialVelocity::Convert)

Reimplemented from casacore::Measure.

Definition at line 175 of file MRadialVelocity.h.

typedef MCRadialVelocity casacore::MRadialVelocity::MCType

Measure conversion routines for this class (i.e.

MRadialVelocity::MCType)

Definition at line 171 of file MRadialVelocity.h.

typedef MVRadialVelocity casacore::MRadialVelocity::MVType

Measure value container for this class (i.e.

MRadialVelocity::MVType)

Definition at line 169 of file MRadialVelocity.h.

typedef MeasRef<MRadialVelocity> casacore::MRadialVelocity::Ref

Measure reference (i.e.

MRadialVelocity::Ref)

Definition at line 173 of file MRadialVelocity.h.

typedef ScalarMeasColumn<MRadialVelocity> casacore::MRadialVelocity::ScalarColumn

Measure table Columns (e.g., MRadialVelocity::ScalarColumn).

Definition at line 177 of file MRadialVelocity.h.

Member Enumeration Documentation

enum casacore::MRadialVelocity::Types

Types of known MRadialVelocity
Warning: The order defines the order in the translation matrix FromTo in the getConvert routine; Do not change the order without changing the array; Additions should be made before N_types, and an additional row and column should be coded in FromTo, and in showType();
.

Enumerator:

LSRK
LSRD
BARY
GEO
TOPO
GALACTO
LGROUP
CMB
N_Types
DEFAULT	Defaults.
LSR	Synonyms.

Reimplemented from casacore::Measure.

Definition at line 152 of file MRadialVelocity.h.

Constructor & Destructor Documentation

casacore::MRadialVelocity::MRadialVelocity ( )

Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measure::TYPE where no offsets or frames are needed in the reference;
Default constructor; generates a zero rest RadialVelocity

casacore::MRadialVelocity::MRadialVelocity ( const MVRadialVelocity & dt )

Create from data and reference.

casacore::MRadialVelocity::MRadialVelocity	(	const MVRadialVelocity &	dt,
		const MRadialVelocity::Ref &	rf
	)

casacore::MRadialVelocity::MRadialVelocity	(	const MVRadialVelocity &	dt,
		MRadialVelocity::Types	rf
	)

casacore::MRadialVelocity::MRadialVelocity ( const Quantity & dt )

casacore::MRadialVelocity::MRadialVelocity	(	const Quantity &	dt,
		const MRadialVelocity::Ref &	rf
	)

casacore::MRadialVelocity::MRadialVelocity	(	const Quantity &	dt,
		MRadialVelocity::Types	rf
	)

casacore::MRadialVelocity::MRadialVelocity ( const Measure * dt )

casacore::MRadialVelocity::MRadialVelocity ( const MeasValue * dt )

virtual casacore::MRadialVelocity::~MRadialVelocity ( ) [virtual]

Member Function Documentation

static const String* casacore::MRadialVelocity::allMyTypes	(	Int &	nall,
		Int &	nextra,
		const uInt *&	typ
	)			`[static]`

virtual const String* casacore::MRadialVelocity::allTypes	(	Int &	nall,
		Int &	nextra,
		const uInt *&	typ
	)			const `[virtual]`

Get a list of all known reference codes.

nall returns the number in list, nextra the number of specials (like planets) that should be at end of list). typ returns the list of corresponding types.

Reimplemented from casacore::Measure.

static void casacore::MRadialVelocity::assure ( const Measure & in ) [static]

static MRadialVelocity::Types casacore::MRadialVelocity::castType ( uInt tp ) [static]

Translate reference code.

The uInt version has a check for valid codes (i.e. it is a safe cast).

Thrown Exceptions

AipsError in the uInt interface if illegal code given

static void casacore::MRadialVelocity::checkMyTypes ( ) [static]

virtual void casacore::MRadialVelocity::checkTypes ( ) const [virtual]

Check if all internal tables of types (both enum and String) are complete and correct.

This function is called automatically if and when necessary.

Thrown Exceptions

AipsError if a (programming) error in the types.

Implements casacore::Measure.

virtual Measure* casacore::MRadialVelocity::clone ( ) const [virtual]

Make a copy.

Implements casacore::Measure.

static MRadialVelocity casacore::MRadialVelocity::fromDoppler	(	const Measure &	dop,
		MRadialVelocity::Types	typ
	)			`[static]`

For internal use only.

static MRadialVelocity casacore::MRadialVelocity::fromDoppler	(	const MDoppler &	dop,
		MRadialVelocity::Types	typ
	)			`[static]`

static MRadialVelocity casacore::MRadialVelocity::fromDoppler ( const MDoppler & dop ) [static]

Make a RadialVelocity from the Doppler velocity (assuming LSRK default).

Quantity casacore::MRadialVelocity::get ( const Unit & un ) const

Get radial velocity in specified units.

virtual const String& casacore::MRadialVelocity::getDefaultType ( ) const [virtual]

Get the default reference type.

Implements casacore::Measure.

virtual String casacore::MRadialVelocity::getRefString ( ) const [virtual]

Get the reference type (for records, including codes like R_).

Implements casacore::Measure.

static Bool casacore::MRadialVelocity::getType	(	MRadialVelocity::Types &	tp,
		const String &	in
	)			`[static]`

Translate string to reference code.

Bool casacore::MRadialVelocity::giveMe	(	MRadialVelocity::Ref &	mr,
		const String &	in
	)

static uInt casacore::MRadialVelocity::myType ( ) [static]

Get my type (as Register).

virtual Bool casacore::MRadialVelocity::setOffset ( const Measure & in ) [virtual]

Set the offset in the reference (False if non-matching Measure).

virtual Bool casacore::MRadialVelocity::setRefString ( const String & in ) [virtual]

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

static const String& casacore::MRadialVelocity::showMe ( ) [static]

static const String& casacore::MRadialVelocity::showType ( uInt tp ) [static]

static const String& casacore::MRadialVelocity::showType ( MRadialVelocity::Types tp ) [static]

virtual const String& casacore::MRadialVelocity::tellMe ( ) const [virtual]

Tell me your type.

Implements casacore::Measure.

static MDoppler casacore::MRadialVelocity::toDoppler ( const Measure & in ) [static]

Local use only.

MDoppler casacore::MRadialVelocity::toDoppler ( )

Make a Doppler velocity (as an MDoppler::BETA default) from the RadialVelocity.

virtual uInt casacore::MRadialVelocity::type ( ) const [virtual]

Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();.

Implements casacore::Measure.

typedef casacore::MRadialVelocity::WHATEVER_SUN_TYPEDEF ( MRadialVelocity )

Reference enum Types (included originally for gcc 2.95).

Friends And Related Function Documentation

friend class MeasConvert< MRadialVelocity > [friend]

Conversion of data.

Definition at line 142 of file MRadialVelocity.h.

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

casacore/measures/Measures/MRadialVelocity.h

casacore::MRadialVelocity Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Thrown Exceptions

Thrown Exceptions

Friends And Related Function Documentation