casa
$Rev:20696$
|
A class to provide easy access to MSField columns. More...
#include <MSFieldColumns.h>
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 |
A class to provide easy access to MSField columns.
Public interface
ROMSFieldColumns stands for Read-Only MeasurementSet Field Table columns.
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.
See MSColumns for the motivation.
Definition at line 86 of file MSFieldColumns.h.
casa::ROMSFieldColumns::ROMSFieldColumns | ( | const MSField & | msField | ) |
Construct from the supplied Table.
The desctructor does nothing special.
casa::ROMSFieldColumns::ROMSFieldColumns | ( | ) | [protected] |
casa::ROMSFieldColumns::ROMSFieldColumns | ( | const ROMSFieldColumns & | ) | [private] |
void casa::ROMSFieldColumns::attach | ( | const MSField & | msField | ) | [protected] |
void casa::ROMSFieldColumns::attachOptionalCols | ( | const MSField & | msField | ) | [private] |
const ROScalarColumn<String>& casa::ROMSFieldColumns::code | ( | ) | const [inline] |
Read-only access to required columns.
Reimplemented in casa::MSFieldColumns.
Definition at line 97 of file MSFieldColumns.h.
References code_p.
const ROArrayColumn<Double>& casa::ROMSFieldColumns::delayDir | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 98 of file MSFieldColumns.h.
References delayDir_p.
MDirection casa::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>& casa::ROMSFieldColumns::delayDirMeasCol | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 99 of file MSFieldColumns.h.
References delayDirMeas_p.
const ROScalarColumn<Int>& casa::ROMSFieldColumns::ephemerisId | ( | ) | const [inline] |
Read-only access to optional columns.
Reimplemented in casa::MSFieldColumns.
Definition at line 118 of file MSFieldColumns.h.
References ephemerisId_p.
String casa::ROMSFieldColumns::ephemPath | ( | Int | row | ) | const |
MDirection casa::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>& casa::ROMSFieldColumns::flagRow | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 101 of file MSFieldColumns.h.
References flagRow_p.
void casa::ROMSFieldColumns::getMJDs | ( | Double & | originMJD, |
Double & | interMJD, | ||
const Double | interTime, | ||
const MEpoch | originEpoch | ||
) | const [protected] |
Bool casa::ROMSFieldColumns::matchDelayDir | ( | uInt | row, |
const MVDirection & | dirVal, | ||
const Double & | sepInRad, | ||
MVDirection & | mvdir, | ||
Double | time = 0 |
||
) | const [private] |
Int casa::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 casa::ROMSFieldColumns::matchPhaseDir | ( | uInt | row, |
const MVDirection & | dirVal, | ||
const Double & | sepInRad, | ||
MVDirection & | mvdir, | ||
Double | time = 0 |
||
) | const [private] |
Bool casa::ROMSFieldColumns::matchReferenceDir | ( | uInt | row, |
const MVDirection & | dirVal, | ||
const Double & | sepInRad, | ||
MVDirection & | mvdir, | ||
Double | time = 0 |
||
) | const [private] |
Int casa::ROMSFieldColumns::measCometIndex | ( | int | row | ) | const [protected] |
const ROScalarColumn<String>& casa::ROMSFieldColumns::name | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 102 of file MSFieldColumns.h.
References name_p.
Bool casa::ROMSFieldColumns::needInterTime | ( | Int | row | ) | const |
uInt casa::ROMSFieldColumns::nrow | ( | ) | const [inline] |
Convenience function that returns the number of rows in any of the columns.
Definition at line 145 of file MSFieldColumns.h.
References name_p.
const ROScalarColumn<Int>& casa::ROMSFieldColumns::numPoly | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 103 of file MSFieldColumns.h.
References numPoly_p.
ROMSFieldColumns& casa::ROMSFieldColumns::operator= | ( | const ROMSFieldColumns & | ) | [private] |
const ROArrayColumn<Double>& casa::ROMSFieldColumns::phaseDir | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 104 of file MSFieldColumns.h.
References phaseDir_p.
MDirection casa::ROMSFieldColumns::phaseDirMeas | ( | Int | row, |
Double | time = 0 |
||
) | const |
const ROArrayMeasColumn<MDirection>& casa::ROMSFieldColumns::phaseDirMeasCol | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 105 of file MSFieldColumns.h.
References phaseDirMeas_p.
MRadialVelocity casa::ROMSFieldColumns::radVelMeas | ( | Int | row, |
Double | time = 0 |
||
) | const |
const ROArrayColumn<Double>& casa::ROMSFieldColumns::referenceDir | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 107 of file MSFieldColumns.h.
References referenceDir_p.
MDirection casa::ROMSFieldColumns::referenceDirMeas | ( | Int | row, |
Double | time = 0 |
||
) | const |
const ROArrayMeasColumn<MDirection>& casa::ROMSFieldColumns::referenceDirMeasCol | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 108 of file MSFieldColumns.h.
References referenceDirMeas_p.
Quantity casa::ROMSFieldColumns::rho | ( | Int | row, |
Double | time = 0 |
||
) | const |
const ROScalarColumn<Int>& casa::ROMSFieldColumns::sourceId | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 110 of file MSFieldColumns.h.
References sourceId_p.
const ROScalarColumn<Double>& casa::ROMSFieldColumns::time | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 111 of file MSFieldColumns.h.
References time_p.
const ROScalarMeasColumn<MEpoch>& casa::ROMSFieldColumns::timeMeas | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 113 of file MSFieldColumns.h.
References timeMeas_p.
const ROScalarQuantColumn<Double>& casa::ROMSFieldColumns::timeQuant | ( | ) | const [inline] |
Reimplemented in casa::MSFieldColumns.
Definition at line 112 of file MSFieldColumns.h.
References timeQuant_p.
Update the MeasComets objects belonging to this FIELD table.
Needed when the entries in the EPHEMERIS_ID column have changed.
ROScalarColumn<String> casa::ROMSFieldColumns::code_p [private] |
Reimplemented in casa::MSFieldColumns.
Definition at line 221 of file MSFieldColumns.h.
Referenced by code().
Reimplemented in casa::MSFieldColumns.
Definition at line 224 of file MSFieldColumns.h.
Referenced by delayDir().
Reimplemented in casa::MSFieldColumns.
Definition at line 234 of file MSFieldColumns.h.
Referenced by delayDirMeasCol().
Reimplemented in casa::MSFieldColumns.
Definition at line 230 of file MSFieldColumns.h.
Referenced by ephemerisId().
SimpleOrderedMap<Int, Int> casa::ROMSFieldColumns::ephIdToMeasComet_p [protected] |
Definition at line 180 of file MSFieldColumns.h.
ROScalarColumn<Bool> casa::ROMSFieldColumns::flagRow_p [private] |
Reimplemented in casa::MSFieldColumns.
Definition at line 228 of file MSFieldColumns.h.
Referenced by flagRow().
String casa::ROMSFieldColumns::measCometsPath_p [protected] |
Definition at line 178 of file MSFieldColumns.h.
Vector<MeasComet*> casa::ROMSFieldColumns::measCometsV_p [protected] |
Definition at line 179 of file MSFieldColumns.h.
ROScalarColumn<String> casa::ROMSFieldColumns::name_p [private] |
ROScalarColumn<Int> casa::ROMSFieldColumns::numPoly_p [private] |
Reimplemented in casa::MSFieldColumns.
Definition at line 223 of file MSFieldColumns.h.
Referenced by numPoly().
Reimplemented in casa::MSFieldColumns.
Definition at line 225 of file MSFieldColumns.h.
Referenced by phaseDir().
Reimplemented in casa::MSFieldColumns.
Definition at line 235 of file MSFieldColumns.h.
Referenced by phaseDirMeasCol().
Reimplemented in casa::MSFieldColumns.
Definition at line 226 of file MSFieldColumns.h.
Referenced by referenceDir().
Reimplemented in casa::MSFieldColumns.
Definition at line 236 of file MSFieldColumns.h.
Referenced by referenceDirMeasCol().
ROScalarColumn<Int> casa::ROMSFieldColumns::sourceId_p [private] |
Reimplemented in casa::MSFieldColumns.
Definition at line 227 of file MSFieldColumns.h.
Referenced by sourceId().
ROScalarColumn<Double> casa::ROMSFieldColumns::time_p [private] |
Reimplemented in casa::MSFieldColumns.
Definition at line 222 of file MSFieldColumns.h.
Referenced by time().
Reimplemented in casa::MSFieldColumns.
Definition at line 233 of file MSFieldColumns.h.
Referenced by timeMeas().
Reimplemented in casa::MSFieldColumns.
Definition at line 239 of file MSFieldColumns.h.
Referenced by timeQuant().