casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Private Attributes
casa::CalMainBuffer Class Reference

CalMainBuffer: Calibration main table buffer. More...

#include <CalMainBuffer.h>

Inheritance diagram for casa::CalMainBuffer:
casa::VisJonesMBuf casa::TimeVarVisJonesMBuf casa::CJonesMBuf casa::EPointMBuf casa::PJonesMBuf casa::SolvableVisJonesMBuf casa::BJonesMBuf casa::DJonesMBuf casa::GJonesMBuf casa::TJonesMBuf casa::BJonesPolyMBuf casa::GJonesPolyMBuf casa::TJonesPolyMBuf casa::GJonesSplineMBuf casa::TJonesSplineMBuf

List of all members.

Public Member Functions

 CalMainBuffer ()
 Default constructor.
 CalMainBuffer (const Vector< Int > &calIndices, const Block< Vector< Int > > &indexValues)
 Construct from a set of calibration buffer indices and their specified values.
 CalMainBuffer (CalIterBase &calIter)
 Construct from a calibration table iterator.
virtual ~CalMainBuffer ()
 Default destructor.
virtual void synchronize ()
 Synchronize the buffer (if attached to an iterator)
virtual void fillCache ()
 Force an explicit read to cache for all columns (if attached to an iterator)
virtual Int append (CalTable &calTable)
 Write the current buffer at the end of a specified cal table; returns the number of rows appended.
virtual Int nRow ()
 Maximum number of rows in the calibration buffer.
virtual CalDescBuffercalDescBuffer ()
 Accessors for the contained cal_desc and cal_history buffers.
virtual CalHistoryBuffercalHistoryBuffer ()
virtual Vector< MEpoch > & timeMeas ()
 Data field accessors.
virtual Vector< Quantity > & timeEPQuant ()
virtual Vector< Quantity > & intervalQuant ()
virtual Vector< Int > & antenna1 ()
virtual Vector< Int > & feed1 ()
virtual Vector< Int > & fieldId ()
virtual Vector< Int > & arrayId ()
virtual Vector< Int > & obsId ()
virtual Vector< Int > & scanNo ()
virtual Vector< Int > & processorId ()
virtual Vector< Int > & stateId ()
virtual Vector< Int > & phaseId ()
virtual Vector< Int > & pulsarBin ()
virtual Vector< Int > & pulsarGateId ()
virtual Vector< Int > & freqGrp ()
virtual Vector< String > & freqGrpName ()
virtual Vector< String > & fieldName ()
virtual Vector< String > & fieldCode ()
virtual Vector< String > & sourceName ()
virtual Vector< String > & sourceCode ()
virtual Vector< Int > & calGrp ()
virtual Array< Complex > & gain ()
virtual Array< Int > & refAnt ()
virtual Array< Int > & refFeed ()
virtual Array< Int > & refReceptor ()
virtual Array< MFrequency > & refFreqMeas ()
virtual Vector< Int > & measFreqRef ()
virtual Array< MDirection > & refDirMeas ()
virtual Vector< Int > & measDirRef ()
virtual Vector< Int > & calDescId ()
virtual Vector< Int > & calHistoryId ()
virtual Vector< Int > & asVecInt (const MSCalEnums::colDef &calEnum)
 Generic access to integer columns by MSCalEnums enumeration.
virtual Vector< String > & asVecString (const MSCalEnums::colDef &calEnum)
 Generic access to string columns by MSCalEnums enumeration.
virtual Vector< IntmatchAntenna1 (const Int &antennaId)
 Find the matching rows for a given antenna1 id.
virtual Vector< IntmatchAntenna1AndFieldId (const Int &antennaId, const Int &fldId)
 Find the matching rows for a given antenna1 id.
virtual Vector< IntmatchAntenna1AndFreqGrp (const Int &antennaId, const String &frqGrpName)
 Find the matching rows for a given antenna1 id.

Protected Member Functions

