casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::MSDopplerUtil Class Reference

A utility class for MS Doppler tracking information. More...

#include <MSDopplerUtil.h>

Public Member Functions

 MSDopplerUtil (const MeasurementSet &ms)
 Construct from an existing MeasurementSet. More...
 
 ~MSDopplerUtil ()
 Null destructor. More...
 
Bool dopplerInfo (Vector< Double > &restFrequency, Int spwId, Int fieldId)
 Retrieve a list of all rest frequencies used for a given spectral window id and field id. More...
 

Private Member Functions

 MSDopplerUtil ()
 Prohibit null constructor, copy constructor and assignment for now. More...
 
MSDopplerUtiloperator= (const MSDopplerUtil &)
 
 MSDopplerUtil (const MSDopplerUtil &)
 

Private Attributes

MeasurementSet ms_p
 Underlying MeasurementSet. More...
 

Detailed Description

A utility class for MS Doppler tracking information.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

From "MeasurementSet", "Doppler" and "utility".

Synopsis

This class provides utilities for handling Doppler tracking information in a MeasurementSet.

Example

Motivation

Collect all utilities for handling MS Doppler tracking information.

Thrown Exceptions

To Do

Definition at line 75 of file MSDopplerUtil.h.

Constructor & Destructor Documentation

casacore::MSDopplerUtil::MSDopplerUtil ( const MeasurementSet ms)

Construct from an existing MeasurementSet.

casacore::MSDopplerUtil::~MSDopplerUtil ( )

Null destructor.

casacore::MSDopplerUtil::MSDopplerUtil ( )
private

Prohibit null constructor, copy constructor and assignment for now.

casacore::MSDopplerUtil::MSDopplerUtil ( const MSDopplerUtil )
private

Member Function Documentation

Bool casacore::MSDopplerUtil::dopplerInfo ( Vector< Double > &  restFrequency,
Int  spwId,
Int  fieldId 
)

Retrieve a list of all rest frequencies used for a given spectral window id and field id.

Note that the output vector combines information for multiple spectral lines and (unlikely) multiple source table entries. If the doppler sub table doesn't exist, the information is retrieved from directly from the source sub table.

MSDopplerUtil& casacore::MSDopplerUtil::operator= ( const MSDopplerUtil )
private

Member Data Documentation

MeasurementSet casacore::MSDopplerUtil::ms_p
private

Underlying MeasurementSet.

Definition at line 99 of file MSDopplerUtil.h.


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