casacore::ROMSColumns Class Reference

A class to provide easy read-only access to MeasurementSet columns. More...

#include <MSColumns.h>

Inheritance diagram for casacore::ROMSColumns:

Public Member Functions
	ROMSColumns (const MeasurementSet &ms)
	Create a columns object that accesses the data in the specified MS. More...
	~ROMSColumns ()
	The destructor does nothing special. More...
const ROMSAntennaColumns &	antenna () const
	Access to required subtables. More...
const ROMSDataDescColumns &	dataDescription () const
const ROMSFeedColumns &	feed () const
const ROMSFieldColumns &	field () const
const ROMSFlagCmdColumns &	flagCmd () const
const ROMSHistoryColumns &	history () const
const ROMSObservationColumns &	observation () const
const ROMSPointingColumns &	pointing () const
const ROMSPolarizationColumns &	polarization () const
const ROMSProcessorColumns &	processor () const
const ROMSSpWindowColumns &	spectralWindow () const
const ROMSStateColumns &	state () const
const ROMSDopplerColumns &	doppler () const
	Access to optional subtables. More...
const ROMSFreqOffsetColumns &	freqOffset () const
const ROMSSourceColumns &	source () const
const ROMSSysCalColumns &	sysCal () const
const ROMSWeatherColumns &	weather () const
Public Member Functions inherited from casacore::ROMSMainColumns
	ROMSMainColumns (const MeasurementSet &ms)
	Create a columns object that accesses the data in the specified Table. More...
	~ROMSMainColumns ()
	The desctructor does nothing special. More...
const ROScalarColumn< Int > &	antenna1 () const
	Access to required columns. More...
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. More...
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
const ROArrayColumn< Float > &	weightSpectrumCorrected () const
uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...
Vector< String >	flagCategories () const
	Returns the category labels for the FLAG_CATEGORY column. More...

Private Attributes
ROMSAntennaColumns	antenna_p
	Access to subtables. More...
ROMSDataDescColumns	dataDesc_p
ROMSDopplerColumns	doppler_p
ROMSFeedColumns	feed_p
ROMSFieldColumns	field_p
ROMSFlagCmdColumns	flagCmd_p
ROMSFreqOffsetColumns	freqOffset_p
ROMSHistoryColumns	history_p
ROMSObservationColumns	observation_p
ROMSPointingColumns	pointing_p
ROMSPolarizationColumns	polarization_p
ROMSProcessorColumns	processor_p
ROMSSourceColumns	source_p
ROMSSpWindowColumns	spectralWindow_p
ROMSStateColumns	state_p
ROMSSysCalColumns	sysCal_p
ROMSWeatherColumns	weather_p

Additional Inherited Members
Protected Member Functions inherited from casacore::ROMSMainColumns
	ROMSMainColumns ()
void	attach (const MeasurementSet &ms)

Detailed Description

A class to provide easy read-only access to MeasurementSet columns.

Intended use:

Public interface

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.

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 111 of file MSColumns.h.

Constructor & Destructor Documentation

casacore::ROMSColumns::ROMSColumns

(

const MeasurementSet &

ms

)

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

casacore::ROMSColumns::~ROMSColumns

(

)

The destructor does nothing special.

Member Function Documentation

const ROMSAntennaColumns& casacore::ROMSColumns::antenna ( void  ) const

inline

Access to required subtables.

Definition at line 122 of file MSColumns.h.

References antenna_p.

const ROMSDataDescColumns& casacore::ROMSColumns::dataDescription ( ) const

inline

Definition at line 123 of file MSColumns.h.

References dataDesc_p.

const ROMSDopplerColumns& casacore::ROMSColumns::doppler ( ) const

inline

Access to optional subtables.

Definition at line 140 of file MSColumns.h.

References doppler_p.

const ROMSFeedColumns& casacore::ROMSColumns::feed ( void  ) const

inline

Definition at line 124 of file MSColumns.h.

References feed_p.

const ROMSFieldColumns& casacore::ROMSColumns::field ( void  ) const

inline

Definition at line 125 of file MSColumns.h.

References field_p.

const ROMSFlagCmdColumns& casacore::ROMSColumns::flagCmd ( ) const

inline

Definition at line 126 of file MSColumns.h.

References flagCmd_p.

const ROMSFreqOffsetColumns& casacore::ROMSColumns::freqOffset ( ) const

inline

Definition at line 141 of file MSColumns.h.

References freqOffset_p.

const ROMSHistoryColumns& casacore::ROMSColumns::history ( ) const

inline

Definition at line 127 of file MSColumns.h.

References history_p.

const ROMSObservationColumns& casacore::ROMSColumns::observation ( ) const

inline

Definition at line 128 of file MSColumns.h.

References observation_p.

const ROMSPointingColumns& casacore::ROMSColumns::pointing ( ) const

inline

Definition at line 129 of file MSColumns.h.

References pointing_p.

const ROMSPolarizationColumns& casacore::ROMSColumns::polarization ( ) const

inline

Definition at line 130 of file MSColumns.h.

References polarization_p.

const ROMSProcessorColumns& casacore::ROMSColumns::processor ( ) const

inline

Definition at line 132 of file MSColumns.h.

References processor_p.

const ROMSSourceColumns& casacore::ROMSColumns::source ( ) const

inline

Definition at line 142 of file MSColumns.h.

References source_p.

const ROMSSpWindowColumns& casacore::ROMSColumns::spectralWindow ( ) const

inline

Definition at line 133 of file MSColumns.h.

References spectralWindow_p.

const ROMSStateColumns& casacore::ROMSColumns::state ( ) const

inline

Definition at line 135 of file MSColumns.h.

References state_p.

const ROMSSysCalColumns& casacore::ROMSColumns::sysCal ( ) const

inline

Definition at line 143 of file MSColumns.h.

References sysCal_p.

const ROMSWeatherColumns& casacore::ROMSColumns::weather ( ) const

inline

Definition at line 144 of file MSColumns.h.

References weather_p.

Member Data Documentation

ROMSAntennaColumns casacore::ROMSColumns::antenna_p

private

Access to subtables.

Definition at line 149 of file MSColumns.h.

Referenced by antenna().

ROMSDataDescColumns casacore::ROMSColumns::dataDesc_p

private

Definition at line 150 of file MSColumns.h.

Referenced by dataDescription().

ROMSDopplerColumns casacore::ROMSColumns::doppler_p

private

Definition at line 151 of file MSColumns.h.

Referenced by doppler().

ROMSFeedColumns casacore::ROMSColumns::feed_p

private

Definition at line 152 of file MSColumns.h.

Referenced by feed().

ROMSFieldColumns casacore::ROMSColumns::field_p

private

Definition at line 153 of file MSColumns.h.

Referenced by field().

ROMSFlagCmdColumns casacore::ROMSColumns::flagCmd_p

private

Definition at line 154 of file MSColumns.h.

Referenced by flagCmd().

ROMSFreqOffsetColumns casacore::ROMSColumns::freqOffset_p

private

Definition at line 155 of file MSColumns.h.

Referenced by freqOffset().

ROMSHistoryColumns casacore::ROMSColumns::history_p

private

Definition at line 156 of file MSColumns.h.

Referenced by history().

ROMSObservationColumns casacore::ROMSColumns::observation_p

private

Definition at line 157 of file MSColumns.h.

Referenced by observation().

ROMSPointingColumns casacore::ROMSColumns::pointing_p

private

Definition at line 158 of file MSColumns.h.

Referenced by pointing().

ROMSPolarizationColumns casacore::ROMSColumns::polarization_p

private

Definition at line 159 of file MSColumns.h.

Referenced by polarization().

ROMSProcessorColumns casacore::ROMSColumns::processor_p

private

Definition at line 160 of file MSColumns.h.

Referenced by processor().

ROMSSourceColumns casacore::ROMSColumns::source_p

private

Definition at line 161 of file MSColumns.h.

Referenced by source().

ROMSSpWindowColumns casacore::ROMSColumns::spectralWindow_p

private

Definition at line 162 of file MSColumns.h.

Referenced by spectralWindow().

ROMSStateColumns casacore::ROMSColumns::state_p

private

Definition at line 163 of file MSColumns.h.

Referenced by state().

ROMSSysCalColumns casacore::ROMSColumns::sysCal_p

private

Definition at line 164 of file MSColumns.h.

Referenced by sysCal().

ROMSWeatherColumns casacore::ROMSColumns::weather_p

private

Definition at line 165 of file MSColumns.h.

Referenced by weather().

---

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

• casa/casacore/ms/MeasurementSets/MSColumns.h