casacore
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
casacore::MRadialVelocity Class Reference

More...

#include <MRadialVelocity.h>

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. More...
 
typedef MCRadialVelocity MCType
 Measure conversion routines for this class (i.e. More...
 
typedef MeasRef< MRadialVelocityRef
 Measure reference (i.e. More...
 
typedef MeasConvert< MRadialVelocityConvert
 Measure conversion use (i.e. More...
 
typedef ScalarMeasColumn< MRadialVelocityScalarColumn
 Measure table Columns (e.g., MRadialVelocity::ScalarColumn) More...
 
typedef ArrayMeasColumn< MRadialVelocityArrayColumn
 
- Public Types inherited from casacore::Measure
enum  Types {
  N_Types ,
  DEFAULT
}
 Each derived class should have a Types enumeration, specifying the recognised frame types. More...
 
typedef void * Convert
 Each Measure should have typedefs of the form: More...
 

Public Member Functions

 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 More...
 
 MRadialVelocity (const MVRadialVelocity &dt)
 Create from data and reference. More...
 
 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. More...
 
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) More...
 
virtual Bool setRefString (const String &in)
 Set the reference type to the specified String. More...
 
virtual const StringgetDefaultType () const
 Get the default reference type. More...
 
virtual const StringallTypes (Int &nall, Int &nextra, const uInt *&typ) const
 Get a list of all known reference codes. More...
 
virtual void checkTypes () const
 Check if all internal tables of types (both enum and String) are complete and correct. More...
 
virtual String getRefString () const
 Get the reference type (for records, including codes like R_) More...
 
Quantity get (const Unit &un) const
 Get radial velocity in specified units. More...
 
MDoppler toDoppler ()
 Make a Doppler velocity (as an MDoppler::BETA default) from the RadialVelocity. More...
 
virtual Measureclone () const
 Make a copy. More...
 
- Public Member Functions inherited from casacore::MeasBase< MVRadialVelocity, MeasRef< MRadialVelocity > >
 MeasBase ()
 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; For reasons of compiler limitations the formal arguments had to be specified as uInt rather than the Measure enums that should be used as actual arguments;
Default constructor More...
 
 MeasBase (const MeasBase< MVRadialVelocity, MeasRef< MRadialVelocity > > &other)
 Copy constructor. More...
 
 MeasBase (const MVRadialVelocity &dt, const MeasRef< MRadialVelocity > &rf)
 Create from data and reference. More...
 
 MeasBase (const MVRadialVelocity &dt, uInt rf)
 
 MeasBase (const Quantity &dt, const MeasRef< MRadialVelocity > &rf)
 
 MeasBase (const Quantity &dt, uInt rf)
 
 MeasBase (const Measure *dt)
 
 MeasBase (const MeasRef< MRadialVelocity > &rf)
 
 MeasBase (const uInt rf)
 
MeasBase< MVRadialVelocity, MeasRef< MRadialVelocity > > & operator= (const MeasBase< MVRadialVelocity, MeasRef< MRadialVelocity > > &other)
 Copy assignment. More...
 
virtual ~MeasBase ()
 
virtual Bool areYou (const String &tp) const
 Check the type of derived entity. More...
 
virtual void assured (const String &tp) const
 Assert that we are the correct type. More...
 
void set (const MVRadialVelocity &dt)
 Refill the specified entities. More...
 
void set (const MeasRef< MRadialVelocity > &rf)
 
void set (const MVRadialVelocity &dt, const MeasRef< MRadialVelocity > &rf)
 
void set (const Unit &inunit)
 
virtual void set (const MeasValue &dt)
 Each Measure should have the following set functions (with appropiate MVs and Ref): More...
 
virtual Bool putValue (const Vector< Quantum< Double > > &in)
 
MeasRef< MRadialVelocitygetRef () const
 Get reference. More...
 
const MVRadialVelocitygetValue () const
 Get Measure data. More...
 
const UnitgetUnit () const
 Get Unit. More...
 
virtual MRBasegetRefPtr () const
 Get reference pointer. More...
 
virtual const MeasValuegetData () const
 Get pointer to data. More...
 
virtual void print (std::ostream &os) const
 Print a Measure. More...
 
- Public Member Functions inherited from casacore::Measure
virtual ~Measure ()
 Destructor. More...
 
virtual Bool isModel () const
 Tell me if you are a pure model (e.g. More...
 
void dummy_giveMe () const
 Each derived class should have a string-to-code translation routine for the reference type. More...
 
void dummy_getRef () const
 Each class should have a function to return its reference: More...
 
void dummy_getValue () const
 Each derived class should be able to get its internal value and have: More...
 

Static Public Member Functions

static const StringshowMe ()
 
static void assure (const Measure &in)
 
static MRadialVelocity::Types castType (uInt tp)
 Translate reference code. More...
 
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. More...
 
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
 
static void checkMyTypes ()
 
static MDoppler toDoppler (const Measure &in)
 Local use only. More...
 
static MRadialVelocity fromDoppler (const MDoppler &dop)
 Make a RadialVelocity from the Doppler velocity (assuming LSRK default) More...
 
static MRadialVelocity fromDoppler (const MDoppler &dop, MRadialVelocity::Types typ)
 
static MRadialVelocity fromDoppler (const Measure &dop, MRadialVelocity::Types typ)
 For internal use only. More...
 
- Static Public Member Functions inherited from casacore::Measure
static uInt giveMe (const String &in, Int N_name, const String tname[])
 A general string checking routine to be used in derived measures. More...
 

Friends

class MeasConvert< MRadialVelocity >
 Conversion of data. More...
 

Additional Inherited Members

- Protected Attributes inherited from casacore::MeasBase< MVRadialVelocity, MeasRef< MRadialVelocity > >
MVRadialVelocity data
 The measure value (e.g. More...
 
MeasRef< MRadialVelocityref
 Reference frame data. More...
 
Unit unit
 Possible input units. More...
 

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::Z)() << endl;
MeasConvert< MDoppler > Convert
Measure Convert (i.e.
Definition: MDoppler.h:168
MDoppler toDoppler()
Make a Doppler velocity (as an MDoppler::BETA default) from the RadialVelocity.
MRadialVelocity()
Tip: In the following constructors and other functions, all MeasRef can be replaced with simple Measu...
Quantum< Double > Quantity
Definition: Quantum.h:38

Motivation

Definition at line 137 of file MRadialVelocity.h.

Member Typedef Documentation

◆ ArrayColumn

Definition at line 178 of file MRadialVelocity.h.

◆ Convert

Measure conversion use (i.e.

MRadialVelocity::Convert)

Definition at line 175 of file MRadialVelocity.h.

◆ MCType

Measure conversion routines for this class (i.e.

MRadialVelocity::MCType)

Definition at line 171 of file MRadialVelocity.h.

◆ MVType

Measure value container for this class (i.e.

MRadialVelocity::MVType)

Definition at line 169 of file MRadialVelocity.h.

◆ Ref

Measure reference (i.e.

MRadialVelocity::Ref)

Definition at line 173 of file MRadialVelocity.h.

◆ ScalarColumn

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

Definition at line 177 of file MRadialVelocity.h.

Member Enumeration Documentation

◆ 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.

Definition at line 152 of file MRadialVelocity.h.

Constructor & Destructor Documentation

◆ MRadialVelocity() [1/9]

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

◆ MRadialVelocity() [2/9]

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

Create from data and reference.

◆ MRadialVelocity() [3/9]

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

◆ MRadialVelocity() [4/9]

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

◆ MRadialVelocity() [5/9]

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

◆ MRadialVelocity() [6/9]

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

◆ MRadialVelocity() [7/9]

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

◆ MRadialVelocity() [8/9]

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

◆ MRadialVelocity() [9/9]

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

◆ ~MRadialVelocity()

virtual casacore::MRadialVelocity::~MRadialVelocity ( )
virtual

Member Function Documentation

◆ allMyTypes()

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

◆ allTypes()

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.

◆ assure()

static void casacore::MRadialVelocity::assure ( const Measure in)
static

◆ castType()

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

◆ checkMyTypes()

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

◆ checkTypes()

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.

◆ clone()

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

Make a copy.

Implements casacore::Measure.

◆ fromDoppler() [1/3]

static MRadialVelocity casacore::MRadialVelocity::fromDoppler ( const MDoppler dop)
static

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

◆ fromDoppler() [2/3]

static MRadialVelocity casacore::MRadialVelocity::fromDoppler ( const MDoppler dop,
MRadialVelocity::Types  typ 
)
static

◆ fromDoppler() [3/3]

static MRadialVelocity casacore::MRadialVelocity::fromDoppler ( const Measure dop,
MRadialVelocity::Types  typ 
)
static

For internal use only.

◆ get()

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

Get radial velocity in specified units.

◆ getDefaultType()

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

Get the default reference type.

Implements casacore::Measure.

◆ getRefString()

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

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

Implements casacore::Measure.

◆ getType()

static Bool casacore::MRadialVelocity::getType ( MRadialVelocity::Types tp,
const String in 
)
static

Translate string to reference code.

◆ giveMe()

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

◆ setOffset()

virtual Bool casacore::MRadialVelocity::setOffset ( const Measure in)
virtual

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

Implements casacore::Measure.

◆ setRefString()

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.

◆ showMe()

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

◆ showType() [1/2]

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

◆ showType() [2/2]

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

◆ tellMe()

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

Tell me your type.

Implements casacore::Measure.

◆ toDoppler() [1/2]

MDoppler casacore::MRadialVelocity::toDoppler ( )

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

◆ toDoppler() [2/2]

static MDoppler casacore::MRadialVelocity::toDoppler ( const Measure in)
static

Local use only.

Friends And Related Function Documentation

◆ MeasConvert< MRadialVelocity >

friend class MeasConvert< MRadialVelocity >
friend

Conversion of data.

Definition at line 1 of file MRadialVelocity.h.


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