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 | List of all members
casa::ROCTIter Class Reference

ROCTIter: Read-only iterating interface to New Calibration tables. More...

#include <CTIter.h>

Inheritance diagram for casa::ROCTIter:

Public Member Functions

 ROCTIter (NewCalTable tab, const casacore::Block< casacore::String > &sortcol)
 Constructor/Destructor. More...
virtual ~ROCTIter ()
void reset ()
 Iteration operators. More...
casacore::Bool pastEnd ()
void next ()
void next0 ()
NewCalTable table () const
 Return the current table iteration. More...
casacore::Int nrow () const
casacore::Double thisTime () const
 Column accessors Those methods that return scalars for data coordinates (e.g., thisTime(), thisField(), etc.) return the first element of the corresponding vector of values in the current iteration. More...
< casacore::Double
time () const
void time (casacore::Vector< casacore::Double > &v) const
casacore::Int thisField () const
casacore::Vector< casacore::Intfield () const
void field (casacore::Vector< casacore::Int > &v) const
casacore::Int thisSpw () const
casacore::Vector< casacore::Intspw () const
void spw (casacore::Vector< casacore::Int > &v) const
casacore::Int thisScan () const
casacore::Vector< casacore::Intscan () const
void scan (casacore::Vector< casacore::Int > &v) const
casacore::Int thisObs () const
casacore::Vector< casacore::Intobs () const
void obs (casacore::Vector< casacore::Int > &v) const
casacore::Int thisAntenna1 () const
casacore::Vector< casacore::Intantenna1 () const
void antenna1 (casacore::Vector< casacore::Int > &v) const
casacore::Int thisAntenna2 () const
casacore::Vector< casacore::Intantenna2 () const
void antenna2 (casacore::Vector< casacore::Int > &v) const
casacore::Double thisInterval () const
< casacore::Double
interval () const
void interval (casacore::Vector< casacore::Double > &v) const
casacore::Cube< casacore::Complex > cparam () const
void cparam (casacore::Cube< casacore::Complex > &c) const
casacore::Cube< casacore::Floatfparam () const
void fparam (casacore::Cube< casacore::Float > &c) const
casacore::Cube< casacore::Floatcasfparam (casacore::String what="") const
void casfparam (casacore::Cube< casacore::Float > &casf, casacore::String what="") const
casacore::Cube< casacore::FloatparamErr () const
void paramErr (casacore::Cube< casacore::Float > &c) const
casacore::Cube< casacore::Floatsnr () const
void snr (casacore::Cube< casacore::Float > &c) const
casacore::Cube< casacore::Floatwt () const
void wt (casacore::Cube< casacore::Float > &c) const
casacore::Cube< casacore::Boolflag () const
void flag (casacore::Cube< casacore::Bool > &c) const
casacore::Int nchan () const
casacore::Vector< casacore::Intchan () const
void chan (casacore::Vector< casacore::Int > &v) const
< casacore::Double
freq () const
void freq (casacore::Vector< casacore::Double > &v) const

Protected Member Functions

virtual void attach ()
 Attach accessors. More...

Private Member Functions

 ROCTIter (const ROCTIter &other)
 Prohibit public use of copy, assignment. More...
ROCTIteroperator= (const ROCTIter &other)

Private Attributes

< casacore::String
 casacore::Data: More...
casacore::Bool singleSpw_
 If true, spw is unique per iteration, and it is safe to access channel axis info. More...
NewCalTable parentNCT_
 The parent NewCalTable (casacore::Table) object (stays in scope for the life of the CTIter) More...
ROCTColumns calCol_
 Access to subtables (e.g., for frequencies) More...
 The underlying TableIterator. More...
 Per-iteration table. More...
 Per-iteration columns. More...

Detailed Description

ROCTIter: Read-only iterating interface to New Calibration tables.



From "calibration", "table", and "iteration".


The ROCTIter class provide basic iterated access to the contents of a NewCalTable. The iteration is initialized according to sort columns specified in the constructor, and access to the contents of each iteration is provided via a NewCalTable object (referencing the iterated subset of the original NewCalTable) or methods that return Vectors or Arrays of the contents of specific columns. For the latter, the Vectors/Arrays are generated only on-demand.



This class is used by calibration table clients to access calibration tables in a piecemeal fashion, e.g., for plotting, interpolation, etc.

Definition at line 76 of file CTIter.h.

Constructor & Destructor Documentation

