casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
casa::CalTable Class Reference

CalTable: Calibration table access and creation. More...

#include <CalTable.h>

Inheritance diagram for casa::CalTable:
casa::CalTableFromAIPS casa::VisJonesTable casa::TimeVarVisJonesTable casa::CJonesTable casa::PJonesTable casa::SolvableVisJonesTable casa::BJonesTable casa::DJonesTable casa::EPointTable casa::GJonesDelayRateSBTable casa::GJonesTable casa::TJonesTable casa::BJonesPolyTable casa::GJonesPolyTable casa::TJonesPolyTable casa::GJonesSplineTable casa::TJonesSplineTable

Public Member Functions

 CalTable ()
 Default null constructor, and destructor. More...
 
virtual ~CalTable ()
 
 CalTable (const casacore::String &tableName, CalTableDesc &ctableDesc, casacore::Table::TableOption access=casacore::Table::New)
 Construct from a specified table name, calibration table descriptor and table access option. More...
 
 CalTable (const casacore::String &tableName, casacore::Table::TableOption access=casacore::Table::Old)
 Construct from a specified table name, and access option. More...
 
 CalTable (const casacore::Table &table)
 Construct from an existing table object. More...
 
 CalTable (const CalTable &other)
 Copy constructor. More...
 
CalTableoperator= (const CalTable &other)
 Assignment operator. More...
 
CalTable sort (const casacore::Block< casacore::String > &columnNames, casacore::Sort::Order order=casacore::Sort::Ascending, casacore::Sort::Option option=casacore::Sort::HeapSort)
 casacore::Sort (cal_main) More...
 
void sort2 (const casacore::Block< casacore::String > &columnNames, casacore::Sort::Order order=casacore::Sort::Ascending, casacore::Sort::Option option=casacore::Sort::HeapSort)
 casacore::Sort (cal_main) IN PLACE More...
 
CalTable select (const casacore::String &calSelect)
 Apply selection to the calibration table. More...
 
void select2 (const casacore::String &calSelect)
 Apply selection to the calibration table IN PLACE. More...
 
casacore::Int nRowMain () const
 Return number of rows in cal_main, cal_desc or cal_history. More...
 
casacore::Int nRowDesc () const
 
casacore::Int nRowHistory () const
 
casacore::Int nRowObservation () const
 
void addRowMain (casacore::uInt nrrow=1, casacore::Bool initialize=false)
 Add rows to cal_main, cal_desc or cal_history. More...
 
void addRowDesc (casacore::uInt nrrow=1, casacore::Bool initialize=false)
 
void addRowHistory (casacore::uInt nrrow=1, casacore::Bool initialize=false)
 
casacore::Record getRowMain (const casacore::Int &jrow)
 Get a row from cal_main, cal_desc or cal_history. More...
 
casacore::Record getRowDesc (const casacore::Int &jrow)
 
casacore::Record getRowHistory (const casacore::Int &jrow)
 
casacore::Record getRowObservation (const casacore::Int &jrow)
 
void putRowMain (const casacore::Int &jrow, CalMainRecord &tableRec)
 Put a row to cal_main, cal_desc or cal_history. More...
 
void putRowDesc (const casacore::Int &jrow, CalDescRecord &tableRec)
 
void putRowHistory (const casacore::Int &jrow, CalHistoryRecord &tableRec)
 
virtual casacore::Int maxAntenna ()
 Return the maximum antenna number in the table. More...
 
casacore::Int numberTimeSlots (const casacore::Double &fracError)
 Return the number of unique time slots in the table. More...
 
void rowsPerCalDescId (casacore::Vector< casacore::Int > &rowspercdi)
 Return the number of rows per CalDescId. More...
 
const casacore::String tableName ()
 
const casacore::String type ()
 

Protected Member Functions

void createCalTable (const casacore::String &tableName, CalTableDesc &ctableDesc, casacore::Table::TableOption access=casacore::Table::New)
 Create a new table. More...
 
void openCalTable (const casacore::String &tableName, casacore::Table::TableOption access=casacore::Table::Old)
 Open an existing table. More...
 
casacore::TablecalMainAsTable ()
 Return cal_main and sub-tables as casacore::Table references. More...
 
casacore::TablecalDescAsTable ()
 
casacore::TablecalHistoryAsTable ()
 
casacore::TablecalObservationAsTable ()
 