virtual CalMainColumnsnewCalMainCol (CalTable &calTable)
 Factory method to create a columns accessor object of the appropriate type.
virtual CalMainColumnscalMainCol ()
 Access to the columns accessor object.
Bool connectedToIter ()
 Is the buffer connected to an underlying iterator ?
virtual void invalidate ()
 Invalidate the current cache.
virtual void fillIndices (const Vector< Int > &calIndices, const VisBuffer &vb)
 Span an empty cal buffer by taking all permutations of the values of a specified set of cal indices, specified as enums from class MSCalEnums:
virtual void fillIndices (const Vector< Int > &calIndices, const Block< Vector< Int > > &indexValues)
 Define the index values directly.
virtual void fillAttributes (const Vector< Int > &calIndices, const VisBuffer &vb)
 Fill the cal buffer attribute columns in an empty cal buffer, after the cal indices have been set using fillIndices().
virtual void fillAttributes (const Vector< Int > &calIndices)
 Set default attribute values.
Bool excluded (const MSCalEnums::colDef &calEnum, const Vector< Int > &excludeIndices)
 Utility function to test for membership in a list of calibration enums.

Private Attributes

Bool connectedToIter_p
 True if connected to underlying iterator.
CalIterBasecalIter_p
 Ptr to calibration table iterator.
CalMainColumnscalMainCol_p
 Ptr to cal main columns accessor.
CalDescBuffercalDescBuf_p
 Contained sub-table cal_desc and cal_history buffers.
CalHistoryBuffercalHistBuf_p
Vector< MEpochtimeMeas_p
 Buffer fields.
Vector< QuantitytimeEPQuant_p
Vector< QuantityintervalQuant_p
Vector< Intantenna1_p
Vector< Intfeed1_p
Vector< IntfieldId_p
Vector< IntarrayId_p
Vector< IntobsId_p
Vector< IntscanNo_p
Vector< IntprocessorId_p
Vector< IntstateId_p
Vector< IntphaseId_p
Vector< IntpulsarBin_p
Vector< IntpulsarGateId_p
Vector< IntfreqGrp_p
Vector< StringfreqGrpName_p
Vector< StringfieldName_p
Vector< StringfieldCode_p
Vector< StringsourceName_p
Vector< StringsourceCode_p
Vector< IntcalGrp_p
Array< Complex > gain_p
Array< IntrefAnt_p
Array< IntrefFeed_p
Array< IntrefReceptor_p
Array< MFrequencyrefFreqMeas_p
Vector< IntmeasFreqRef_p
Array< MDirectionrefDirMeas_p
Vector< IntmeasDirRef_p
Vector< IntcalDescId_p
Vector< IntcalHistoryId_p
Bool timeMeasOK_p
 Buffer field status flags.
Bool timeEPQuantOK_p
Bool intervalQuantOK_p
Bool antenna1OK_p
Bool feed1OK_p
Bool fieldIdOK_p
Bool arrayIdOK_p
Bool obsIdOK_p
Bool scanNoOK_p
Bool processorIdOK_p
Bool stateIdOK_p
Bool phaseIdOK_p
Bool pulsarBinOK_p
Bool pulsarGateIdOK_p
Bool freqGrpOK_p
Bool freqGrpNameOK_p
Bool fieldNameOK_p
Bool fieldCodeOK_p
Bool sourceNameOK_p
Bool sourceCodeOK_p
Bool calGrpOK_p
Bool gainOK_p
Bool refAntOK_p
Bool refFeedOK_p
Bool refReceptorOK_p
Bool refFreqMeasOK_p
Bool measFreqRefOK_p
Bool refDirMeasOK_p
Bool measDirRefOK_p
Bool calDescIdOK_p
Bool calHistoryIdOK_p

Detailed Description

CalMainBuffer: Calibration main table buffer.

Intended use:

Public interface

Prerequisite

Etymology

From "calibration main table" and "buffer"

