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::MFrequency Class Reference

A Measure: wave characteristics. More...

#include <MFrequency.h>

Inheritance diagram for casacore::MFrequency:
casacore::MeasBase< MVFrequency, MeasRef< MFrequency > > casacore::Measure

Public Types

enum  Types {
  REST,
  LSRK,
  LSRD,
  BARY,
  GEO,
  TOPO,
  GALACTO,
  LGROUP,
  CMB,
  N_Types,
  Undefined,
  N_Other,
  EXTRA,
  DEFAULT,
  LSR
}
 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();
More...
 
typedef MVFrequency MVType
 Measure value container for this class (i.e. More...
 
typedef MCFrequency MCType
 Measure conversion routines for this class (i.e. More...
 
typedef MeasRef< MFrequencyRef
 Measure reference (i.e. More...
 
typedef MeasConvert< MFrequencyConvert
 Measure conversion use (i.e. More...
 
typedef ScalarMeasColumn
< MFrequency
ScalarColumn
 Measure table Columns (e.g., MFrequency::ScalarColumn) More...
 
typedef ArrayMeasColumn
< MFrequency
ArrayColumn
 
- 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

 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 More...
 
 MFrequency (const MVFrequency &dt)
 Create from data and reference. More...
 
 MFrequency (const MVFrequency &dt, const MFrequency::Ref &rf)
 
 MFrequency (const MVFrequency &dt, MFrequency::Types rf)
 
 MFrequency (const Quantity &dt)
 
 MFrequency (const Quantity &dt, const MFrequency::Ref &rf)
 
 MFrequency (const Quantity &dt, MFrequency::Types rf)
 
 MFrequency (const Measure *dt)
 
 MFrequency (const MeasValue *dt)
 
virtual ~MFrequency ()
 
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 (MFrequency::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 frequency in specified units. More...
 
MDoppler toDoppler (const MVFrequency &rest)
 Make a Doppler velocity from the frequency and the specified rest frequency. More...
 
MDoppler toDoppler (const MVFrequency &rest) const
 
MFrequency toRest (const MDoppler &dop) const
 Make a rest frequency using a Doppler velocity. More...
 
virtual Measureclone () const
 Make a copy. More...
 
- Public Member Functions inherited from casacore::MeasBase< MVFrequency, MeasRef< MFrequency > >
 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< MVFrequency, MeasRef< MFrequency > > &other)
 Copy constructor. More...
 
 MeasBase (const MVFrequency &dt, const MeasRef< MFrequency > &rf)
 Create from data and reference. More...
 
 MeasBase (const MVFrequency &dt, uInt rf)
 
 MeasBase (const Quantity &dt, const MeasRef< MFrequency > &rf)
 
 MeasBase (const Quantity &dt, uInt rf)
 
 MeasBase (const Measure *dt)
 
 MeasBase (const MeasRef< MFrequency > &rf)
 
 MeasBase (const uInt rf)
 
MeasBase< MVFrequency, MeasRef
< MFrequency > > & 
operator= (const MeasBase< MVFrequency, MeasRef< MFrequency > > &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 MVFrequency &dt)
 Refill the specified entities. More...
 
void set (const MeasRef< MFrequency > &rf)
 
void set (const MVFrequency &dt, const MeasRef< MFrequency > &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< MFrequencygetRef () const
 Get reference. More...
 
const MVFrequencygetValue () 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 MFrequency::Types castType (uInt tp)
 Translate reference code. More...
 
static const StringshowType (MFrequency::Types tp)
 
static const StringshowType (uInt tp)
 
static Bool getType (MFrequency::Types &tp, const String &in)
 Translate string to reference code. More...
 
static MFrequency::Types typeFromString (const String &in)
 Throws an exception if the type string is not recognized. More...
 
static const StringallMyTypes (Int &nall, Int &nextra, const uInt *&typ)
 
static void checkMyTypes ()
 
static uInt myType ()
 Get my type (as Register) More...
 
static MDoppler toDoppler (const Measure &in, const MVFrequency &rest)
 Local use only. More...
 
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) More...
 
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. More...
 
static MFrequency toRest (const Measure &in, const Measure &dop)
 For local 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< MFrequency >
 Conversion of data. More...
 

Additional Inherited Members

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

Detailed Description

A Measure: wave characteristics.

Intended use:

Public interface

Review Status

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

Prerequisite

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:

The different reference types of a frequency are:

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:


To accommodate unknown or invalid frames, the additional reference type

is available. Conversions to/from Undefined are not possible. If attempted, an exception will be thrown. The name was chosen to be Undefined and not UNDEFINED in order to not collide with the (ugly) WCSLIB macro of the upper case name and in concordance with Stokes::Undefined.
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::Z)() << endl;

Motivation

Definition at line 161 of file MFrequency.h.

Member Typedef Documentation

Definition at line 207 of file MFrequency.h.

Measure conversion use (i.e.

MFrequency::Convert)

Definition at line 204 of file MFrequency.h.

Measure conversion routines for this class (i.e.

MFrequency::MCType)

Definition at line 200 of file MFrequency.h.

Measure value container for this class (i.e.

MFrequency::MVType)

Definition at line 198 of file MFrequency.h.

Measure reference (i.e.

MFrequency::Ref)

Definition at line 202 of file MFrequency.h.

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

Definition at line 206 of file MFrequency.h.

Member Enumeration Documentation

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

Enumerator
REST 
LSRK 
LSRD 
BARY 
GEO 
TOPO 
GALACTO 
LGROUP 
CMB 
N_Types 
Undefined 
N_Other 
EXTRA 

all extra bits

DEFAULT 

Defaults.

LSR 

Synonyms.

Definition at line 176 of file MFrequency.h.

Constructor & Destructor Documentation

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

casacore::MFrequency::MFrequency ( const MVFrequency dt)

Create from data and reference.

casacore::MFrequency::MFrequency ( const MVFrequency dt,
const MFrequency::Ref rf 
)
casacore::MFrequency::MFrequency ( const MVFrequency dt,
MFrequency::Types  rf 
)
casacore::MFrequency::MFrequency ( const Quantity dt)
casacore::MFrequency::MFrequency ( const Quantity dt,
const MFrequency::Ref rf 
)
casacore::MFrequency::MFrequency ( const Quantity dt,
MFrequency::Types  rf 
)
casacore::MFrequency::MFrequency ( const Measure dt)
casacore::MFrequency::MFrequency ( const MeasValue dt)
virtual casacore::MFrequency::~MFrequency ( )
virtual

Member Function Documentation

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

static void casacore::MFrequency::assure ( const Measure in)
static
static MFrequency::Types casacore::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 void casacore::MFrequency::checkMyTypes ( )
static
virtual void casacore::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 casacore::Measure.

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

Make a copy.

Implements casacore::Measure.

static MFrequency casacore::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 casacore::MFrequency::fromDoppler ( const MDoppler dop,
const MVFrequency rest,
MFrequency::Types  type 
)
static
static MFrequency casacore::MFrequency::fromDoppler ( const Measure dop,
const MVFrequency rest,
MFrequency::Types  type 
)
static

For internal use only.

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

Get frequency in specified units.

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

Get the default reference type.

Implements casacore::Measure.

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

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

Implements casacore::Measure.

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

Translate string to reference code.

Referenced by casa::ScantableFrequenciesIterator::getEntry(), and casa::PlotMSTransformations::setFrame().

Bool casacore::MFrequency::giveMe ( MFrequency::Ref mr,
const String in 
)
static uInt casacore::MFrequency::myType ( )
static

Get my type (as Register)

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

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

Implements casacore::Measure.

virtual Bool casacore::MFrequency::setRefString ( const String in)
virtual

Set the reference type to the specified String.

False if illegal string, reference set to DEFAULT.

Implements casacore::Measure.

static const String& casacore::MFrequency::showMe ( )
static
static const String& casacore::MFrequency::showType ( MFrequency::Types  tp)
static
static const String& casacore::MFrequency::showType ( uInt  tp)
static
virtual const String& casacore::MFrequency::tellMe ( ) const
virtual

Tell me your type.

Implements casacore::Measure.

MDoppler casacore::MFrequency::toDoppler ( const MVFrequency rest)

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

MDoppler casacore::MFrequency::toDoppler ( const MVFrequency rest) const
static MDoppler casacore::MFrequency::toDoppler ( const Measure in,
const MVFrequency rest 
)
static

Local use only.

MFrequency casacore::MFrequency::toRest ( const MDoppler dop) const

Make a rest frequency using a Doppler velocity.

static MFrequency casacore::MFrequency::toRest ( const Measure in,
const Measure dop 
)
static

For local use only.

virtual uInt casacore::MFrequency::type ( ) const
virtual

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

Implements casacore::Measure.

static MFrequency::Types casacore::MFrequency::typeFromString ( const String in)
static

Throws an exception if the type string is not recognized.

Friends And Related Function Documentation

friend class MeasConvert< MFrequency >
friend

Conversion of data.

Definition at line 166 of file MFrequency.h.


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