const casacore::TablecalMainAsTable () const
 
const casacore::TablecalDescAsTable () const
 
const casacore::TablecalHistoryAsTable () const
 
const casacore::TablecalObservationAsTable () const
 

Private Member Functions

bool hasObsTable () const
 Check if has optional OBSERVATION Table. More...
 

Private Attributes

casacore::TableitsMainTable
 Pointer to underlying cal_main casacore::Table object. More...
 
casacore::TableitsDescTable
 Pointers to the cal_desc and cal_history sub-tables. More...
 
casacore::TableitsHistoryTable
 
casacore::TableitsObservationTable
 

Friends

class ROCalMainColumns
 Friend class access from the ROCalMainColumns, ROCalDescColumns and ROCalHistoryColumns class hierarchies. More...
 
class CalMainColumns
 
class ROCalDescColumns
 
class CalDescColumns
 
class ROCalHistoryColumns
 
class CalHistoryColumns
 

Detailed Description

CalTable: Calibration table access and creation.

Intended use:

Public interface

Prerequisite

Etymology

From "calibration" and "table".

Synopsis

The CalTable classes provide basic access to calibration tables. This includes the creation of calibration tables, sorting and selection capabilities, and basic data access. Specializations for baseline-based, time-variable and solvable VisJones types, and sub-types, are provided through inheritance.

Example

Motivation

This class is used by other calibration table accessors and iterators.

Definition at line 82 of file CalTable.h.

Constructor & Destructor Documentation

casa::CalTable::CalTable ( )

Default null constructor, and destructor.

virtual casa::CalTable::~CalTable ( )
virtual
casa::CalTable::CalTable ( const casacore::String tableName,
CalTableDesc ctableDesc,
casacore::Table::TableOption  access = casacore::Table::New 
)

Construct from a specified table name, calibration table descriptor and table access option.

Used for creating new tables.

casa::CalTable::CalTable ( const casacore::String tableName,
casacore::Table::TableOption  access = casacore::Table::Old 
)

Construct from a specified table name, and access option.

Used for accessing existing tables.

casa::CalTable::CalTable ( const casacore::Table table)

Construct from an existing table object.

casa::CalTable::CalTable ( const CalTable other)

Copy constructor.

Member Function Documentation

void casa::CalTable::addRowDesc ( casacore::uInt  nrrow = 1,
casacore::Bool  initialize = false 
)
inline

Definition at line 132 of file CalTable.h.

References casacore::Table::addRow(), and itsDescTable.

void casa::CalTable::addRowHistory ( casacore::uInt  nrrow = 1,
casacore::Bool  initialize = false 
)
inline

Definition at line 134 of file CalTable.h.

References casacore::Table::addRow(), and itsHistoryTable.

void casa::CalTable::addRowMain ( casacore::uInt  nrrow = 1,
casacore::Bool  initialize = false 
)
inline

Add rows to cal_main, cal_desc or cal_history.

Definition at line 130 of file CalTable.h.

References casacore::Table::addRow(), and itsMainTable.

casacore::Table& casa::CalTable::calDescAsTable ( )
inlineprotected
const casacore::Table& casa::CalTable::calDescAsTable ( ) const
inlineprotected

Definition at line 176 of file CalTable.h.

References itsDescTable.

casacore::Table& casa::CalTable::calHistoryAsTable ( )
inlineprotected
const casacore::Table& casa::CalTable::calHistoryAsTable ( ) const
inlineprotected

Definition at line 177 of file CalTable.h.

References itsHistoryTable.

casacore::Table& casa::CalTable::calMainAsTable ( )
inlineprotected

Return cal_main and sub-tables as casacore::Table references.

Definition at line 171 of file CalTable.h.

References itsMainTable.

Referenced by casa::ROCalMainColumns::asTable(), casa::CalMainColumns::asTable(), tableName(), and type().

const casacore::Table& casa::CalTable::calMainAsTable ( ) const
inlineprotected

Definition at line 175 of file CalTable.h.

References itsMainTable.

casacore::Table& casa::CalTable::calObservationAsTable ( )
inlineprotected

Definition at line 174 of file CalTable.h.

References itsObservationTable.

const casacore::Table& casa::CalTable::calObservationAsTable ( ) const
inlineprotected

Definition at line 178 of file CalTable.h.

