casa::ROCTIter Class Reference

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

#include <CTIter.h>

Inheritance diagram for casa::ROCTIter:

List of all members.

Public Member Functions
	ROCTIter (NewCalTable tab, const Block< String > &sortcol)
	Constructor/Destructor.
virtual	~ROCTIter ()
void	reset ()
	Iteration operators.
Bool	pastEnd ()
void	next ()
void	next0 ()
NewCalTable	table () const
	Return the current table iteration.
Int	nrow () const
Double	thisTime () const
	Column accessors Those methods that return scalars for data coordinates (e.g., thisTime(), thisField(), etc.
Vector< Double >	time () const
void	time (Vector< Double > &v) const
Int	thisField () const
Vector< Int >	field () const
void	field (Vector< Int > &v) const
Int	thisSpw () const
Vector< Int >	spw () const
void	spw (Vector< Int > &v) const
Int	thisScan () const
Vector< Int >	scan () const
void	scan (Vector< Int > &v) const
Int	thisObs () const
Vector< Int >	obs () const
void	obs (Vector< Int > &v) const
Int	thisAntenna1 () const
Vector< Int >	antenna1 () const
void	antenna1 (Vector< Int > &v) const
Int	thisAntenna2 () const
Vector< Int >	antenna2 () const
void	antenna2 (Vector< Int > &v) const
Cube< Complex >	cparam () const
void	cparam (Cube< Complex > &c) const
Cube< Float >	fparam () const
void	fparam (Cube< Float > &c) const
Cube< Float >	casfparam (String what="") const
void	casfparam (Cube< Float > &casf, String what="") const
Cube< Float >	paramErr () const
void	paramErr (Cube< Float > &c) const
Cube< Float >	snr () const
void	snr (Cube< Float > &c) const
Cube< Float >	wt () const
void	wt (Cube< Float > &c) const
Cube< Bool >	flag () const
void	flag (Cube< Bool > &c) const
Int	nchan () const
Vector< Int >	chan () const
void	chan (Vector< Int > &v) const
Vector< Double >	freq () const
void	freq (Vector< Double > &v) const
Protected Member Functions
virtual void	attach ()
	Attach accessors.
Private Member Functions
	ROCTIter (const ROCTIter &other)
	Prohibit public use of copy, assignment.
ROCTIter &	operator= (const ROCTIter &other)
Private Attributes
Vector< String >	sortCols_
	Data:.
Bool	singleSpw_
	If true, spw is unique per iteration, and it is safe to access channel axis info.
NewCalTable	parentNCT_
	The parent NewCalTable (Table) object (stays in scope for the life of the CTIter).
ROCTColumns	calCol_
	Access to subtables (e.g., for frequencies).
TableIterator *	ti_
	The underlying TableIterator.
NewCalTable *	inct_
	Per-iteration table.
ROCTMainColumns *	iROCTMainCols_
	Per-iteration columns.

---

Detailed Description

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

Prerequisite

• NewCalTable module

Etymology

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

Synopsis

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.

Example

Motivation

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 Block< String > &	sortcol
	)

Constructor/Destructor.

virtual casa::ROCTIter::~ROCTIter

(

)

[virtual]

casa::ROCTIter::ROCTIter

(

const ROCTIter &

other

)

[private]

Prohibit public use of copy, assignment.

---

Member Function Documentation

void casa::ROCTIter::antenna1

(

Vector< Int > &

v

)

const

Vector<Int> casa::ROCTIter::antenna1

(

)

const

void casa::ROCTIter::antenna2

(

Vector< Int > &

v

)

const

Vector<Int> casa::ROCTIter::antenna2

(

)

const

virtual void casa::ROCTIter::attach

(

)

[protected, virtual]

Attach accessors.

Reimplemented in casa::CTIter.

Referenced by reset().

void casa::ROCTIter::casfparam	(	Cube< Float > &	casf,
		String	what = ""
	)			const

Cube<Float> casa::ROCTIter::casfparam

(

String

what = ""

)

const

void casa::ROCTIter::chan

(

Vector< Int > &

v

)

