casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Member Functions | Private Attributes
GBTLO1File Class Reference

Digests the LO1 FITS file. More...

#include <GBTLO1File.h>

Inheritance diagram for GBTLO1File:
GBTFITSBase

List of all members.

Public Member Functions

 GBTLO1File ()
 This constructs a GBTLO1File that has no primary keywords.
virtual ~GBTLO1File ()
virtual Bool attach (const String &fitsFile)
 attach this object to a new FITS file.
virtual Bool isAttached () const
 Is this object attached to a FITS file.
virtual const Stringfile () const
 The name of the attached FITS file.
const MPosition & position () const
 The position of the antenna.
const MVFrequency & restfrq () const
 The requested rest frequency.
const Double reqdptol () const
 The requested doppler tolerance in Hz.
const MDirection & dir (const MVEpoch &time) const
 Get values from the LO1TABLE at the specified time (UTC) - or the first row before that time if there is not a row near that time.
const MVFrequency & lo1freq (const MVEpoch &time, uInt state) const
 lo1freq, this also requires a state.
const Double vframe (const MVEpoch &time) const
 radial velocity of the reference frame wrt the observer
const Double rvsys (const MVEpoch &time) const
 radial velociy of the source wrt the observer
const Table & souvel () const
 the SOUVEL binary table
const GBTStateTablestate () const
 the STATE table used here
const ROScalarColumn< Double > & dmjd () const
 The DMJD column.
Bool isFreqSwitched () const
 Are there non-zero offsets (implies frequency switching)
Vector< Double > firstLO1 (Double &factor, MFrequency::Types &refframe, MDoppler::Types &doptype, Double &vsource) const
 Return the first LO1 setting found here plus any state offset from STATE table, one value per state.

Private Member Functions

void init ()
 initialize with default, unattached values
void setLO1Table (FITSTable &lo1Tab)
 these functions do the appropriate thing, but do not verify that FITSTable is set to the appropriate extension.
void setLO1State (FITSTable &stateTab)
void setSouvel (FITSTable &souvelTab)
void lo1Row (const MVEpoch &time) const
 sets itslo1Row to the appropriate row in the lo1 table where the DMJD value is near or just prior to the requested time.
 GBTLO1File (const GBTLO1File &other)
 undefined and unavailable
GBTLO1Fileoperator= (const GBTLO1File &other)

Private Attributes

Bool itsAttached
String itsName
MPosition itsPosition
MVFrequency itsRestfrq
Double itsReqdptol
Vector< Double > itsFreqoff
MDirection itsCurrentDir
MVEpoch itsCurrentTime
Int itslo1Row
MVFrequency itsLo1freq
ROScalarColumn< Double > itsDMJDCol
ROScalarColumn< Double > itsRACol
ROScalarColumn< Double > itsDECCol
ROScalarColumn< Double > itsLO1FREQCol
ROScalarColumn< Double > itsVFRAMECol
ROScalarColumn< Double > itsRVSYSCol
Double itsEquinox
MDirection::Types itsDirType
Table * itsSouvel
Table * itsLO1Table
GBTStateTable itsState

Detailed Description

Digests the LO1 FITS file.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Etymology

Synopsis

Example

Motivation

Thrown Exceptions

Definition at line 89 of file GBTLO1File.h.


Constructor & Destructor Documentation

This constructs a GBTLO1File that has no primary keywords.

or associated tables

virtual GBTLO1File::~GBTLO1File ( ) [virtual]
GBTLO1File::GBTLO1File ( const GBTLO1File other) [private]

undefined and unavailable


Member Function Documentation

virtual Bool GBTLO1File::attach ( const String fitsFile) [virtual]

attach this object to a new FITS file.

If there are problems with the file, the return value is False and appropriate warnings are sent to the logger. The resulting object is not attached to any file.

Implements GBTFITSBase.

const MDirection& GBTLO1File::dir ( const MVEpoch &  time) const

Get values from the LO1TABLE at the specified time (UTC) - or the first row before that time if there is not a row near that time.

Telescope pointing direction.

const ROScalarColumn<Double>& GBTLO1File::dmjd ( ) const [inline]

The DMJD column.

Definition at line 142 of file GBTLO1File.h.

References itsDMJDCol.

virtual const String& GBTLO1File::file ( ) const [inline, virtual]

The name of the attached FITS file.

Returns an empty string if it is not attached.

Implements GBTFITSBase.

Definition at line 109 of file GBTLO1File.h.

References itsName.

Vector<Double> GBTLO1File::firstLO1 ( Double &  factor,
MFrequency::Types &  refframe,
MDoppler::Types &  doptype,
Double &  vsource 
) const

Return the first LO1 setting found here plus any state offset from STATE table, one value per state.

