casa::MSPointingColumns

casa::MSPointingColumns Class Reference
[MeasurementSets]

#include <MSPointingColumns.h>

Inheritance diagram for casa::MSPointingColumns:

Inheritance graph
[legend]
Collaboration diagram for casa::MSPointingColumns:

Collaboration graph
[legend]
List of all members.

Detailed Description

A class to provide easy read-write access to MSPointing columns.

Intended use:

Part of API

Review Status

Reviewed By:
Bob Garwood
Date Reviewed:
1997/02/01

Prerequisite

Etymology

MSPointingColumns stands for MeasurementSet Pointing Table columns.

Synopsis

This class provides access to the columns in the MSPointing Table, it does the declaration of all the Scalar and ArrayColumns with the correct types, so the application programmer doesn't have to worry about getting those right. There is an access function for every predefined column. Access to non-predefined columns will still have to be done with explicit declarations. See MSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 229 of file MSPointingColumns.h.

Public Member Functions

 MSPointingColumns (MSPointing &msPointing)
 Construct from the supplied Table.
 ~MSPointingColumns ()
 The destructor does nothing special.
void setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
 set the epoch reference type for the TIME & TIME_ORIGIN column.
void setDirectionRef (MDirection::Types ref)
 set the direction reference type for the DIRECTION, TARGET & and, if defined, the SOURCE_OFFSET & POINTING_OFFSET columns.
void setEncoderDirectionRef (MDirection::Types ref)
 set the irection reference type for the ENCODER column (if it is defined).
ScalarColumn< Int > & antennaId ()
 Read-write access to required columns.
ScalarColumn< Double > & time ()
ScalarMeasColumn< MEpoch > & timeMeas ()
ScalarQuantColumn< Double > & timeQuant ()
ScalarColumn< Double > & interval ()
ScalarQuantColumn< Double > & intervalQuant ()
ScalarColumn< String > & name ()
ScalarColumn< Int > & numPoly ()
ScalarColumn< Double > & timeOrigin ()
ScalarQuantColumn< Double > & timeOriginQuant ()
ScalarMeasColumn< MEpoch > & timeOriginMeas ()
ArrayColumn< Double > & direction ()
ArrayMeasColumn< MDirection > & directionMeasCol ()
ArrayColumn< Double > & target ()
ArrayMeasColumn< MDirection > & targetMeasCol ()
ScalarColumn< Bool > & tracking ()
ArrayColumn< Double > & pointingOffset ()
 Read-write access to optional columns.
ArrayMeasColumn< MDirection > & pointingOffsetMeasCol ()
ArrayColumn< Double > & sourceOffset ()
ArrayMeasColumn< MDirection > & sourceOffsetMeasCol ()
ArrayColumn< Double > & encoder ()
ScalarMeasColumn< MDirection > & encoderMeas ()
ScalarColumn< Int > & pointingModelId ()
ScalarColumn< Bool > & onSource ()
ScalarColumn< Bool > & overTheTop ()
const ROScalarColumn< Int > & antennaId () const
 Read-only access to required columns.
const ROScalarColumn< Double > & time () const
const ROScalarQuantColumn<
Double > & 		timeQuant () const
const ROScalarMeasColumn<
MEpoch > & 		timeMeas () const
const ROScalarColumn< Double > & interval () const
const ROScalarQuantColumn<
Double > & 		intervalQuant () const
const ROScalarColumn< String > & name () const
const ROScalarColumn< Int > & numPoly () const
const ROScalarColumn< Double > & timeOrigin () const
const ROScalarQuantColumn<
Double > & 		timeOriginQuant () const
const ROScalarMeasColumn<
MEpoch > & 		timeOriginMeas () const
const ROArrayColumn< Double > & direction () const
const ROArrayMeasColumn< MDirection > & directionMeasCol () const
const ROArrayColumn< Double > & target () const
const ROArrayMeasColumn< MDirection > & targetMeasCol () const
const ROScalarColumn< Bool > & tracking () const
const ROArrayColumn< Double > & pointingOffset () const
 Access to optional columns.