casa::ROCTIter::ROCTIter ( NewCalTable  tab,
const casacore::Block< casacore::String > &  sortcol 


virtual casa::ROCTIter::~ROCTIter ( )
casa::ROCTIter::ROCTIter ( const ROCTIter other)

Prohibit public use of copy, assignment.

Member Function Documentation

casacore::Vector<casacore::Int> casa::ROCTIter::antenna1 ( ) const
void casa::ROCTIter::antenna1 ( casacore::Vector< casacore::Int > &  v) const
casacore::Vector<casacore::Int> casa::ROCTIter::antenna2 ( ) const
void casa::ROCTIter::antenna2 ( casacore::Vector< casacore::Int > &  v) const
virtual void casa::ROCTIter::attach ( )

Attach accessors.

Reimplemented in casa::CTIter.

Referenced by reset().

casacore::Cube<casacore::Float> casa::ROCTIter::casfparam ( casacore::String  what = "") const
void casa::ROCTIter::casfparam ( casacore::Cube< casacore::Float > &  casf,
casacore::String  what = "" 
) const
casacore::Vector<casacore::Int> casa::ROCTIter::chan ( ) const
void casa::ROCTIter::chan ( casacore::Vector< casacore::Int > &  v) const
casacore::Cube<casacore::Complex> casa::ROCTIter::cparam ( ) const
void casa::ROCTIter::cparam ( casacore::Cube< casacore::Complex > &  c) const
casacore::Vector<casacore::Int> casa::ROCTIter::field ( ) const
void casa::ROCTIter::field ( casacore::Vector< casacore::Int > &  v) const
casacore::Cube<casacore::Bool> casa::ROCTIter::flag ( ) const
void casa::ROCTIter::flag ( casacore::Cube< casacore::Bool > &  c) const
casacore::Cube<casacore::Float> casa::ROCTIter::fparam ( ) const
void casa::ROCTIter::fparam ( casacore::Cube< casacore::Float > &  c) const
casacore::Vector<casacore::Double> casa::ROCTIter::freq ( ) const
void casa::ROCTIter::freq ( casacore::Vector< casacore::Double > &  v) const
casacore::Vector<casacore::Double> casa::ROCTIter::interval ( ) const
void casa::ROCTIter::interval ( casacore::Vector< casacore::Double > &  v) const
casacore::Int casa::ROCTIter::nchan ( ) const
void casa::ROCTIter::next ( )
void casa::ROCTIter::next0 ( )
casacore::Int casa::ROCTIter::nrow ( ) const

Definition at line 92 of file CTIter.h.

References casacore::Table::nrow(), casacore::TableIterator::table(), and ti_.

casacore::Vector<casacore::Int> casa::ROCTIter::obs ( ) const
void casa::ROCTIter::obs ( casacore::Vector< casacore::Int > &  v) const
ROCTIter& casa::ROCTIter::operator= ( const ROCTIter other)
casacore::Cube<casacore::Float> casa::ROCTIter::paramErr ( ) const
void casa::ROCTIter::paramErr ( casacore::Cube< casacore::Float > &  c) const
casacore::Bool casa::ROCTIter::pastEnd ( )

Definition at line 85 of file CTIter.h.

References casacore::TableIterator::pastEnd(), and ti_.

void casa::ROCTIter::reset ( void  )

Iteration operators.

Definition at line 84 of file CTIter.h.

References attach(), casacore::TableIterator::reset(), and ti_.

casacore::Vector<casacore::Int> casa::ROCTIter::scan ( ) const
void casa::ROCTIter::scan ( casacore::Vector< casacore::Int > &  v) const
casacore::Cube<casacore::Float> casa::ROCTIter::snr ( ) const
void casa::ROCTIter::snr ( casacore::Cube< casacore::Float > &  c) const
casacore::Vector<casacore::Int> casa::ROCTIter::spw ( ) const
void casa::ROCTIter::spw ( casacore::Vector< casacore::Int > &  v) const
NewCalTable casa::ROCTIter::table ( ) const

Return the current table iteration.

Definition at line 90 of file CTIter.h.

References casacore::TableIterator::table(), and ti_.

casacore::Int casa::ROCTIter::thisAntenna1 ( ) const
casacore::Int casa::ROCTIter::thisAntenna2 ( ) const
casacore::Int casa::ROCTIter::thisField ( ) const
casacore::Double casa::ROCTIter::thisInterval ( ) const
casacore::Int casa::ROCTIter::thisObs ( ) const
casacore::Int casa::ROCTIter::thisScan ( ) const
casacore::Int casa::ROCTIter::thisSpw ( ) const
casacore::Double casa::ROCTIter::thisTime ( ) const

Column accessors Those methods that return scalars for data coordinates (e.g., thisTime(), thisField(), etc.) return the first element of the corresponding vector of values in the current iteration.

This makes the most sense when the corresponding column is a sort column in the iteration, such that the contents of the vector is in fact a unique value. (TBD: return -1 from scalar methods when column is not unique?)

casacore::Vector<casacore::Double> casa::ROCTIter::time ( ) const
void casa::ROCTIter::time ( casacore::Vector< casacore::Double > &  v) const
casacore::Cube<casacore::Float> casa::ROCTIter::wt ( ) const
void casa::ROCTIter::wt ( casacore::Cube< casacore::Float > &  c) const

Member Data Documentation

ROCTColumns casa::ROCTIter::calCol_

Access to subtables (e.g., for frequencies)

Definition at line 187 of file CTIter.h.

NewCalTable* casa::ROCTIter::inct_

Per-iteration table.

Definition at line 193 of file CTIter.h.

ROCTMainColumns* casa::ROCTIter::iROCTMainCols_

Per-iteration columns.

Definition at line 196 of file CTIter.h.

NewCalTable casa::ROCTIter::parentNCT_

The parent NewCalTable (casacore::Table) object (stays in scope for the life of the CTIter)

Definition at line 184 of file CTIter.h.

casacore::Bool casa::ROCTIter::singleSpw_

If true, spw is unique per iteration, and it is safe to access channel axis info.

Definition at line 180 of file CTIter.h.

casacore::Vector<casacore::String> casa::ROCTIter::sortCols_


Remember the sort columns...

Definition at line 176 of file CTIter.h.

casacore::TableIterator* casa::ROCTIter::ti_

The underlying TableIterator.

Definition at line 190 of file CTIter.h.

Referenced by nrow(), pastEnd(), reset(), and table().

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