casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
casacore::MDoppler Class Reference

A Measure: Doppler shift. More...

#include <MDoppler.h>

Inheritance diagram for casacore::MDoppler:
casacore::MeasBase< MVDoppler, MeasRef< MDoppler > > casacore::Measure

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. More...
 
typedef MCDoppler MCType
 Measure conversion routines for this class (i.e. More...
 
typedef MeasRef< MDopplerRef
 Measure reference (i.e. More...
 
typedef MeasConvert< MDopplerConvert
 Measure Convert (i.e. More...
 
typedef ScalarMeasColumn
< MDoppler
ScalarColumn
 Measure table Columns (e.g., MDoppler::ScalarColumn) More...
 
typedef ArrayMeasColumn< MDopplerArrayColumn
 
- 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

 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 More...
 
 MDoppler (const MVDoppler &dt)
 Create from data and reference. More...
 
 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 StringtellMe () const
 Tell me your type. More...
 
virtual uInt type () const
 Get the type (== Register() of derived Measure (faster than Strings) All should have: static uInt myType();. More...
 
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) 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 in specified units. More...
 
Vector< DoubleshiftFrequency (const Vector< Double > &freq) const
 Shift the input frequencies to the output frequencies. More...
 
Quantum< Vector< Double > > shiftFrequency (const Quantum< Vector< Double > > &freq) const
 
virtual Measureclone () const
 Make a copy. More...
 
- Public Member Functions inherited from casacore::MeasBase< MVDoppler, MeasRef< MDoppler > >
 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< MVDoppler, MeasRef< MDoppler > > &other)
 Copy constructor. More...
 
 MeasBase (const MVDoppler &dt, const MeasRef< MDoppler > &rf)
 Create from data and reference. More...
 
 MeasBase (const MVDoppler &dt, uInt rf)
 
 MeasBase (const Quantity &dt, const MeasRef< MDoppler > &rf)
 
 MeasBase (const Quantity &dt, uInt rf)
 
 MeasBase (const Measure *dt)
 
 MeasBase (const MeasRef< MDoppler > &rf)
 
 MeasBase (const uInt rf)
 
MeasBase< MVDoppler, MeasRef
< MDoppler > > & 
operator= (const MeasBase< MVDoppler, MeasRef< MDoppler > > &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 MVDoppler &dt)
 Refill the specified entities. More...
 
void set (const MeasRef< MDoppler > &rf)
 
void set (const MVDoppler &dt, const MeasRef< MDoppler > &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< MDopplergetRef () const
 Get reference. More...
 
const MVDopplergetValue () 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 MDoppler::Types castType (uInt tp)
 Translate reference code. More...
 
static const StringshowType (MDoppler::Types tp)
 
static const StringshowType (uInt tp)
 
static Bool getType (MDoppler::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 uInt myType ()
 Get my type (as Register) 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< MDoppler >
 Conversion of data. More...
 

Additional Inherited Members

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

Detailed Description

A Measure: Doppler shift.

Intended use:

Public interface

Review Status

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

Prerequisite

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:

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

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

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

Definition at line 171 of file MDoppler.h.

Measure Convert (i.e.

MDoppler::Convert)

Definition at line 168 of file MDoppler.h.

Measure conversion routines for this class (i.e.

MDoppler::MCType)

Definition at line 164 of file MDoppler.h.

Measure value container for this class (i.e.

MDoppler::MVType)

Definition at line 162 of file MDoppler.h.

Measure reference (i.e.

MDoppler::Ref)

Definition at line 166 of file MDoppler.h.

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

Definition at line 170 of file MDoppler.h.

Member Enumeration Documentation

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 

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.

Referenced by casa::PlotMSTransformations::setVelDef().

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)

Implements casacore::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.

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.

Quantum<Vector<Double> > casacore::MDoppler::shiftFrequency ( const Quantum< Vector< Double > > &  freq) const
static const String& casacore::MDoppler::showMe ( )
static
static const String& casacore::MDoppler::showType ( MDoppler::Types  tp)
static
static const String& casacore::MDoppler::showType ( uInt  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.

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: