casacore::ROMSFieldColumns Class Reference

A class to provide easy access to MSField columns. More...

#include <MSFieldColumns.h>

Inheritance diagram for casacore::ROMSFieldColumns:

Public Member Functions
	ROMSFieldColumns (const MSField &msField)
	Construct from the supplied Table.
	~ROMSFieldColumns ()
	The desctructor does nothing special.
const ROScalarColumn< String > &	code () const
	Read-only access to required columns.
const ROArrayColumn< Double > &	delayDir () const
const ROArrayMeasColumn < MDirection > &	delayDirMeasCol () const
const ROScalarColumn< Bool > &	flagRow () const
const ROScalarColumn< String > &	name () const
const ROScalarColumn< Int > &	numPoly () const
const ROArrayColumn< Double > &	phaseDir () const
const ROArrayMeasColumn < MDirection > &	phaseDirMeasCol () const
const ROArrayColumn< Double > &	referenceDir () const
const ROArrayMeasColumn < MDirection > &	referenceDirMeasCol () const
const ROScalarColumn< Int > &	sourceId () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn < Double > &	timeQuant () const
const ROScalarMeasColumn < MEpoch > &	timeMeas () const
const ROScalarColumn< Int > &	ephemerisId () const
	Read-only access to optional columns.
MDirection	delayDirMeas (Int row, Double time=0) const
	Access to interpolated directions from polynomials or ephemerides, the default time of zero will return the 0th order element of the polynomial.
MDirection	phaseDirMeas (Int row, Double time=0) const
MDirection	referenceDirMeas (Int row, Double time=0) const
MRadialVelocity	radVelMeas (Int row, Double time=0) const
Quantity	rho (Int row, Double time=0) const
Bool	needInterTime (Int row) const
String	ephemPath (Int row) const
uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns.
Int	matchDirection (const MDirection &referenceDirection, const MDirection &delayDirection, const MDirection &phaseDirection, const Quantum< Double > &maxSeparation, Int tryRow=-1, Double time=0)
	returns the last row that has a reference direction, phase direction and delay direction that match, to within the specified angular separation, the supplied values.
void	updateMeasComets ()
	Update the MeasComets objects belonging to this FIELD table.
Protected Member Functions
	ROMSFieldColumns ()
void	attach (const MSField &msField)
Int	measCometIndex (int row) const
MDirection	extractDirMeas (const MDirection &offsetDir, Int index, Double &interTime, MEpoch originEpoch) const
	Extract the direction Measure from the corresponding ephemeris using the nominal position as an offset.
void	getMJDs (Double &originMJD, Double &interMJD, const Double interTime, const MEpoch originEpoch) const
Protected Attributes
String	measCometsPath_p
Vector< MeasComet * >	measCometsV_p
SimpleOrderedMap< Int, Int >	ephIdToMeasComet_p
Private Member Functions
	ROMSFieldColumns (const ROMSFieldColumns &)
ROMSFieldColumns &	operator= (const ROMSFieldColumns &)
void	attachOptionalCols (const MSField &msField)
Bool	matchReferenceDir (uInt row, const MVDirection &dirVal, const Double &sepInRad, MVDirection &mvdir, Double time=0) const
Bool	matchDelayDir (uInt row, const MVDirection &dirVal, const Double &sepInRad, MVDirection &mvdir, Double time=0) const
Bool	matchPhaseDir (uInt row, const MVDirection &dirVal, const Double &sepInRad, MVDirection &mvdir, Double time=0) const
Private Attributes
ROScalarColumn< String >	name_p
ROScalarColumn< String >	code_p
ROScalarColumn< Double >	time_p
ROScalarColumn< Int >	numPoly_p
ROArrayColumn< Double >	delayDir_p
ROArrayColumn< Double >	phaseDir_p
ROArrayColumn< Double >	referenceDir_p
ROScalarColumn< Int >	sourceId_p
ROScalarColumn< Bool >	flagRow_p
ROScalarColumn< Int >	ephemerisId_p
ROScalarMeasColumn< MEpoch >	timeMeas_p
ROArrayMeasColumn< MDirection >	delayDirMeas_p
ROArrayMeasColumn< MDirection >	phaseDirMeas_p
ROArrayMeasColumn< MDirection >	referenceDirMeas_p
ROScalarQuantColumn< Double >	timeQuant_p

Detailed Description

A class to provide easy access to MSField columns.

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

ROMSFieldColumns stands for Read-Only MeasurementSet Field Table columns.

Synopsis

This class provides read-only access to the columns in the MSField 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 ROMSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 86 of file MSFieldColumns.h.

Constructor & Destructor Documentation

casacore::ROMSFieldColumns::ROMSFieldColumns ( const MSField & msField )

Construct from the supplied Table.

casacore::ROMSFieldColumns::~ROMSFieldColumns ( )

The desctructor does nothing special.

casacore::ROMSFieldColumns::ROMSFieldColumns ( ) [protected]

casacore::ROMSFieldColumns::ROMSFieldColumns ( const ROMSFieldColumns & ) [private]

Member Function Documentation

void casacore::ROMSFieldColumns::attach ( const MSField & msField ) [protected]

void casacore::ROMSFieldColumns::attachOptionalCols ( const MSField & msField ) [private]

const ROScalarColumn<String>& casacore::ROMSFieldColumns::code ( ) const [inline]

Read-only access to required columns.

Reimplemented in casacore::MSFieldColumns.

Definition at line 97 of file MSFieldColumns.h.

References code_p.

const ROArrayColumn<Double>& casacore::ROMSFieldColumns::delayDir ( ) const [inline]

Reimplemented in casacore::MSFieldColumns.

Definition at line 98 of file MSFieldColumns.h.

References delayDir_p.

MDirection casacore::ROMSFieldColumns::delayDirMeas	(	Int	row,
		Double	time = `0`
	)			const

Access to interpolated directions from polynomials or ephemerides, the default time of zero will return the 0th order element of the polynomial.

or, if there is an ephemeris, the position at the time origin of the ephemeris.

In addtion to the directions, if there is an ephemeris available, also the radial velocity and the distance rho can be accessed.

The method needInterTime returns True if there is a polynomial or ephemeris connected to this field table row, and an interpolation time value should be provided. The method ephemPath returns the absolute path to the ephemeris table connected to the field table row, an empty string if there is none.

const ROArrayMeasColumn<MDirection>& casacore::ROMSFieldColumns::delayDirMeasCol ( ) const [inline]

Reimplemented in casacore::MSFieldColumns.

Definition at line 99 of file MSFieldColumns.h.

References delayDirMeas_p.

const ROScalarColumn<Int>& casacore::ROMSFieldColumns::ephemerisId ( ) const [inline]

Read-only access to optional columns.

Reimplemented in casacore::MSFieldColumns.

Definition at line 118 of file MSFieldColumns.h.

References ephemerisId_p.

String casacore::ROMSFieldColumns::ephemPath ( Int row ) const

MDirection casacore::ROMSFieldColumns::extractDirMeas	(	const MDirection &	offsetDir,
		Int	index,
		Double &	interTime,
		MEpoch	originEpoch
	)			const `[protected]`

Extract the direction Measure from the corresponding ephemeris using the nominal position as an offset.

Note that interTime is assumed to use the same time reference frame as originEpoch.

const ROScalarColumn<Bool>& casacore::ROMSFieldColumns::flagRow ( ) const [inline]

Reimplemented in casacore::MSFieldColumns.

Definition at line 101 of file MSFieldColumns.h.

References flagRow_p.

void casacore::ROMSFieldColumns::getMJDs	(	Double &	originMJD,
		Double &	interMJD,
		const Double	interTime,
		const MEpoch	originEpoch
	)			const `[protected]`

Bool casacore::ROMSFieldColumns::matchDelayDir	(	uInt	row,
		const MVDirection &	dirVal,
		const Double &	sepInRad,
		MVDirection &	mvdir,
		Double	time = `0`
	)			const `[private]`

Int casacore::ROMSFieldColumns::matchDirection	(	const MDirection &	referenceDirection,
		const MDirection &	delayDirection,
		const MDirection &	phaseDirection,
		const Quantum< Double > &	maxSeparation,
		Int	tryRow = `-1`,
		Double	time = `0`
	)

returns the last row that has a reference direction, phase direction and delay direction that match, to within the specified angular separation, the supplied values.

Only matches on rows where the direction is constant ie., NUM_POLY is 0 and where FLAG_ROW is False. Throws an exception (AipsError) if the reference frames do not match or if the separation does not have angular units (when compiled in debug mode). Returns -1 if no match could be found. If tryRow is positive, then that row is tested to see if it matches before any others are tested. Setting tryRow to a positive value greater than the table length will throw an exception (AipsError), when compiled in debug mode.

Bool casacore::ROMSFieldColumns::matchPhaseDir	(	uInt	row,
		const MVDirection &	dirVal,
		const Double &	sepInRad,
		MVDirection &	mvdir,
		Double	time = `0`
	)			const `[private]`

Bool casacore::ROMSFieldColumns::matchReferenceDir	(	uInt	row,
		const MVDirection &	dirVal,
		const Double &	sepInRad,
		MVDirection &	mvdir,
		Double	time = `0`
	)			const `[private]`