Also set is the factor which, when multiplied by the TOPO centric frequencies gives the reference frame frequencies corresponding to the the VELOCITY at the same time as the returned LO1 setting. The desired reference frame, velocity definition, and source velocity in the reference frame and definition are set.

void GBTLO1File::init ( ) [private]

initialize with default, unattached values

Reimplemented from GBTFITSBase.

virtual Bool GBTLO1File::isAttached ( ) const [inline, virtual]

Is this object attached to a FITS file.

This base class is never attached to a file.

Reimplemented from GBTFITSBase.

Definition at line 105 of file GBTLO1File.h.

References itsAttached.

Are there non-zero offsets (implies frequency switching)

const MVFrequency& GBTLO1File::lo1freq ( const MVEpoch &  time,
uInt  state 
) const

lo1freq, this also requires a state.

The appropriate offset for that state is from the LO1STATE table and is added to the frequency from the LO1TABLE. If that state isn't found, an offset of 0.0 is used.

void GBTLO1File::lo1Row ( const MVEpoch &  time) const [private]

sets itslo1Row to the appropriate row in the lo1 table where the DMJD value is near or just prior to the requested time.

GBTLO1File& GBTLO1File::operator= ( const GBTLO1File other) [private]
const MPosition& GBTLO1File::position ( ) const [inline]

The position of the antenna.

Definition at line 112 of file GBTLO1File.h.

References itsPosition.

const Double GBTLO1File::reqdptol ( ) const [inline]

The requested doppler tolerance in Hz.

Definition at line 118 of file GBTLO1File.h.

References itsReqdptol.

const MVFrequency& GBTLO1File::restfrq ( ) const [inline]

The requested rest frequency.

Definition at line 115 of file GBTLO1File.h.

References itsRestfrq.

const Double GBTLO1File::rvsys ( const MVEpoch &  time) const

radial velociy of the source wrt the observer

void GBTLO1File::setLO1State ( FITSTable &  stateTab) [private]
void GBTLO1File::setLO1Table ( FITSTable &  lo1Tab) [private]

these functions do the appropriate thing, but do not verify that FITSTable is set to the appropriate extension.

void GBTLO1File::setSouvel ( FITSTable &  souvelTab) [private]
const Table& GBTLO1File::souvel ( ) const [inline]

the SOUVEL binary table

Definition at line 136 of file GBTLO1File.h.

References itsSouvel.

const GBTStateTable& GBTLO1File::state ( ) const [inline]

the STATE table used here

Definition at line 139 of file GBTLO1File.h.

References itsState.

const Double GBTLO1File::vframe ( const MVEpoch &  time) const

radial velocity of the reference frame wrt the observer


Member Data Documentation

Bool GBTLO1File::itsAttached [private]

Definition at line 158 of file GBTLO1File.h.

Referenced by isAttached().

MDirection GBTLO1File::itsCurrentDir [mutable, private]

Definition at line 168 of file GBTLO1File.h.

MVEpoch GBTLO1File::itsCurrentTime [mutable, private]

Definition at line 169 of file GBTLO1File.h.

Definition at line 173 of file GBTLO1File.h.

MDirection::Types GBTLO1File::itsDirType [private]

Definition at line 177 of file GBTLO1File.h.

Definition at line 173 of file GBTLO1File.h.

Referenced by dmjd().

Double GBTLO1File::itsEquinox [private]

Definition at line 176 of file GBTLO1File.h.

Vector<Double> GBTLO1File::itsFreqoff [private]

Definition at line 166 of file GBTLO1File.h.

MVFrequency GBTLO1File::itsLo1freq [mutable, private]

Definition at line 171 of file GBTLO1File.h.

Definition at line 173 of file GBTLO1File.h.

Int GBTLO1File::itslo1Row [mutable, private]

Definition at line 170 of file GBTLO1File.h.

Table * GBTLO1File::itsLO1Table [private]

Definition at line 179 of file GBTLO1File.h.

Definition at line 159 of file GBTLO1File.h.

Referenced by file().

MPosition GBTLO1File::itsPosition [private]

Definition at line 161 of file GBTLO1File.h.

Referenced by position().

Definition at line 173 of file GBTLO1File.h.

Double GBTLO1File::itsReqdptol [private]

Definition at line 163 of file GBTLO1File.h.

Referenced by reqdptol().

MVFrequency GBTLO1File::itsRestfrq [private]

Definition at line 162 of file GBTLO1File.h.

Referenced by restfrq().

Definition at line 173 of file GBTLO1File.h.

Table* GBTLO1File::itsSouvel [private]

Definition at line 179 of file GBTLO1File.h.

Referenced by souvel().

Definition at line 180 of file GBTLO1File.h.

Referenced by state().

Definition at line 173 of file GBTLO1File.h.


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