casacore::MDoppler Class Reference

#include <MDoppler.h>

Inheritance diagram for casacore::MDoppler:

Public Types
enum	Types { RADIO, Z, RATIO, BETA, GAMMA, N_Types, OPTICAL, RELATIVISTIC, DEFAULT }
	Types of known MDopplers 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 MVDoppler	MVType
	Measure value container for this class (i.e.
typedef MCDoppler	MCType
	Measure conversion routines for this class (i.e.
typedef MeasRef< MDoppler >	Ref
	Measure reference (i.e.
typedef MeasConvert< MDoppler >	Convert
	Measure Convert (i.e.
typedef ScalarMeasColumn < MDoppler >	ScalarColumn
	Measure table Columns (e.g., MDoppler::ScalarColumn).
typedef ArrayMeasColumn< MDoppler >	ArrayColumn
Public Member Functions
typedef	WHATEVER_SUN_TYPEDEF (MDoppler) Types Types
	Reference enum Types (included originally for gcc 2.95).
	MDoppler ()
	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 Doppler
	MDoppler (const MVDoppler &dt)
	Create from data and reference.
	MDoppler (const MVDoppler &dt, const MDoppler::Ref &rf)
	MDoppler (const MVDoppler &dt, MDoppler::Types rf)
	MDoppler (const Quantity &dt)
	MDoppler (const Quantity &dt, const MDoppler::Ref &rf)
	MDoppler (const Quantity &dt, MDoppler::Types rf)
	MDoppler (const Measure *dt)
	MDoppler (const MeasValue *dt)
virtual	~MDoppler ()
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 (MDoppler::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 in specified units.
Vector< Double >	shiftFrequency (const Vector< Double > &freq) const
	Shift the input frequencies to the output frequencies.
Quantum< Vector< Double > >	shiftFrequency (const Quantum< Vector< Double > > &freq) const
virtual Measure *	clone () const
	Make a copy.
Static Public Member Functions
static const String &	showMe ()
static void	assure (const Measure &in)
static MDoppler::Types	castType (uInt tp)
	Translate reference code.
static const String &	showType (MDoppler::Types tp)
static const String &	showType (uInt tp)
static Bool	getType (MDoppler::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).
Friends
class	MeasConvert< MDoppler >
	Conversion of data.

Detailed Description

A Measure: Doppler shift.

Intended use:

Public interface

Review Status

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

Prerequisite

Measure class

Etymology

From Measure and Doppler

Synopsis

MDoppler forms the derived Measure class for Doppler shifts.
An MDoppler can be generated from a simple value (or an MVDoppler ), which is then interpreted as a Doppler ratio, and a reference, with a RADIO type as default.
It can also be generated from a Quantity, where the interpretation depends on the dimensionality of the Quantity:

None: a Doppler ratio
Velocity: Doppler ratio calculated by dividing with c

The different types of Doppler (with F = f/f0, the frequency ratio), are:

MDoppler::Z (-1 + 1/F)
MDoppler::RATIO (F) *
MDoppler::RADIO (1 - F)
MDoppler::OPTICAL == Z
MDoppler::BETA ((1 - F²)/(1 + F²))
MDoppler::GAMMA ((1 + F²)/2F) *
MDoppler::RELATIVISTIC == BETA (== v/c)
MDoppler::DEFAULT == RADIO

Note that the ones with an '*' have no real interpretation (although the calculation will proceed) if given as a velocity.

Conversion between the different types is done with the standard MeasConvert class (MDoppler::Convert in this case).

Dopplers can be created from an MFrequency object, or from an MRadialVelocity object.

A shiftFrequency() method can shift frequencies.

Dopplers do not need a reference frame.

Example

Conversion of a radio Doppler to an optical

 MDoppler radio(0.01);          // A radio Doppler value
 cout << "Doppler radio = " << radio << "; optical = " <<
 MDoppler::Convert(radio, MDoppler::OPTICAL)() << // Convert 
 endl;

Setting up a conversion

 MDoppler::Convert to_opt(MDoppler::RADIO, MDoppler::OPTICAL);
 for (Double d=0; d<0.1; d += 0.005) {
 cout << "radio = " << d << " to optical = " <<
 to_opt(d) << endl;

Motivation

To Do

Definition at line 134 of file MDoppler.h.

Member Typedef Documentation

typedef ArrayMeasColumn<MDoppler> casacore::MDoppler::ArrayColumn

Definition at line 171 of file MDoppler.h.

typedef MeasConvert<MDoppler> casacore::MDoppler::Convert

Measure Convert (i.e.

MDoppler::Convert)

Reimplemented from casacore::Measure.

Definition at line 168 of file MDoppler.h.

typedef MCDoppler casacore::MDoppler::MCType

Measure conversion routines for this class (i.e.

MDoppler::MCType)

Definition at line 164 of file MDoppler.h.

typedef MVDoppler casacore::MDoppler::MVType

Measure value container for this class (i.e.

MDoppler::MVType)

Definition at line 162 of file MDoppler.h.

typedef MeasRef<MDoppler> casacore::MDoppler::Ref

Measure reference (i.e.

MDoppler::Ref)

Definition at line 166 of file MDoppler.h.

typedef ScalarMeasColumn<MDoppler> casacore::MDoppler::ScalarColumn

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

Definition at line 170 of file MDoppler.h.

Member Enumeration Documentation

enum casacore::MDoppler::Types

Types of known MDopplers
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:

RADIO
Z
RATIO
BETA
GAMMA
N_Types
OPTICAL
RELATIVISTIC
DEFAULT

Reimplemented from casacore::Measure.

Definition at line 149 of file MDoppler.h.

Constructor & Destructor Documentation

casacore::MDoppler::MDoppler ( )

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 Doppler

casacore::MDoppler::MDoppler ( const MVDoppler & dt )

Create from data and reference.

casacore::MDoppler::MDoppler	(	const MVDoppler &	dt,
		const MDoppler::Ref &	rf
	)

casacore::MDoppler::MDoppler	(	const MVDoppler &	dt,
		MDoppler::Types	rf
	)

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

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

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

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

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

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

Member Function Documentation

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

virtual const String* casacore::MDoppler::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::MDoppler::assure ( const Measure & in ) [static]

static MDoppler::Types casacore::MDoppler::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::MDoppler::checkMyTypes ( ) [static]

virtual void casacore::MDoppler::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::MDoppler::clone ( ) const [virtual]

Make a copy.

Implements casacore::Measure.

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

Get in specified units.

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

Get the default reference type.

Implements casacore::Measure.

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

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

Implements casacore::Measure.

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

Translate string to reference code.

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

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

Get my type (as Register).

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

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

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

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

Quantum<Vector<Double> > casacore::MDoppler::shiftFrequency ( const Quantum< Vector< Double > > & freq ) const

Vector<Double> casacore::MDoppler::shiftFrequency ( const Vector< Double > & freq ) const

Shift the input frequencies to the output frequencies.

In the case of simple Double inputs, it is assumed that the values are linearly dependent on frequency. I.e. frequencies given as wavelength or time cannot be used.

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

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

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

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

Tell me your type.

Implements casacore::Measure.

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

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

Implements casacore::Measure.

typedef casacore::MDoppler::WHATEVER_SUN_TYPEDEF ( MDoppler )

Reference enum Types (included originally for gcc 2.95).

Friends And Related Function Documentation

friend class MeasConvert< MDoppler > [friend]

Conversion of data.

Definition at line 139 of file MDoppler.h.

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

casacore/measures/Measures/MDoppler.h

casacore::MDoppler Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Thrown Exceptions

Thrown Exceptions

Friends And Related Function Documentation