Synopsis

The CalMainBuffer class holds a buffer, optionally connected to a calibration main table iterator (of base type CalIterBase). Specializations for baseline-based, time-variable and solvable VisJones calibration table formats are provided through inheritance.

Example

Motivation

Encapsulate calibration main table data buffers.

Definition at line 80 of file CalMainBuffer.h.


Constructor & Destructor Documentation

Default constructor.

No connection to an underlying calibration table iterator in this case.

casa::CalMainBuffer::CalMainBuffer ( const Vector< Int > &  calIndices,
const Block< Vector< Int > > &  indexValues 
)

Construct from a set of calibration buffer indices and their specified values.

Non-index columns will be set to default values. There is no connection to an underlying calibration table iterator in this case.

Construct from a calibration table iterator.

The calibration buffer will remain synchronized with the iterator.

virtual casa::CalMainBuffer::~CalMainBuffer ( ) [virtual]

Default destructor.


Member Function Documentation

virtual Vector<Int>& casa::CalMainBuffer::antenna1 ( ) [virtual]
virtual Int casa::CalMainBuffer::append ( CalTable calTable) [virtual]

Write the current buffer at the end of a specified cal table; returns the number of rows appended.

Reimplemented in casa::GJonesSplineMBuf, casa::TJonesSplineMBuf, casa::BJonesPolyMBuf, casa::GJonesPolyMBuf, casa::TJonesPolyMBuf, casa::SolvableVisJonesMBuf, and casa::EPointMBuf.

virtual Vector<Int>& casa::CalMainBuffer::arrayId ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::asVecInt ( const MSCalEnums::colDef calEnum) [virtual]

Generic access to integer columns by MSCalEnums enumeration.

Throws an exception if the column is not recognized or is not an integer column.

virtual Vector<String>& casa::CalMainBuffer::asVecString ( const MSCalEnums::colDef calEnum) [virtual]

Generic access to string columns by MSCalEnums enumeration.

Throws an exception if the column is not recognized or is not a string column.

virtual CalDescBuffer& casa::CalMainBuffer::calDescBuffer ( ) [inline, virtual]

Accessors for the contained cal_desc and cal_history buffers.

Definition at line 116 of file CalMainBuffer.h.

References calDescBuf_p.

virtual Vector<Int>& casa::CalMainBuffer::calDescId ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::calGrp ( ) [virtual]

Definition at line 117 of file CalMainBuffer.h.

References calHistBuf_p.

virtual Vector<Int>& casa::CalMainBuffer::calHistoryId ( ) [virtual]
virtual CalMainColumns* casa::CalMainBuffer::calMainCol ( ) [inline, protected, virtual]

Access to the columns accessor object.

Reimplemented in casa::GJonesSplineMBuf, casa::TJonesSplineMBuf, casa::BJonesPolyMBuf, casa::GJonesPolyMBuf, casa::TJonesPolyMBuf, casa::SolvableVisJonesMBuf, and casa::EPointMBuf.

Definition at line 177 of file CalMainBuffer.h.

References calMainCol_p.

Bool casa::CalMainBuffer::connectedToIter ( ) [inline, protected]

Is the buffer connected to an underlying iterator ?

Definition at line 180 of file CalMainBuffer.h.

References connectedToIter_p.

Bool casa::CalMainBuffer::excluded ( const MSCalEnums::colDef calEnum,
const Vector< Int > &  excludeIndices 
) [protected]

Utility function to test for membership in a list of calibration enums.

virtual Vector<Int>& casa::CalMainBuffer::feed1 ( ) [virtual]
virtual Vector<String>& casa::CalMainBuffer::fieldCode ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::fieldId ( ) [virtual]
virtual Vector<String>& casa::CalMainBuffer::fieldName ( ) [virtual]
virtual void casa::CalMainBuffer::fillAttributes ( const Vector< Int > &  calIndices,
const VisBuffer vb 
) [protected, virtual]

