casa::ROMSMainColumns Class Reference
[MeasurementSets]

#include <MSMainColumns.h>

Inheritance diagram for casa::ROMSMainColumns:

[legend]List of all members.

---

Detailed Description

A class for easy read-only access to MeasurementSet main table columns.

Intended use:

Part of API

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MeasurementSet
• ArrayColumn
• ScalarColumn

Etymology

ROMSColumns stands for Read-Only MeasurementSet Table columns.

Synopsis

This class provides read-only access to the columns in the MeasurementSet. 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. Warning: The Table that is used to construct this class must not be destroyed (or go out of scope) before this class does. Otherwise the scalar and array columns use by this class will be left dangling.

Example

    // use as follows
    MeasurementSet ms("myMS"); 
    ROMSColumns msc(ms);
    // show data from row 5
    cout << msc.data()(5);
    // show name of antenna on row 3 in antenna table
    cout << msc.antenna().name();

Motivation

See MSColumns for the motivation.

To Do

• We might decide to merge all the MSColumn classes with the corresponding MeasurementSet classes.

Definition at line 99 of file MSMainColumns.h.

Public Member Functions
	ROMSMainColumns (const MeasurementSet &ms)
	Create a columns object that accesses the data in the specified Table.
	~ROMSMainColumns ()
	The desctructor does nothing special.
uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns.
Vector< String >	flagCategories () const
	Returns the category labels for the FLAG_CATEGORY column.
const ROScalarColumn< Int > &	antenna1 () const
	Access to required columns.
const ROScalarColumn< Int > &	antenna2 () const
const ROScalarColumn< Int > &	arrayId () const
const ROScalarColumn< Int > &	dataDescId () const
const ROScalarColumn< Double > &	exposure () const
const ROScalarQuantColumn< Double > &	exposureQuant () const
const ROScalarColumn< Int > &	feed1 () const
const ROScalarColumn< Int > &	feed2 () const
const ROScalarColumn< Int > &	fieldId () const
const ROArrayColumn< Bool > &	flag () const
const ROArrayColumn< Bool > &	flagCategory () const
const ROScalarColumn< Bool > &	flagRow () const
const ROScalarColumn< Double > &	interval () const
const ROScalarQuantColumn< Double > &	intervalQuant () const
const ROScalarColumn< Int > &	observationId () const
const ROScalarColumn< Int > &	processorId () const
const ROScalarColumn< Int > &	scanNumber () const
const ROArrayColumn< Float > &	sigma () const
const ROScalarColumn< Int > &	stateId () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn< Double > &	timeQuant () const
const ROScalarMeasColumn< MEpoch > &	timeMeas () const
const ROScalarColumn< Double > &	timeCentroid () const
const ROScalarQuantColumn< Double > &	timeCentroidQuant () const
const ROScalarMeasColumn< MEpoch > &	timeCentroidMeas () const
const ROArrayColumn< Double > &	uvw () const
const ROArrayQuantColumn< Double > &	uvwQuant () const
const ROScalarMeasColumn< Muvw > &	uvwMeas () const
const ROArrayColumn< Float > &	weight () const
const ROScalarColumn< Int > &	antenna3 () const
	Access to optional columns.
const ROScalarColumn< Bool > &	baselineRef () const
const ROArrayColumn< Complex > &	correctedData () const
const ROArrayColumn< Complex > &	data () const
const ROScalarColumn< Int > &	feed3 () const
const ROArrayColumn< Float > &	floatData () const
const ROArrayColumn< Float > &	imagingWeight () const
const ROArrayColumn< Complex > &	lagData () const
const ROArrayColumn< Complex > &	modelData () const
const ROScalarColumn< Int > &	phaseId () const
const ROScalarColumn< Int > &	pulsarBin () const
const ROScalarColumn< Int > &	pulsarGateId () const
const ROArrayColumn< Float > &	sigmaSpectrum () const
const ROScalarColumn< Double > &	timeExtraPrec () const
const ROScalarQuantColumn< Double > &	timeExtraPrecQuant () const
const ROArrayColumn< Double > &	uvw2 () const
const ROScalarMeasColumn< Muvw > &	uvw2Meas () const
const ROArrayQuantColumn< Double > &	uvw2Quant () const
const ROArrayColumn< Complex > &	videoPoint () const
const ROArrayColumn< Float > &	weightSpectrum () const
Protected Member Functions
	ROMSMainColumns ()
void	attach (const MeasurementSet &ms)
Private Member Functions
	ROMSMainColumns (const ROMSMainColumns &)
ROMSMainColumns &	operator= (const ROMSMainColumns &)
void	attachOptionalCols (const MeasurementSet &ms)
Private Attributes
ROScalarColumn< Int >	antenna1_p
ROScalarColumn< Int >	antenna2_p
ROScalarColumn< Int >	arrayId_p
ROScalarColumn< Int >	dataDescId_p
ROScalarColumn< Double >	exposure_p
ROScalarColumn< Int >	feed1_p
ROScalarColumn< Int >	feed2_p
ROScalarColumn< Int >	fieldId_p
ROArrayColumn< Bool >	flag_p
ROArrayColumn< Bool >	flagCategory_p
ROScalarColumn< Bool >	flagRow_p
ROScalarColumn< Double >	interval_p
ROScalarColumn< Int >	observationId_p
ROScalarColumn< Int >	processorId_p
ROScalarColumn< Int >	scanNumber_p
ROArrayColumn< Float >	sigma_p
ROScalarColumn< Int >	stateId_p
ROScalarColumn< Double >	time_p
ROScalarColumn< Double >	timeCentroid_p
ROArrayColumn< Double >	uvw_p
ROArrayColumn< Float >	weight_p
ROScalarColumn< Int >	antenna3_p
ROScalarColumn< Bool >	baselineRef_p
ROArrayColumn< Complex >	data_p
ROScalarColumn< Int >	feed3_p
ROArrayColumn< Float >	floatData_p
ROArrayColumn< Complex >	lagData_p
ROScalarColumn< Int >	phaseId_p
ROScalarColumn< Int >	pulsarBin_p
ROScalarColumn< Int >	pulsarGateId_p
ROArrayColumn< Float >	sigmaSpectrum_p
ROScalarColumn< Double >	timeExtraPrec_p
ROArrayColumn< Double >	uvw2_p
ROArrayColumn< Complex >	videoPoint_p
ROArrayColumn< Float >	weightSpectrum_p
ROArrayColumn< Complex >	correctedData_p
ROArrayColumn< Float >	imagingWeight_p
ROArrayColumn< Complex >	modelData_p
ROScalarMeasColumn< MEpoch >	timeMeas_p
ROScalarMeasColumn< MEpoch >	timeCentroidMeas_p
ROScalarMeasColumn< Muvw >	uvwMeas_p
ROScalarMeasColumn< Muvw >	uvw2Meas_p
ROScalarQuantColumn< Double >	exposureQuant_p
ROScalarQuantColumn< Double >	intervalQuant_p
ROScalarQuantColumn< Double >	timeQuant_p
ROScalarQuantColumn< Double >	timeCentroidQuant_p
ROArrayQuantColumn< Double >	uvwQuant_p
ROScalarQuantColumn< Double >	timeExtraPrecQuant_p
ROArrayQuantColumn< Double >	uvw2Quant_p

---

Constructor & Destructor Documentation

casa::ROMSMainColumns::ROMSMainColumns

(

const MeasurementSet &

ms

)

Create a columns object that accesses the data in the specified Table.

casa::ROMSMainColumns::~ROMSMainColumns

(

)

The desctructor does nothing special.

casa::ROMSMainColumns::ROMSMainColumns

(

)

[protected]

casa::ROMSMainColumns::ROMSMainColumns

(

const ROMSMainColumns &

)

[private]

---

Member Function Documentation

const ROScalarColumn<Int>& casa::ROMSMainColumns::antenna1

(

)

const [inline]

Access to required columns.

Definition at line 110 of file MSMainColumns.h.

References antenna1_p.

Referenced by casa::MSMainColumns::antenna1().

const ROScalarColumn<Int>& casa::ROMSMainColumns::antenna2

(

)

const [inline]

Definition at line 111 of file MSMainColumns.h.

References antenna2_p.

Referenced by casa::MSMainColumns::antenna2().

const ROScalarColumn<Int>& casa::ROMSMainColumns::arrayId

(

)

const [inline]

Definition at line 112 of file MSMainColumns.h.

References arrayId_p.

Referenced by casa::MSMainColumns::arrayId().

const ROScalarColumn<Int>& casa::ROMSMainColumns::dataDescId

(

)

const [inline]

Definition at line 113 of file MSMainColumns.h.

References dataDescId_p.

Referenced by casa::MSMainColumns::dataDescId().

const ROScalarColumn<Double>& casa::ROMSMainColumns::exposure

(

)

const [inline]

Definition at line 114 of file MSMainColumns.h.

References exposure_p.

Referenced by casa::MSMainColumns::exposure().

const ROScalarQuantColumn<Double>& casa::ROMSMainColumns::exposureQuant

(

)

const [inline]

Definition at line 115 of file MSMainColumns.h.

References exposureQuant_p.

Referenced by casa::MSMainColumns::exposureQuant().

const ROScalarColumn<Int>& casa::ROMSMainColumns::feed1

(

)

const [inline]

Definition at line 117 of file MSMainColumns.h.

References feed1_p.

Referenced by casa::MSMainColumns::feed1().

const ROScalarColumn<Int>& casa::ROMSMainColumns::feed2

(

)

const [inline]

Definition at line 118 of file MSMainColumns.h.

References feed2_p.

Referenced by casa::MSMainColumns::feed2().

const ROScalarColumn<Int>& casa::ROMSMainColumns::fieldId

(

)

const [inline]

Definition at line 119 of file MSMainColumns.h.

References fieldId_p.

Referenced by casa::MSMainColumns::fieldId(), casa::MSPlotConvertAzimuth::MSPlotConvertAzimuth(), casa::MSPlotConvertChanToVelocity::MSPlotConvertChanToVelocity(), casa::MSPlotConvertElevation::MSPlotConvertElevation(), casa::MSPlotConvertHourangle::MSPlotConvertHourangle(), and casa::MSPlotConvertParallacticangle::MSPlotConvertParallacticangle().

const ROArrayColumn<Bool>& casa::ROMSMainColumns::flag

(

)

const [inline]

Definition at line 120 of file MSMainColumns.h.

References flag_p.

Referenced by casa::MSMainColumns::flag().

const ROArrayColumn<Bool>& casa::ROMSMainColumns::flagCategory

(

)

const [inline]

Definition at line 121 of file MSMainColumns.h.

References flagCategory_p.

Referenced by casa::MSMainColumns::flagCategory().

const ROScalarColumn<Bool>& casa::ROMSMainColumns::flagRow

(

)

const [inline]

Definition at line 122 of file MSMainColumns.h.

References flagRow_p.

Referenced by casa::MSMainColumns::flagRow().

const ROScalarColumn<Double>& casa::ROMSMainColumns::interval

(

)

const [inline]

Definition at line 123 of file MSMainColumns.h.

References interval_p.

Referenced by casa::MSMainColumns::interval().

const ROScalarQuantColumn<Double>& casa::ROMSMainColumns::intervalQuant

(

)

const [inline]

Definition at line 124 of file MSMainColumns.h.

References intervalQuant_p.

Referenced by casa::MSMainColumns::intervalQuant().

const ROScalarColumn<Int>& casa::ROMSMainColumns::observationId

(

)

const [inline]

Definition at line 126 of file MSMainColumns.h.

References observationId_p.

Referenced by casa::MSMainColumns::observationId().

const ROScalarColumn<Int>& casa::ROMSMainColumns::processorId

(

)

const [inline]

Definition at line 127 of file MSMainColumns.h.

References processorId_p.

Referenced by casa::MSMainColumns::processorId().

const ROScalarColumn<Int>& casa::ROMSMainColumns::scanNumber

(

)

const [inline]

Definition at line 128 of file MSMainColumns.h.

References scanNumber_p.

Referenced by casa::MSMainColumns::scanNumber().

const ROArrayColumn<Float>& casa::ROMSMainColumns::sigma

(

)

const [inline]

Definition at line 129 of file MSMainColumns.h.

References sigma_p.

Referenced by casa::MSMainColumns::sigma().

const ROScalarColumn<Int>& casa::ROMSMainColumns::stateId

(

)

const [inline]

Definition at line 130 of file MSMainColumns.h.

References stateId_p.

Referenced by casa::MSMainColumns::stateId().

const ROScalarColumn<Double>& casa::ROMSMainColumns::time

(

)

const [inline]

Definition at line 131 of file MSMainColumns.h.

References time_p.

const ROScalarQuantColumn<Double>& casa::ROMSMainColumns::timeQuant

(

)

const [inline]

Definition at line 132 of file MSMainColumns.h.

References timeQuant_p.

Referenced by casa::MSMainColumns::timeQuant().

const ROScalarMeasColumn<MEpoch>& casa::ROMSMainColumns::timeMeas

(

)

const [inline]

Definition at line 134 of file MSMainColumns.h.

References timeMeas_p.

Referenced by casa::MSMainColumns::timeMeas().

const ROScalarColumn<Double>& casa::ROMSMainColumns::timeCentroid

(

)

const [inline]

Definition at line 136 of file MSMainColumns.h.

References timeCentroid_p.

Referenced by casa::MSMainColumns::timeCentroid().

const ROScalarQuantColumn<Double>& casa::ROMSMainColumns::timeCentroidQuant

(

)

const [inline]

Definition at line 137 of file MSMainColumns.h.

References timeCentroidQuant_p.

Referenced by casa::MSMainColumns::timeCentroidQuant().

const ROScalarMeasColumn<MEpoch>& casa::ROMSMainColumns::timeCentroidMeas

(

)

const [inline]

Definition at line 139 of file MSMainColumns.h.

References timeCentroidMeas_p.

Referenced by casa::MSMainColumns::timeCentroidMeas().

const ROArrayColumn<Double>& casa::ROMSMainColumns::uvw

(

)

const [inline]

Definition at line 141 of file MSMainColumns.h.

References uvw_p.

Referenced by casa::MSMainColumns::uvw().

const ROArrayQuantColumn<Double>& casa::ROMSMainColumns::uvwQuant

(

)

const [inline]

Definition at line 142 of file MSMainColumns.h.

References uvwQuant_p.

Referenced by casa::MSMainColumns::uvwQuant().

const ROScalarMeasColumn<Muvw>& casa::ROMSMainColumns::uvwMeas

(

)

const [inline]

Definition at line 144 of file MSMainColumns.h.

References uvwMeas_p.

Referenced by casa::MSMainColumns::uvwMeas().

const ROArrayColumn<Float>& casa::ROMSMainColumns::weight

(

)

const [inline]

Definition at line 146 of file MSMainColumns.h.

References weight_p.

Referenced by casa::MSMainColumns::weight().

const ROScalarColumn<Int>& casa::ROMSMainColumns::antenna3

(

)

const [inline]

Access to optional columns.

Definition at line 151 of file MSMainColumns.h.

References antenna3_p.

Referenced by casa::MSMainColumns::antenna3().

const ROScalarColumn<Bool>& casa::ROMSMainColumns::baselineRef

(

)

const [inline]

Definition at line 152 of file MSMainColumns.h.

References baselineRef_p.

Referenced by casa::MSMainColumns::baselineRef().

const ROArrayColumn<Complex>& casa::ROMSMainColumns::correctedData

(

)

const [inline]

Definition at line 153 of file MSMainColumns.h.

References correctedData_p.

Referenced by casa::MSMainColumns::correctedData().

const ROArrayColumn<Complex>& casa::ROMSMainColumns::data

(

)

const [inline]

Definition at line 154 of file MSMainColumns.h.

References data_p.

Referenced by casa::MSMainColumns::data().

const ROScalarColumn<Int>& casa::ROMSMainColumns::feed3

(

)

const [inline]

Definition at line 155 of file MSMainColumns.h.

References feed3_p.

Referenced by casa::MSMainColumns::feed3().

const ROArrayColumn<Float>& casa::ROMSMainColumns::floatData

(

)

const [inline]

Definition at line 156 of file MSMainColumns.h.

References floatData_p.

Referenced by casa::MSMainColumns::floatData().

const ROArrayColumn<Float>& casa::ROMSMainColumns::imagingWeight

(

)

const [inline]

Definition at line 157 of file MSMainColumns.h.

References imagingWeight_p.

Referenced by casa::MSMainColumns::imagingWeight().

const ROArrayColumn<Complex>& casa::ROMSMainColumns::lagData

(

)

const [inline]

Definition at line 158 of file MSMainColumns.h.

References lagData_p.

Referenced by casa::MSMainColumns::lagData().

const ROArrayColumn<Complex>& casa::ROMSMainColumns::modelData

(

)

const [inline]

Definition at line 159 of file MSMainColumns.h.

References modelData_p.

Referenced by casa::MSMainColumns::modelData().

const ROScalarColumn<Int>& casa::ROMSMainColumns::phaseId

(

)

const [inline]

Definition at line 160 of file MSMainColumns.h.

References phaseId_p.

Referenced by casa::MSMainColumns::phaseId().

const ROScalarColumn<Int>& casa::ROMSMainColumns::pulsarBin

(

)

const [inline]

Definition at line 161 of file MSMainColumns.h.

References pulsarBin_p.

Referenced by casa::MSMainColumns::pulsarBin().

const ROScalarColumn<Int>& casa::ROMSMainColumns::pulsarGateId

(

)

const [inline]

Definition at line 162 of file MSMainColumns.h.

References pulsarGateId_p.

Referenced by casa::MSMainColumns::pulsarGateId().

const ROArrayColumn<Float>& casa::ROMSMainColumns::sigmaSpectrum

(

)

const [inline]

Definition at line 163 of file MSMainColumns.h.

References sigmaSpectrum_p.

Referenced by casa::MSMainColumns::sigmaSpectrum().

const ROScalarColumn<Double>& casa::ROMSMainColumns::timeExtraPrec

(

)

const [inline]

Definition at line 164 of file MSMainColumns.h.

References timeExtraPrec_p.

Referenced by casa::MSMainColumns::timeExtraPrec().

const ROScalarQuantColumn<Double>& casa::ROMSMainColumns::timeExtraPrecQuant

(

)

const [inline]

Definition at line 165 of file MSMainColumns.h.

References timeExtraPrecQuant_p.

Referenced by casa::MSMainColumns::timeExtraPrecQuant().

const ROArrayColumn<Double>& casa::ROMSMainColumns::uvw2

(

)

const [inline]

Definition at line 167 of file MSMainColumns.h.

References uvw2_p.

Referenced by casa::MSMainColumns::uvw2().

const ROScalarMeasColumn<Muvw>& casa::ROMSMainColumns::uvw2Meas

(

)

const [inline]

Definition at line 168 of file MSMainColumns.h.

References uvw2Meas_p.

Referenced by casa::MSMainColumns::uvw2Meas().

const ROArrayQuantColumn<Double>& casa::ROMSMainColumns::uvw2Quant

(

)

const [inline]

Definition at line 170 of file MSMainColumns.h.

References uvw2Quant_p.

Referenced by casa::MSMainColumns::uvw2Quant().

const ROArrayColumn<Complex>& casa::ROMSMainColumns::videoPoint

(

)

const [inline]

Definition at line 172 of file MSMainColumns.h.

References videoPoint_p.

Referenced by casa::MSMainColumns::videoPoint().

const ROArrayColumn<Float>& casa::ROMSMainColumns::weightSpectrum

(

)

const [inline]

Definition at line 173 of file MSMainColumns.h.

References weightSpectrum_p.

Referenced by casa::MSMainColumns::weightSpectrum().

uInt casa::ROMSMainColumns::nrow

(

)

const [inline]

Convenience function that returns the number of rows in any of the columns.

