casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Public Member Functions | Friends
casa::MRadialVelocity Class Reference

A Measure: radial velocity. More...

#include <MRadialVelocity.h>

Inheritance diagram for casa::MRadialVelocity:
casa::MeasBase< MVRadialVelocity, MeasRef< MRadialVelocity > > casa::Measure

List of all members.

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< MRadialVelocityRef
 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 StringtellMe () 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 StringgetDefaultType () const
 Get the default reference type.
virtual const StringallTypes (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 Measureclone () const
 Make a copy.

Static Public Member Functions

static const StringshowMe ()
static void assure (const Measure &in)
static MRadialVelocity::Types castType (uInt tp)
 Translate reference code.
static const StringshowType (MRadialVelocity::Types tp)
static const StringshowType (uInt tp)
static Bool getType (MRadialVelocity::Types &tp, const String &in)
 Translate string to reference code.
static const StringallMyTypes (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

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:

The different reference types of a RadialVelocity are:

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:



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

Definition at line 178 of file MRadialVelocity.h.

Measure conversion use (i.e.

MRadialVelocity::Convert)

Reimplemented from casa::Measure.

Definition at line 175 of file MRadialVelocity.h.

Measure conversion routines for this class (i.e.

MRadialVelocity::MCType)

Definition at line 171 of file MRadialVelocity.h.

Measure value container for this class (i.e.

MRadialVelocity::MVType)

Definition at line 169 of file MRadialVelocity.h.

Measure reference (i.e.

MRadialVelocity::Ref)

Definition at line 173 of file MRadialVelocity.h.

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

Definition at line 177 of file MRadialVelocity.h.


Member Enumeration Documentation

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

Definition at line 152 of file MRadialVelocity.h.


Constructor & Destructor Documentation


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

Create from data and reference.

    


Member Function Documentation

static const String* casa::MRadialVelocity::allMyTypes ( Int nall,
Int nextra,
const uInt *&  typ 
) [static]
virtual const String* casa::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 casa::Measure.

static void casa::MRadialVelocity::assure ( const Measure in) [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 casa::MRadialVelocity::checkMyTypes ( ) [static]
virtual void casa::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 casa::Measure.

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

Make a copy.

Implements casa::Measure.

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

For internal use only.

Quantity casa::MRadialVelocity::get ( const Unit un) const

Get radial velocity in specified units.

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

Get the default reference type.

Implements casa::Measure.

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

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

Implements casa::Measure.

static Bool casa::MRadialVelocity::getType ( MRadialVelocity::Types tp,
const String in 
) [static]

Translate string to reference code.

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

Get my type (as Register)

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

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

Implements casa::Measure.

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

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casa::Measure.

static const String& casa::MRadialVelocity::showMe ( ) [static]
static const String& casa::MRadialVelocity::showType ( uInt  tp) [static]
virtual const String& casa::MRadialVelocity::tellMe ( ) const [virtual]

Tell me your type.

Implements casa::Measure.

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

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

Local use only.

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

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

Implements casa::Measure.

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: