casa::ROCTColumns Class Reference

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

#include <CTColumns.h>

Inheritance diagram for casa::ROCTColumns:

Public Member Functions
	ROCTColumns (const NewCalTable &caltable)
	Create a columns object that accesses the data in the specified MS. More...
	~ROCTColumns ()
	The destructor does nothing special. More...
const ROCTObservationColumns &	observation () const
	Access to required subtables. More...
const ROCTAntennaColumns &	antenna () const
const ROCTFieldColumns &	field () const
const ROCTHistoryColumns &	history () const
const ROCTSpWindowColumns &	spectralWindow () const
Public Member Functions inherited from casa::ROCTMainColumns
	ROCTMainColumns (const NewCalTable &calTable)
	Construct from a calibration table. More...
virtual	~ROCTMainColumns ()
	Default destructor. More...
const casacore::ScalarColumn < casacore::Double > &	time () const
	Read-only column accessors. More...
const casacore::ROScalarQuantColumn < casacore::Double > &	timeQuant () const
const casacore::ROScalarMeasColumn < casacore::MEpoch > &	timeMeas () const
const casacore::ScalarColumn < casacore::Double > &	timeEP () const
const casacore::ROScalarQuantColumn < casacore::Double > &	timeEPQuant () const
const casacore::ScalarColumn < casacore::Double > &	interval () const
const casacore::ROScalarQuantColumn < casacore::Double > &	intervalQuant () const
const casacore::ScalarColumn < casacore::Int > &	antenna1 () const
const casacore::ScalarColumn < casacore::Int > &	antenna2 () const
const casacore::ScalarColumn < casacore::Int > &	fieldId () const
const casacore::ScalarColumn < casacore::Int > &	spwId () const
const casacore::ScalarColumn < casacore::Int > &	scanNo () const
const casacore::ScalarColumn < casacore::Int > &	obsId () const
const casacore::ArrayColumn < casacore::Complex > &	cparam () const
const casacore::ArrayColumn < casacore::Float > &	fparam () const
const casacore::ArrayColumn < casacore::Float > &	paramerr () const
const casacore::ArrayColumn < casacore::Bool > &	flag () const
const casacore::ArrayColumn < casacore::Float > &	snr () const
const casacore::ArrayColumn < casacore::Float > &	weight () const
casacore::Array< casacore::Float >	fparamArray (casacore::String what="", const casacore::Vector< casacore::uInt > &rows=casacore::Vector< casacore::uInt >())
	Some additional methods to extract cparam into casacore::Array<casacore::Float> what can be: "","AP". More...
void	fparamArray (casacore::Array< casacore::Float > &arr, casacore::String what="", const casacore::Vector< casacore::uInt > &rows=casacore::Vector< casacore::uInt >())
casacore::Array< casacore::Float >	phase ()
	Some additional methods to extract phase-like info. More...
void	phase (casacore::Array< casacore::Float > &ph)
casacore::Array< casacore::Float >	cycles ()
void	cycles (casacore::Array< casacore::Float > &cy)

Private Attributes
ROCTObservationColumns	observation_p
	Access to subtables. More...
ROCTAntennaColumns	antenna_p
ROCTFieldColumns	field_p
ROCTHistoryColumns	history_p
ROCTSpWindowColumns	spectralWindow_p

Friends
class	NewCalTable
	Access to optional subtables. More...

Additional Inherited Members
Protected Member Functions inherited from casa::ROCTMainColumns
	ROCTMainColumns ()
	Prohibit public use of the null constructor, which does not produce a usable object. More...
void	attach (const NewCalTable &calTable, casacore::TableColumn &tabCol, CTEnums::colDef colEnum, const casacore::Bool &optional=false)
	Return a CalTable as a casacore::Table reference. More...
void	attach (const NewCalTable &calTable, casacore::ROArrayMeasColumn< casacore::MEpoch > &tabCol, CTEnums::colDef colEnum, const casacore::Bool &optional=false)
void	attach (const NewCalTable &calTable, casacore::ROArrayMeasColumn< casacore::MFrequency > &tabCol, CTEnums::colDef colEnum, const casacore::Bool &optional=false)
void	attach (const NewCalTable &calTable, casacore::ROArrayMeasColumn< casacore::MDirection > &tabCol, CTEnums::colDef colEnum, const casacore::Bool &optional=false)
void	attach (const NewCalTable &calTable, casacore::ROScalarMeasColumn< casacore::MEpoch > &tabCol, CTEnums::colDef colEnum, const casacore::Bool &optional=false)
void	attach (const NewCalTable &calTable, casacore::ROScalarQuantColumn< casacore::Double > &tabCol, CTEnums::colDef colEnum, const casacore::Bool &optional=false)

Detailed Description

A class to provide easy read-only access to new CalTable columns.

Intended use:

Public interface

Prerequisite

• NewCalTable
• ArrayColumn
• ScalarColumn

Etymology

ROCTColumns stands for Read-Only NewCalTable casacore::Table columns.

Synopsis

This class provides read-only access to the columns in the NewCalTable, similar to the casacore::ROMSColumns for 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
NewCalTable newcalt("mynewcalt");
RONCTColumns nctc(newcalt);
// show time from row 5
cout << nctc.time()(5);
// show name of antenna on row 3 in antenna table
cout << nctc.antenna().name();

Motivation

See CTColumns for the motivation.

Definition at line 92 of file CTColumns.h.

Constructor & Destructor Documentation

casa::ROCTColumns::ROCTColumns

(

const NewCalTable &

caltable

)

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

casa::ROCTColumns::~ROCTColumns

(

)

The destructor does nothing special.

Member Function Documentation

const ROCTAntennaColumns& casa::ROCTColumns::antenna ( void  ) const

inline

Definition at line 104 of file CTColumns.h.

References antenna_p.

const ROCTFieldColumns& casa::ROCTColumns::field ( void  ) const

inline

Definition at line 105 of file CTColumns.h.

References field_p.

const ROCTHistoryColumns& casa::ROCTColumns::history ( ) const

inline

Definition at line 106 of file CTColumns.h.

References history_p.

const ROCTObservationColumns& casa::ROCTColumns::observation ( ) const

inline

Access to required subtables.

Definition at line 103 of file CTColumns.h.

References observation_p.

const ROCTSpWindowColumns& casa::ROCTColumns::spectralWindow ( ) const

inline

Definition at line 107 of file CTColumns.h.

References spectralWindow_p.

Friends And Related Function Documentation

friend class NewCalTable

friend

Access to optional subtables.

Definition at line 116 of file CTColumns.h.

Member Data Documentation

ROCTAntennaColumns casa::ROCTColumns::antenna_p

private

Definition at line 120 of file CTColumns.h.

Referenced by antenna().

ROCTFieldColumns casa::ROCTColumns::field_p

private

Definition at line 121 of file CTColumns.h.

Referenced by field().

ROCTHistoryColumns casa::ROCTColumns::history_p

private

Definition at line 122 of file CTColumns.h.

Referenced by history().

ROCTObservationColumns casa::ROCTColumns::observation_p

private

Access to subtables.

Definition at line 119 of file CTColumns.h.

Referenced by observation().

ROCTSpWindowColumns casa::ROCTColumns::spectralWindow_p

private

Definition at line 123 of file CTColumns.h.

Referenced by spectralWindow().

---

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

• casa/code/synthesis/CalTables/CTColumns.h