Definition at line 177 of file MSMainColumns.h.

References antenna1_p.

Vector<String> casa::ROMSMainColumns::flagCategories

(

)

const

Returns the category labels for the FLAG_CATEGORY column.

void casa::ROMSMainColumns::attach

(

const MeasurementSet &

ms

)

[protected]

ROMSMainColumns& casa::ROMSMainColumns::operator=

(

const ROMSMainColumns &

)

[private]

void casa::ROMSMainColumns::attachOptionalCols

(

const MeasurementSet &

ms

)

[private]

---

Member Data Documentation

ROScalarColumn<Int> casa::ROMSMainColumns::antenna1_p [private]

Definition at line 200 of file MSMainColumns.h.

Referenced by antenna1(), and nrow().

ROScalarColumn<Int> casa::ROMSMainColumns::antenna2_p [private]

Definition at line 201 of file MSMainColumns.h.

Referenced by antenna2().

ROScalarColumn<Int> casa::ROMSMainColumns::arrayId_p [private]

Definition at line 202 of file MSMainColumns.h.

Referenced by arrayId().

ROScalarColumn<Int> casa::ROMSMainColumns::dataDescId_p [private]

Definition at line 203 of file MSMainColumns.h.

Referenced by dataDescId().

ROScalarColumn<Double> casa::ROMSMainColumns::exposure_p [private]

Definition at line 204 of file MSMainColumns.h.

Referenced by exposure().

ROScalarColumn<Int> casa::ROMSMainColumns::feed1_p [private]

Definition at line 205 of file MSMainColumns.h.

Referenced by feed1().

ROScalarColumn<Int> casa::ROMSMainColumns::feed2_p [private]

Definition at line 206 of file MSMainColumns.h.

Referenced by feed2().

ROScalarColumn<Int> casa::ROMSMainColumns::fieldId_p [private]

Definition at line 207 of file MSMainColumns.h.

Referenced by fieldId().

ROArrayColumn<Bool> casa::ROMSMainColumns::flag_p [private]

Definition at line 208 of file MSMainColumns.h.

Referenced by flag().

ROArrayColumn<Bool> casa::ROMSMainColumns::flagCategory_p [private]

Definition at line 209 of file MSMainColumns.h.

Referenced by flagCategory().

ROScalarColumn<Bool> casa::ROMSMainColumns::flagRow_p [private]

Definition at line 210 of file MSMainColumns.h.

Referenced by flagRow().

ROScalarColumn<Double> casa::ROMSMainColumns::interval_p [private]

Definition at line 211 of file MSMainColumns.h.

Referenced by interval().

ROScalarColumn<Int> casa::ROMSMainColumns::observationId_p [private]

Definition at line 212 of file MSMainColumns.h.

Referenced by observationId().

ROScalarColumn<Int> casa::ROMSMainColumns::processorId_p [private]

Definition at line 213 of file MSMainColumns.h.

Referenced by processorId().

ROScalarColumn<Int> casa::ROMSMainColumns::scanNumber_p [private]

Definition at line 214 of file MSMainColumns.h.

Referenced by scanNumber().

ROArrayColumn<Float> casa::ROMSMainColumns::sigma_p [private]

Definition at line 215 of file MSMainColumns.h.

Referenced by sigma().

ROScalarColumn<Int> casa::ROMSMainColumns::stateId_p [private]

Definition at line 216 of file MSMainColumns.h.

Referenced by stateId().

ROScalarColumn<Double> casa::ROMSMainColumns::time_p [private]

Definition at line 217 of file MSMainColumns.h.

Referenced by time().

ROScalarColumn<Double> casa::ROMSMainColumns::timeCentroid_p [private]

Definition at line 218 of file MSMainColumns.h.

Referenced by timeCentroid().

ROArrayColumn<Double> casa::ROMSMainColumns::uvw_p [private]

Definition at line 219 of file MSMainColumns.h.

Referenced by uvw().

ROArrayColumn<Float> casa::ROMSMainColumns::weight_p [private]

Definition at line 220 of file MSMainColumns.h.

Referenced by weight().