Fill the cal buffer attribute columns in an empty cal buffer, after the cal indices have been set using fillIndices().

The cal indices, specified as enums from class MSCalEnums, are excluded as non-attribute columns.

Use a visibility buffer to define the attribute values

Reimplemented in casa::GJonesSplineMBuf, casa::TJonesSplineMBuf, casa::BJonesPolyMBuf, casa::GJonesPolyMBuf, casa::TJonesPolyMBuf, casa::SolvableVisJonesMBuf, and casa::EPointMBuf.

virtual void casa::CalMainBuffer::fillAttributes ( const Vector< Int > &  calIndices) [protected, virtual]
virtual void casa::CalMainBuffer::fillCache ( ) [virtual]

Force an explicit read to cache for all columns (if attached to an iterator)

virtual void casa::CalMainBuffer::fillIndices ( const Vector< Int > &  calIndices,
const VisBuffer vb 
) [protected, virtual]

Span an empty cal buffer by taking all permutations of the values of a specified set of cal indices, specified as enums from class MSCalEnums:

Use a visibility buffer to define the index values

virtual void casa::CalMainBuffer::fillIndices ( const Vector< Int > &  calIndices,
const Block< Vector< Int > > &  indexValues 
) [protected, virtual]

Define the index values directly.

virtual Vector<Int>& casa::CalMainBuffer::freqGrp ( ) [virtual]
virtual Array<Complex>& casa::CalMainBuffer::gain ( ) [virtual]
virtual void casa::CalMainBuffer::invalidate ( ) [protected, virtual]
virtual Vector<Int> casa::CalMainBuffer::matchAntenna1 ( const Int antennaId) [virtual]

Find the matching rows for a given antenna1 id.

virtual Vector<Int> casa::CalMainBuffer::matchAntenna1AndFieldId ( const Int antennaId,
const Int fldId 
) [virtual]

Find the matching rows for a given antenna1 id.

and field id. pair

virtual Vector<Int> casa::CalMainBuffer::matchAntenna1AndFreqGrp ( const Int antennaId,
const String frqGrpName 
) [virtual]

Find the matching rows for a given antenna1 id.

and freq. group name

virtual Vector<Int>& casa::CalMainBuffer::measDirRef ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::measFreqRef ( ) [virtual]
virtual CalMainColumns* casa::CalMainBuffer::newCalMainCol ( CalTable calTable) [inline, protected, virtual]

Factory method to create a columns accessor object of the appropriate type.

Reimplemented in casa::GJonesSplineMBuf, casa::TJonesSplineMBuf, casa::BJonesPolyMBuf, casa::GJonesPolyMBuf, casa::TJonesPolyMBuf, casa::SolvableVisJonesMBuf, and casa::EPointMBuf.

Definition at line 173 of file CalMainBuffer.h.

virtual Int casa::CalMainBuffer::nRow ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::obsId ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::phaseId ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::processorId ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::pulsarBin ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::pulsarGateId ( ) [virtual]
virtual Array<Int>& casa::CalMainBuffer::refAnt ( ) [virtual]
virtual Array<Int>& casa::CalMainBuffer::refFeed ( ) [virtual]
virtual Array<Int>& casa::CalMainBuffer::refReceptor ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::scanNo ( ) [virtual]
virtual Vector<Int>& casa::CalMainBuffer::stateId ( ) [virtual]
virtual void casa::CalMainBuffer::synchronize ( ) [virtual]

Synchronize the buffer (if attached to an iterator)

virtual Vector<MEpoch>& casa::CalMainBuffer::timeMeas ( ) [virtual]

Data field accessors.


Member Data Documentation

Definition at line 236 of file CalMainBuffer.h.

Definition at line 269 of file CalMainBuffer.h.

Definition at line 239 of file CalMainBuffer.h.

Definition at line 272 of file CalMainBuffer.h.