const ROArrayMeasColumn< MDirection > & pointingOffsetMeasCol () const
const ROArrayColumn< Double > & sourceOffset () const
const ROArrayMeasColumn< MDirection > & sourceOffsetMeasCol () const
const ROArrayColumn< Double > & encoder () const
const ROScalarMeasColumn<
MDirection > & 		encoderMeas () const
const ROScalarColumn< Int > & pointingModelId () const
const ROScalarColumn< Bool > & onSource () const
const ROScalarColumn< Bool > & overTheTop () const

Protected Member Functions

 MSPointingColumns ()
void attach (MSPointing &msPointing)

Private Member Functions

 MSPointingColumns (const MSPointingColumns &)
MSPointingColumns & operator= (const MSPointingColumns &)
void attachOptionalCols (MSPointing &msPointing)

Private Attributes

ScalarColumn< Int > antennaId_p
ArrayColumn< Double > direction_p
ScalarColumn< Double > interval_p
ScalarColumn< String > name_p
ScalarColumn< Int > numPoly_p
ArrayColumn< Double > target_p
ScalarColumn< Double > time_p
ScalarColumn< Double > timeOrigin_p
ScalarColumn< Bool > tracking_p
ArrayColumn< Double > encoder_p
ScalarColumn< Bool > onSource_p
ScalarColumn< Int > pointingModelId_p
ArrayColumn< Double > pointingOffset_p
ArrayColumn< Double > sourceOffset_p
ScalarColumn< Bool > overTheTop_p
ArrayMeasColumn< MDirection > directionMeas_p
ArrayMeasColumn< MDirection > targetMeas_p
ScalarMeasColumn< MEpoch > timeMeas_p
ScalarMeasColumn< MEpoch > timeOriginMeas_p
ScalarMeasColumn< MDirection > encoderMeas_p
ArrayMeasColumn< MDirection > pointingOffsetMeas_p
ArrayMeasColumn< MDirection > sourceOffsetMeas_p
ScalarQuantColumn< Double > intervalQuant_p
ScalarQuantColumn< Double > timeQuant_p
ScalarQuantColumn< Double > timeOriginQuant_p

Constructor & Destructor Documentation

casa::MSPointingColumns::MSPointingColumns ( MSPointing &  msPointing  ) 

Construct from the supplied Table.

casa::MSPointingColumns::~MSPointingColumns (  ) 

The destructor does nothing special.

casa::MSPointingColumns::MSPointingColumns (  )  [protected]

casa::MSPointingColumns::MSPointingColumns ( const MSPointingColumns &   )  [private]

Member Function Documentation

ScalarColumn<Int>& casa::MSPointingColumns::antennaId (  )  [inline]

Read-write access to required columns.

Note that the direction measures with a stored polynomial have Col() added to their name. They are better accessed via the functions that have the same name, without the Col suffix, that will do the interpolation for you. These functions are in the ROMSPointingColumns class.

Definition at line 245 of file MSPointingColumns.h.

References antennaId_p.

ScalarColumn<Double>& casa::MSPointingColumns::time (  )  [inline]

Definition at line 246 of file MSPointingColumns.h.

References time_p.

ScalarMeasColumn<MEpoch>& casa::MSPointingColumns::timeMeas (  )  [inline]

Definition at line 247 of file MSPointingColumns.h.

References timeMeas_p.

ScalarQuantColumn<Double>& casa::MSPointingColumns::timeQuant (  )  [inline]

Definition at line 248 of file MSPointingColumns.h.

References timeQuant_p.

ScalarColumn<Double>& casa::MSPointingColumns::interval (  )  [inline]

Definition at line 249 of file MSPointingColumns.h.

References interval_p.

ScalarQuantColumn<Double>& casa::MSPointingColumns::intervalQuant (  )  [inline]

Definition at line 250 of file MSPointingColumns.h.

