casa::MFrequency Class Reference
[Measures]

#include <MFrequency.h>

Inheritance diagram for casa::MFrequency:

[legend]Collaboration diagram for casa::MFrequency:

[legend]List of all members.

Detailed Description

A Measure: wave characteristics.

Intended use:

Part of API

Review Status

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

Prerequisite

Measure class
MRadialVelocity class for some other background.

Etymology

Synopsis

MFrequency is a derived Measure class for wave characteristics.
An MFrequency can be generated from a simple value (or an MFrequency object), which is then interpreted as a frequency in Hz, 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:

time (e.g. s): period <it> frequency (e.g. Hz): frequency <it> angular frequency (e.g. arcmin/s): angular frequency <it> length (e.g. cm): wavelength <it> inverse length (e.g. mm^-1): wave number <it> energy (e.g. J.s): energy (i.e. h.nu) <it> momentum (e.g. kg.m): m.c/h The different reference types of a frequency are:

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

Conversion between the different types is done with the standard MeasConvert class (MFrequency::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:

Radial Velocity: REST
Epoch: TOPO, GEO
Position: TOPO
Direction all

An MFrequency can be created from an MDoppler (and a rest frequency, (the QC class contains at least QC::HI)) by the fromDoppler() member. It can be converted to an MDoppler with the toDoppler(). Comparable methods will be available for MFrequency as toRadial() and fromRadial.
If the Doppler shift is known (e.g. from another spectral line), the REST frequency can be determined with the toREST() member. Caution: Conversion between the different frequencies can, due to relativistic effects, only be done approximately for very high (order c) radial velocities (shifted frequencies). A better approach would be to start from radial velocities and a rest frequency.

Example

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

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

Motivation

To Do

Definition at line 153 of file MFrequency.h.

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();.

static const String & showMe ()

static void assure (const Measure &in)

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

static Bool getType (MFrequency::Types &tp, const String &in)

Translate string to reference code.

virtual const String *const allTypes (Int &nall, Int &nextra, const uInt *&typ) const

Get a list of all known reference codes.

static const String *const allMyTypes (Int &nall, Int &nextra, const uInt *&typ)

virtual void checkTypes () const

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

static void checkMyTypes ()

Public Types

enum Types

Types of known MFrequencies Warning: The order defines the order in the translation matrix FromTo in the getConvert routine. More...

typedef MVFrequency MVType

Measure value container for this class (i.e.

typedef MCFrequency MCType

Measure conversion routines for this class (i.e.

typedef MeasRef< MFrequency > Ref

Measure reference (i.e.

typedef MeasConvert< MFrequency > Convert

Measure conversion use (i.e.

typedef ROScalarMeasColumn<
MFrequency > ROScalarColumn

Measure table Columns (e.g., MFrequency::ROScalarColumn).

typedef ScalarMeasColumn<
MFrequency > ScalarColumn

typedef ROArrayMeasColumn<
MFrequency > ROArrayColumn

typedef ArrayMeasColumn< MFrequency > ArrayColumn

Public Member Functions

typedef WHATEVER_SUN_TYPEDEF (MFrequency) Types Types

Reference enum Types (included originally for gcc 2.95).

MFrequency ()

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.

virtual ~MFrequency ()

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 String getRefString () const

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

Quantity get (const Unit &un) const

Get frequency in specified units.

MFrequency toRest (const MDoppler &dop)

Make a rest frequency using a Doppler velocity.

MDoppler toDoppler (const MVFrequency &rest)

Make a Doppler velocity from the frequency and the specified rest frequency.

MDoppler toDoppler (const MVFrequency &rest) const

virtual Measure * clone () const

Make a copy.

Static Public Member Functions

static uInt myType ()

Get my type (as Register).

static MDoppler toDoppler (const Measure &in, const MVFrequency &rest)

Local use only.

static MFrequency toRest (const Measure &in, const Measure &dop)

For local use only.

static MFrequency::Types castType (uInt tp)

Translate reference code.

static const String & showType (MFrequency::Types tp)

static const String & showType (uInt tp)

static MFrequency fromDoppler (const MDoppler &dop, const MVFrequency &rest)

Make a frequency from the Doppler velocity and the specified rest frequency (default reference type LSRK).

static MFrequency fromDoppler (const MDoppler &dop, const MVFrequency &rest, MFrequency::Types type)

static MFrequency fromDoppler (const Measure &dop, const MVFrequency &rest, MFrequency::Types type)

For internal use only.

Friends

class MeasConvert< MFrequency >

Conversion of data.

Member Typedef Documentation

typedef MVFrequency casa::MFrequency::MVType

Measure value container for this class (i.e.

MFrequency::MVType)

Definition at line 186 of file MFrequency.h.

typedef MCFrequency casa::MFrequency::MCType

Measure conversion routines for this class (i.e.

MFrequency::MCType)

Definition at line 188 of file MFrequency.h.

typedef MeasRef<MFrequency> casa::MFrequency::Ref

Measure reference (i.e.

MFrequency::Ref)

Definition at line 190 of file MFrequency.h.

typedef MeasConvert<MFrequency> casa::MFrequency::Convert

Measure conversion use (i.e.

MFrequency::Convert)

Reimplemented from casa::Measure.

Definition at line 192 of file MFrequency.h.

typedef ROScalarMeasColumn<MFrequency> casa::MFrequency::ROScalarColumn

Measure table Columns (e.g., MFrequency::ROScalarColumn).

Definition at line 194 of file MFrequency.h.

typedef ScalarMeasColumn<MFrequency> casa::MFrequency::ScalarColumn

Definition at line 195 of file MFrequency.h.

typedef ROArrayMeasColumn<MFrequency> casa::MFrequency::ROArrayColumn

Definition at line 196 of file MFrequency.h.

typedef ArrayMeasColumn<MFrequency> casa::MFrequency::ArrayColumn

Definition at line 197 of file MFrequency.h.

Member Enumeration Documentation

enum casa::MFrequency::Types

Types of known MFrequencies 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().

Reimplemented from casa::Measure.

Definition at line 168 of file MFrequency.h.

Constructor & Destructor Documentation

casa::MFrequency::MFrequency ( )

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 frequency

casa::MFrequency::MFrequency ( const MVFrequency & dt )

Create from data and reference.

casa::MFrequency::MFrequency	(	const MVFrequency &	dt,
		const MFrequency::Ref &	rf
	)

casa::MFrequency::MFrequency	(	const MVFrequency &	dt,
		MFrequency::Types	rf
	)

casa::MFrequency::MFrequency ( const Quantity & dt )

casa::MFrequency::MFrequency	(	const Quantity &	dt,
		const MFrequency::Ref &	rf
	)

casa::MFrequency::MFrequency	(	const Quantity &	dt,
		MFrequency::Types	rf
	)

casa::MFrequency::MFrequency ( const Measure * dt )

casa::MFrequency::MFrequency ( const MeasValue * dt )

virtual casa::MFrequency::~MFrequency ( ) [virtual]

casa::MFrequency::MFrequency ( const MVFrequency & dt )

Create from data and reference.

casa::MFrequency::MFrequency	(	const MVFrequency &	dt,
		const MFrequency::Ref &	rf
	)

casa::MFrequency::MFrequency	(	const MVFrequency &	dt,
		MFrequency::Types	rf
	)

casa::MFrequency::MFrequency ( const Quantity & dt )

casa::MFrequency::MFrequency	(	const Quantity &	dt,
		const MFrequency::Ref &	rf
	)

casa::MFrequency::MFrequency	(	const Quantity &	dt,
		MFrequency::Types	rf
	)

casa::MFrequency::MFrequency ( const Measure * dt )

casa::MFrequency::MFrequency ( const MeasValue * dt )

Member Function Documentation

typedef casa::MFrequency::WHATEVER_SUN_TYPEDEF ( MFrequency )

Reference enum Types (included originally for gcc 2.95).

virtual const String& casa::MFrequency::tellMe ( ) const [virtual]

Tell me your type.

Implements casa::Measure.

static const String& casa::MFrequency::showMe ( ) [static]

virtual uInt casa::MFrequency::type ( ) const [virtual]

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

Implements casa::Measure.

static void casa::MFrequency::assure ( const Measure & in ) [static]

static MFrequency::Types casa::MFrequency::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 const String& casa::MFrequency::showType ( MFrequency::Types tp ) [static]

static const String& casa::MFrequency::showType ( uInt tp ) [static]

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

Translate string to reference code.

Bool casa::MFrequency::giveMe	(	MFrequency::Ref &	mr,
		const String &	in
	)

virtual Bool casa::MFrequency::setOffset ( const Measure & in ) [virtual]

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

Implements casa::Measure.

virtual Bool casa::MFrequency::setRefString ( const String & in ) [virtual]

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casa::Measure.

virtual const String& casa::MFrequency::getDefaultType ( ) const [virtual]

Get the default reference type.

Implements casa::Measure.

virtual const String* const casa::MFrequency::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 casa::Measure.

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

virtual void casa::MFrequency::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 casa::Measure.

static void casa::MFrequency::checkMyTypes ( ) [static]

virtual String casa::MFrequency::getRefString ( ) const [virtual]

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

Implements casa::Measure.

static uInt casa::MFrequency::myType ( ) [static]

Get my type (as Register).

Quantity casa::MFrequency::get ( const Unit & un ) const

Get frequency in specified units.

Referenced by casa::SimSpWin::chanFreq().

MDoppler casa::MFrequency::toDoppler ( const MVFrequency & rest )

Make a Doppler velocity from the frequency and the specified rest frequency.

MDoppler casa::MFrequency::toDoppler ( const MVFrequency & rest ) const

static MDoppler casa::MFrequency::toDoppler	(	const Measure &	in,
		const MVFrequency &	rest
	)			`[static]`

Local use only.

static MFrequency casa::MFrequency::fromDoppler	(	const MDoppler &	dop,
		const MVFrequency &	rest
	)			`[static]`

Make a frequency from the Doppler velocity and the specified rest frequency (default reference type LSRK).

static MFrequency casa::MFrequency::fromDoppler	(	const MDoppler &	dop,
		const MVFrequency &	rest,
		MFrequency::Types	type
	)			`[static]`

static MFrequency casa::MFrequency::fromDoppler	(	const Measure &	dop,
		const MVFrequency &	rest,
		MFrequency::Types	type
	)			`[static]`

For internal use only.

MFrequency casa::MFrequency::toRest ( const MDoppler & dop )

Make a rest frequency using a Doppler velocity.

static MFrequency casa::MFrequency::toRest	(	const Measure &	in,
		const Measure &	dop
	)			`[static]`

For local use only.

virtual Measure* casa::MFrequency::clone ( ) const [virtual]

Make a copy.

Implements casa::Measure.

Friends And Related Function Documentation

friend class MeasConvert< MFrequency > [friend]

Conversion of data.

Definition at line 158 of file MFrequency.h.

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

measures/implement/Measures/MFrequency.h

Generated on Mon Sep 1 22:46:00 2008 for NRAOCASA by

1.5.1


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();.
static const String &	showMe ()
static void	assure (const Measure &in)
Bool	giveMe (MFrequency::Ref &mr, const String &in)
static Bool	getType (MFrequency::Types &tp, const String &in)
	Translate string to reference code.
virtual const String *const	allTypes (Int &nall, Int &nextra, const uInt *&typ) const
	Get a list of all known reference codes.
static const String *const	allMyTypes (Int &nall, Int &nextra, const uInt *&typ)
virtual void	checkTypes () const
	Check if all internal tables of types (both enum and String) are complete and correct.
static void	checkMyTypes ()
Public Types
enum	Types
	Types of known MFrequencies Warning: The order defines the order in the translation matrix FromTo in the getConvert routine. More...
typedef MVFrequency	MVType
	Measure value container for this class (i.e.
typedef MCFrequency	MCType
	Measure conversion routines for this class (i.e.
typedef MeasRef< MFrequency >	Ref
	Measure reference (i.e.
typedef MeasConvert< MFrequency >	Convert
	Measure conversion use (i.e.
typedef ROScalarMeasColumn< MFrequency >	ROScalarColumn
	Measure table Columns (e.g., MFrequency::ROScalarColumn).
typedef ScalarMeasColumn< MFrequency >	ScalarColumn
typedef ROArrayMeasColumn< MFrequency >	ROArrayColumn
typedef ArrayMeasColumn< MFrequency >	ArrayColumn
Public Member Functions
typedef	WHATEVER_SUN_TYPEDEF (MFrequency) Types Types
	Reference enum Types (included originally for gcc 2.95).
	MFrequency ()
	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.*
virtual	~MFrequency ()
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 String	getRefString () const
	Get the reference type (for records, including codes like R_).
Quantity	get (const Unit &un) const
	Get frequency in specified units.
MFrequency	toRest (const MDoppler &dop)
	Make a rest frequency using a Doppler velocity.

MDoppler	toDoppler (const MVFrequency &rest)
	Make a Doppler velocity from the frequency and the specified rest frequency.
MDoppler	toDoppler (const MVFrequency &rest) const

virtual Measure *	clone () const
	Make a copy.
Static Public Member Functions
static uInt	myType ()
	Get my type (as Register).
static MDoppler	toDoppler (const Measure &in, const MVFrequency &rest)
	Local use only.
static MFrequency	toRest (const Measure &in, const Measure &dop)
	For local use only.

static MFrequency::Types	castType (uInt tp)
	Translate reference code.
static const String &	showType (MFrequency::Types tp)
static const String &	showType (uInt tp)

static MFrequency	fromDoppler (const MDoppler &dop, const MVFrequency &rest)
	Make a frequency from the Doppler velocity and the specified rest frequency (default reference type LSRK).
static MFrequency	fromDoppler (const MDoppler &dop, const MVFrequency &rest, MFrequency::Types type)
static MFrequency	fromDoppler (const Measure &dop, const MVFrequency &rest, MFrequency::Types type)
	For internal use only.
Friends
class	MeasConvert< MFrequency >
	Conversion of data.

casa::MFrequency Class Reference [Measures]

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Example

Motivation

To Do

Public Types

Public Member Functions

Static Public Member Functions

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Thrown Exceptions

Thrown Exceptions

Friends And Related Function Documentation

casa::MFrequency Class Reference
[Measures]