Contained sub-table cal_desc and cal_history buffers.

Definition at line 229 of file CalMainBuffer.h.

Referenced by calDescBuffer().

Definition at line 262 of file CalMainBuffer.h.

Definition at line 295 of file CalMainBuffer.h.

Definition at line 253 of file CalMainBuffer.h.

Definition at line 286 of file CalMainBuffer.h.

Definition at line 230 of file CalMainBuffer.h.

Referenced by calHistoryBuffer().

Definition at line 263 of file CalMainBuffer.h.

Definition at line 296 of file CalMainBuffer.h.

Ptr to calibration table iterator.

Definition at line 223 of file CalMainBuffer.h.

Ptr to cal main columns accessor.

Definition at line 226 of file CalMainBuffer.h.

Referenced by calMainCol().

True if connected to underlying iterator.

Definition at line 220 of file CalMainBuffer.h.

Referenced by connectedToIter().

Definition at line 237 of file CalMainBuffer.h.

Definition at line 270 of file CalMainBuffer.h.

Definition at line 250 of file CalMainBuffer.h.

Definition at line 283 of file CalMainBuffer.h.

Definition at line 238 of file CalMainBuffer.h.

Definition at line 271 of file CalMainBuffer.h.

Definition at line 249 of file CalMainBuffer.h.

Definition at line 282 of file CalMainBuffer.h.

Definition at line 247 of file CalMainBuffer.h.

Definition at line 248 of file CalMainBuffer.h.

Definition at line 281 of file CalMainBuffer.h.

Definition at line 280 of file CalMainBuffer.h.

Array<Complex> casa::CalMainBuffer::gain_p [private]

Definition at line 254 of file CalMainBuffer.h.

Definition at line 287 of file CalMainBuffer.h.

Definition at line 235 of file CalMainBuffer.h.

Definition at line 268 of file CalMainBuffer.h.

Definition at line 261 of file CalMainBuffer.h.

Definition at line 294 of file CalMainBuffer.h.

Definition at line 259 of file CalMainBuffer.h.

Definition at line 292 of file CalMainBuffer.h.

Definition at line 240 of file CalMainBuffer.h.

Definition at line 273 of file CalMainBuffer.h.

Definition at line 244 of file CalMainBuffer.h.

Definition at line 277 of file CalMainBuffer.h.

Definition at line 242 of file CalMainBuffer.h.

Definition at line 275 of file CalMainBuffer.h.

Definition at line 245 of file CalMainBuffer.h.

Definition at line 278 of file CalMainBuffer.h.

Definition at line 246 of file CalMainBuffer.h.

Definition at line 279 of file CalMainBuffer.h.

Definition at line 255 of file CalMainBuffer.h.

Definition at line 288 of file CalMainBuffer.h.

Definition at line 260 of file CalMainBuffer.h.

Definition at line 293 of file CalMainBuffer.h.

Definition at line 256 of file CalMainBuffer.h.

Definition at line 289 of file CalMainBuffer.h.

Definition at line 258 of file CalMainBuffer.h.

Definition at line 291 of file CalMainBuffer.h.

Definition at line 257 of file CalMainBuffer.h.

Definition at line 290 of file CalMainBuffer.h.

Definition at line 241 of file CalMainBuffer.h.

Definition at line 274 of file CalMainBuffer.h.

Definition at line 252 of file CalMainBuffer.h.

Definition at line 285 of file CalMainBuffer.h.

Definition at line 251 of file CalMainBuffer.h.

Definition at line 284 of file CalMainBuffer.h.

Definition at line 243 of file CalMainBuffer.h.

Definition at line 276 of file CalMainBuffer.h.

Definition at line 234 of file CalMainBuffer.h.

Definition at line 267 of file CalMainBuffer.h.

Buffer fields.

Definition at line 233 of file CalMainBuffer.h.

Buffer field status flags.

Definition at line 266 of file CalMainBuffer.h.


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