const

Vector<Int> casa::ROCTIter::chan

(

)

const

void casa::ROCTIter::cparam

(

Cube< Complex > &

c

)

const

Cube<Complex> casa::ROCTIter::cparam

(

)

const

void casa::ROCTIter::field

(

Vector< Int > &

v

)

const

Vector<Int> casa::ROCTIter::field

(

)

const

void casa::ROCTIter::flag

(

Cube< Bool > &

c

)

const

Cube<Bool> casa::ROCTIter::flag

(

)

const

void casa::ROCTIter::fparam

(

Cube< Float > &

c

)

const

Cube<Float> casa::ROCTIter::fparam

(

)

const

void casa::ROCTIter::freq

(

Vector< Double > &

v

)

const

Vector<Double> casa::ROCTIter::freq

(

)

const

Int casa::ROCTIter::nchan

(

)

const

void casa::ROCTIter::next

(

)

void casa::ROCTIter::next0

(

)

Int casa::ROCTIter::nrow

(

)

const [inline]

Definition at line 92 of file CTIter.h.

References ti_.

void casa::ROCTIter::obs

(

Vector< Int > &

v

)

const

Vector<Int> casa::ROCTIter::obs

(

)

const

ROCTIter& casa::ROCTIter::operator=

(

const ROCTIter &

other

)

[private]

Reimplemented in casa::CTIter.

void casa::ROCTIter::paramErr

(

Cube< Float > &

c

)

const

Cube<Float> casa::ROCTIter::paramErr

(

)

const

Bool casa::ROCTIter::pastEnd

(

)

[inline]

Definition at line 85 of file CTIter.h.

References ti_.

void casa::ROCTIter::reset

(

void

)

[inline]

Iteration operators.

Definition at line 84 of file CTIter.h.

References attach(), and ti_.

void casa::ROCTIter::scan

(

Vector< Int > &

v

)

const

Vector<Int> casa::ROCTIter::scan

(

)

const

void casa::ROCTIter::snr

(

Cube< Float > &

c

)

const

Cube<Float> casa::ROCTIter::snr

(

)

const

void casa::ROCTIter::spw

(

Vector< Int > &

v

)

const

Vector<Int> casa::ROCTIter::spw

(

)

const

NewCalTable casa::ROCTIter::table

(

)

const [inline]

Return the current table iteration.

Definition at line 90 of file CTIter.h.

References ti_.

Int casa::ROCTIter::thisAntenna1

(

)

const

Int casa::ROCTIter::thisAntenna2

(

)

const

Int casa::ROCTIter::thisField

(

)

const

Int casa::ROCTIter::thisObs

(

)

const

Int casa::ROCTIter::thisScan

(

)

const

Int casa::ROCTIter::thisSpw

(

)

const

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?)

void casa::ROCTIter::time

(

Vector< Double > &

v

)

const

Vector<Double> casa::ROCTIter::time

(

)

const

void casa::ROCTIter::wt

(

Cube< Float > &

c

)

const

Cube<Float> casa::ROCTIter::wt

(

)

const

---

Member Data Documentation

ROCTColumns casa::ROCTIter::calCol_ [private]

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

Definition at line 183 of file CTIter.h.

NewCalTable* casa::ROCTIter::inct_ [private]

Per-iteration table.

Definition at line 189 of file CTIter.h.

ROCTMainColumns* casa::ROCTIter::iROCTMainCols_ [private]

Per-iteration columns.

Definition at line 192 of file CTIter.h.

NewCalTable casa::ROCTIter::parentNCT_ [private]

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

Definition at line 180 of file CTIter.h.

Bool casa::ROCTIter::singleSpw_ [private]

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

Definition at line 176 of file CTIter.h.

Vector<String> casa::ROCTIter::sortCols_ [private]

Data:.

Remember the sort columns..\.

Definition at line 172 of file CTIter.h.

TableIterator* casa::ROCTIter::ti_ [private]

The underlying TableIterator.

Definition at line 186 of file CTIter.h.

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

---

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

• code/synthesis/CalTables/CTIter.h