References intervalQuant_p.

ScalarColumn<String>& casa::MSPointingColumns::name (  )  [inline]

Definition at line 251 of file MSPointingColumns.h.

References name_p.

ScalarColumn<Int>& casa::MSPointingColumns::numPoly (  )  [inline]

Definition at line 252 of file MSPointingColumns.h.

References numPoly_p.

ScalarColumn<Double>& casa::MSPointingColumns::timeOrigin (  )  [inline]

Definition at line 253 of file MSPointingColumns.h.

References timeOrigin_p.

ScalarQuantColumn<Double>& casa::MSPointingColumns::timeOriginQuant (  )  [inline]

Definition at line 254 of file MSPointingColumns.h.

References timeOriginQuant_p.

ScalarMeasColumn<MEpoch>& casa::MSPointingColumns::timeOriginMeas (  )  [inline]

Definition at line 255 of file MSPointingColumns.h.

References timeOriginMeas_p.

ArrayColumn<Double>& casa::MSPointingColumns::direction (  )  [inline]

Definition at line 256 of file MSPointingColumns.h.

References direction_p.

ArrayMeasColumn<MDirection>& casa::MSPointingColumns::directionMeasCol (  )  [inline]

Definition at line 257 of file MSPointingColumns.h.

References directionMeas_p.

ArrayColumn<Double>& casa::MSPointingColumns::target (  )  [inline]

Definition at line 258 of file MSPointingColumns.h.

References target_p.

ArrayMeasColumn<MDirection>& casa::MSPointingColumns::targetMeasCol (  )  [inline]

Definition at line 259 of file MSPointingColumns.h.

References targetMeas_p.

ScalarColumn<Bool>& casa::MSPointingColumns::tracking (  )  [inline]

Definition at line 260 of file MSPointingColumns.h.

References tracking_p.

ArrayColumn<Double>& casa::MSPointingColumns::pointingOffset (  )  [inline]

Read-write access to optional columns.

Note that the direction measures with a stored polynomial have Col() added to their name. They are better accessed via the functions that have the same name, without the Col suffix, that will do the interpolation for you. These functions are in the ROMSPointingColumns class.

Definition at line 270 of file MSPointingColumns.h.

References pointingOffset_p.

ArrayMeasColumn<MDirection>& casa::MSPointingColumns::pointingOffsetMeasCol (  )  [inline]

Definition at line 271 of file MSPointingColumns.h.

References pointingOffsetMeas_p.

ArrayColumn<Double>& casa::MSPointingColumns::sourceOffset (  )  [inline]

Definition at line 273 of file MSPointingColumns.h.

References sourceOffset_p.

ArrayMeasColumn<MDirection>& casa::MSPointingColumns::sourceOffsetMeasCol (  )  [inline]

Definition at line 274 of file MSPointingColumns.h.

References sourceOffsetMeas_p.

ArrayColumn<Double>& casa::MSPointingColumns::encoder (  )  [inline]

Definition at line 276 of file MSPointingColumns.h.

References encoder_p.

ScalarMeasColumn<MDirection>& casa::MSPointingColumns::encoderMeas (  )  [inline]

Definition at line 277 of file MSPointingColumns.h.

References encoderMeas_p.

ScalarColumn<Int>& casa::MSPointingColumns::pointingModelId (  )  [inline]

Definition at line 278 of file MSPointingColumns.h.

References pointingModelId_p.

ScalarColumn<Bool>& casa::MSPointingColumns::onSource (  )  [inline]

Definition at line 279 of file MSPointingColumns.h.

References onSource_p.

ScalarColumn<Bool>& casa::MSPointingColumns::overTheTop (  )  [inline]

Definition at line 280 of file MSPointingColumns.h.

References overTheTop_p.

const ROScalarColumn<Int>& casa::MSPointingColumns::antennaId (  )  const [inline]

Read-only access to required columns.

Reimplemented from casa::ROMSPointingColumns.

Definition at line 285 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::antennaId().