void casa::CalTable::createCalTable ( const casacore::String tableName,
CalTableDesc ctableDesc,
casacore::Table::TableOption  access = casacore::Table::New 
)
protected

Create a new table.

casacore::Record casa::CalTable::getRowDesc ( const casacore::Int jrow)
casacore::Record casa::CalTable::getRowHistory ( const casacore::Int jrow)
casacore::Record casa::CalTable::getRowMain ( const casacore::Int jrow)

Get a row from cal_main, cal_desc or cal_history.

casacore::Record casa::CalTable::getRowObservation ( const casacore::Int jrow)
bool casa::CalTable::hasObsTable ( ) const
inlineprivate

Check if has optional OBSERVATION Table.

Definition at line 199 of file CalTable.h.

References casacore::TableRecord::fieldNumber(), itsMainTable, and casacore::Table::keywordSet().

virtual casacore::Int casa::CalTable::maxAntenna ( )
virtual

Return the maximum antenna number in the table.

casacore::Int casa::CalTable::nRowDesc ( ) const
casacore::Int casa::CalTable::nRowHistory ( ) const
casacore::Int casa::CalTable::nRowMain ( ) const

Return number of rows in cal_main, cal_desc or cal_history.

casacore::Int casa::CalTable::nRowObservation ( ) const
casacore::Int casa::CalTable::numberTimeSlots ( const casacore::Double fracError)

Return the number of unique time slots in the table.

void casa::CalTable::openCalTable ( const casacore::String tableName,
casacore::Table::TableOption  access = casacore::Table::Old 
)
protected

Open an existing table.

CalTable& casa::CalTable::operator= ( const CalTable other)

Assignment operator.

void casa::CalTable::putRowDesc ( const casacore::Int jrow,
CalDescRecord tableRec 
)
void casa::CalTable::putRowHistory ( const casacore::Int jrow,
CalHistoryRecord tableRec 
)
void casa::CalTable::putRowMain ( const casacore::Int jrow,
CalMainRecord tableRec 
)

Put a row to cal_main, cal_desc or cal_history.

void casa::CalTable::rowsPerCalDescId ( casacore::Vector< casacore::Int > &  rowspercdi)

Return the number of rows per CalDescId.

CalTable casa::CalTable::select ( const casacore::String calSelect)

Apply selection to the calibration table.

void casa::CalTable::select2 ( const casacore::String calSelect)

Apply selection to the calibration table IN PLACE.

casacore::Sort (cal_main)

void casa::CalTable::sort2 ( const casacore::Block< casacore::String > &  columnNames,
casacore::Sort::Order  order = casacore::Sort::Ascending,
casacore::Sort::Option  option = casacore::Sort::HeapSort 
)

casacore::Sort (cal_main) IN PLACE

const casacore::String casa::CalTable::tableName ( )
inline

Definition at line 157 of file CalTable.h.

References calMainAsTable(), and casacore::Table::tableName().

const casacore::String casa::CalTable::type ( )
inline

Friends And Related Function Documentation

friend class CalDescColumns
friend

Definition at line 185 of file CalTable.h.

friend class CalHistoryColumns
friend

Definition at line 187 of file CalTable.h.

friend class CalMainColumns
friend

Definition at line 183 of file CalTable.h.

friend class ROCalDescColumns
friend

Definition at line 184 of file CalTable.h.

friend class ROCalHistoryColumns
friend

Definition at line 186 of file CalTable.h.

friend class ROCalMainColumns
friend

Friend class access from the ROCalMainColumns, ROCalDescColumns and ROCalHistoryColumns class hierarchies.

Definition at line 178 of file CalTable.h.

Member Data Documentation

casacore::Table* casa::CalTable::itsDescTable
private

Pointers to the cal_desc and cal_history sub-tables.

Definition at line 194 of file CalTable.h.

Referenced by addRowDesc(), and calDescAsTable().

casacore::Table* casa::CalTable::itsHistoryTable
private

Definition at line 195 of file CalTable.h.

Referenced by addRowHistory(), and calHistoryAsTable().

casacore::Table* casa::CalTable::itsMainTable
private

Pointer to underlying cal_main casacore::Table object.

Definition at line 191 of file CalTable.h.

Referenced by addRowMain(), calMainAsTable(), and hasObsTable().

casacore::Table* casa::CalTable::itsObservationTable
private

Definition at line 196 of file CalTable.h.

Referenced by calObservationAsTable().


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