const ROScalarColumn<Double>& casa::MSPointingColumns::time (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 287 of file MSPointingColumns.h.

References casa::time().

const ROScalarQuantColumn<Double>& casa::MSPointingColumns::timeQuant (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 289 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::timeQuant().

const ROScalarMeasColumn<MEpoch>& casa::MSPointingColumns::timeMeas (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 291 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::timeMeas().

const ROScalarColumn<Double>& casa::MSPointingColumns::interval (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 293 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::interval().

const ROScalarQuantColumn<Double>& casa::MSPointingColumns::intervalQuant (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 295 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::intervalQuant().

const ROScalarColumn<String>& casa::MSPointingColumns::name (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 297 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::name().

const ROScalarColumn<Int>& casa::MSPointingColumns::numPoly (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 299 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::numPoly().

const ROScalarColumn<Double>& casa::MSPointingColumns::timeOrigin (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 301 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::timeOrigin().

const ROScalarQuantColumn<Double>& casa::MSPointingColumns::timeOriginQuant (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 303 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::timeOriginQuant().

const ROScalarMeasColumn<MEpoch>& casa::MSPointingColumns::timeOriginMeas (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 305 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::timeOriginMeas().

const ROArrayColumn<Double>& casa::MSPointingColumns::direction (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 307 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::direction().

const ROArrayMeasColumn<MDirection>& casa::MSPointingColumns::directionMeasCol (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 309 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::directionMeasCol().

const ROArrayColumn<Double>& casa::MSPointingColumns::target (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 311 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::target().

const ROArrayMeasColumn<MDirection>& casa::MSPointingColumns::targetMeasCol (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 313 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::targetMeasCol().

const ROScalarColumn<Bool>& casa::MSPointingColumns::tracking (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 315 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::tracking().

const ROArrayColumn<Double>& casa::MSPointingColumns::pointingOffset (  )  const [inline]

Access to optional columns.

Reimplemented from casa::ROMSPointingColumns.

Definition at line 321 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::pointingOffset().

const ROArrayMeasColumn<MDirection>& casa::MSPointingColumns::pointingOffsetMeasCol (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 323 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::pointingOffsetMeasCol().

const ROArrayColumn<Double>& casa::MSPointingColumns::sourceOffset (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 325 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::sourceOffset().

const ROArrayMeasColumn<MDirection>& casa::MSPointingColumns::sourceOffsetMeasCol (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 327 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::sourceOffsetMeasCol().

const ROArrayColumn<Double>& casa::MSPointingColumns::encoder (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 329 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::encoder().

const ROScalarMeasColumn<MDirection>& casa::MSPointingColumns::encoderMeas (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 331 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::encoderMeas().

const ROScalarColumn<Int>& casa::MSPointingColumns::pointingModelId (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 333 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::pointingModelId().

const ROScalarColumn<Bool>& casa::MSPointingColumns::onSource (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 335 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::onSource().

const ROScalarColumn<Bool>& casa::MSPointingColumns::overTheTop (  )  const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 337 of file MSPointingColumns.h.

References casa::ROMSPointingColumns::overTheTop().

void casa::MSPointingColumns::setEpochRef ( MEpoch::Types  ref,
Bool  tableMustBeEmpty = True 
)

set the epoch reference type for the TIME & TIME_ORIGIN column.

Tip: In principle this function can only be used if the table is empty, otherwise already written values may thereafter have an incorrect reference, offset, or unit. However, it is possible that part of the table gets written before these values are known. In that case the reference, offset, or units can be set by using a False tableMustBeEmpty argument.

void casa::MSPointingColumns::setDirectionRef ( MDirection::Types  ref  ) 

set the direction reference type for the DIRECTION, TARGET & and, if defined, the SOURCE_OFFSET & POINTING_OFFSET columns.

This can only be done when the table has no rows. Trying to do so at other times will throw an exception. Note the optional ENCODERE column must be done separately as the MSv2 definition allows this column to have a different frame.

void casa::MSPointingColumns::setEncoderDirectionRef ( MDirection::Types  ref  ) 

set the irection reference type for the ENCODER column (if it is defined).

This can only be done when the table has no rows. Trying to do so at other times will throw an exception.

void casa::MSPointingColumns::attach ( MSPointing &  msPointing  )  [protected]

MSPointingColumns& casa::MSPointingColumns::operator= ( const MSPointingColumns &   )  [private]

void casa::MSPointingColumns::attachOptionalCols ( MSPointing &  msPointing  )  [private]

Member Data Documentation

ScalarColumn<Int> casa::MSPointingColumns::antennaId_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 382 of file MSPointingColumns.h.

Referenced by antennaId().

ArrayColumn<Double> casa::MSPointingColumns::direction_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 383 of file MSPointingColumns.h.

Referenced by direction().

ScalarColumn<Double> casa::MSPointingColumns::interval_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 384 of file MSPointingColumns.h.

Referenced by interval().

ScalarColumn<String> casa::MSPointingColumns::name_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 385 of file MSPointingColumns.h.

Referenced by name().

ScalarColumn<Int> casa::MSPointingColumns::numPoly_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 386 of file MSPointingColumns.h.

Referenced by numPoly().

ArrayColumn<Double> casa::MSPointingColumns::target_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 387 of file MSPointingColumns.h.

Referenced by target().

ScalarColumn<Double> casa::MSPointingColumns::time_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 388 of file MSPointingColumns.h.

Referenced by time().

ScalarColumn<Double> casa::MSPointingColumns::timeOrigin_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 389 of file MSPointingColumns.h.

Referenced by timeOrigin().

ScalarColumn<Bool> casa::MSPointingColumns::tracking_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 390 of file MSPointingColumns.h.

Referenced by tracking().

ArrayColumn<Double> casa::MSPointingColumns::encoder_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 392 of file MSPointingColumns.h.

Referenced by encoder().

ScalarColumn<Bool> casa::MSPointingColumns::onSource_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 393 of file MSPointingColumns.h.

Referenced by onSource().

ScalarColumn<Int> casa::MSPointingColumns::pointingModelId_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 394 of file MSPointingColumns.h.

Referenced by pointingModelId().

ArrayColumn<Double> casa::MSPointingColumns::pointingOffset_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 395 of file MSPointingColumns.h.

Referenced by pointingOffset().

ArrayColumn<Double> casa::MSPointingColumns::sourceOffset_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 396 of file MSPointingColumns.h.

Referenced by sourceOffset().

ScalarColumn<Bool> casa::MSPointingColumns::overTheTop_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 397 of file MSPointingColumns.h.

Referenced by overTheTop().

ArrayMeasColumn<MDirection> casa::MSPointingColumns::directionMeas_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 400 of file MSPointingColumns.h.

Referenced by directionMeasCol().

ArrayMeasColumn<MDirection> casa::MSPointingColumns::targetMeas_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 401 of file MSPointingColumns.h.

Referenced by targetMeasCol().

ScalarMeasColumn<MEpoch> casa::MSPointingColumns::timeMeas_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 402 of file MSPointingColumns.h.

Referenced by timeMeas().

ScalarMeasColumn<MEpoch> casa::MSPointingColumns::timeOriginMeas_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 403 of file MSPointingColumns.h.

Referenced by timeOriginMeas().

ScalarMeasColumn<MDirection> casa::MSPointingColumns::encoderMeas_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 405 of file MSPointingColumns.h.

Referenced by encoderMeas().

ArrayMeasColumn<MDirection> casa::MSPointingColumns::pointingOffsetMeas_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 406 of file MSPointingColumns.h.

Referenced by pointingOffsetMeasCol().

ArrayMeasColumn<MDirection> casa::MSPointingColumns::sourceOffsetMeas_p [private]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 407 of file MSPointingColumns.h.

Referenced by sourceOffsetMeasCol().