casa::CalSummary Class Reference

Provides and lists information about the header of a calibration table. Based on MSSummary and CTSummary. More...

#include <CalSummary.h>

Public Member Functions
	CalSummary (CalTable &ct)
	Constructor. More...
	CalSummary (CalTable *ct)
	~CalSummary ()
	Destructor. More...
casacore::Int	nrow () const
	Retrieve number of rows. More...
const casacore::String	name () const
	Retrieve caltable name. More...
casacore::Bool	setCT (CalTable &ct)
	Set a new CT. More...
void	list (casacore::LogIO &os, casacore::Bool verbose=false) const
	List all header information. More...
void	listTitle (casacore::LogIO &os) const
	List a title for the Summary. More...
void	listWhere (casacore::LogIO &os, casacore::Bool verbose=false) const
	List convenient groupings of tables: List where CT obtained (Observation table) More...
void	listWhat (casacore::LogIO &os, casacore::Bool verbose=false) const
	List what was observed (Field and Main tables) More...
void	listHow (casacore::LogIO &os, casacore::Bool verbose=false) const
	List how data were obtained (SpectralWindow and Antenna tables) More...
void	listMain (casacore::LogIO &os, casacore::Bool verbose=false) const
	List main table. More...
void	listObservation (casacore::LogIO &os, casacore::Bool verbose=false) const
	List subtables. More...
void	listField (casacore::LogIO &os, casacore::Bool verbose=false) const
void	listAntenna (casacore::LogIO &os, casacore::Bool verbose=false) const
void	listSpectralWindow (casacore::LogIO &os, casacore::Bool verbose=false) const
void	listHistory (casacore::LogIO &os) const
void	listTables (casacore::LogIO &os, casacore::Bool verbose=false) const
	List table size summary. More...

Private Member Functions
void	setMSname ()
	Set msname_p if MS exists. More...
bool	getObservatoryPosition (casacore::MPosition &obspos, casacore::String &name) const
	Needed for antenna offsets. More...
void	clearFormatFlags (casacore::LogIO &os) const
	Clear formatting flags. More...

Private Attributes
CalTable *	pCT
	Pointer to CalTable. More...
casacore::String	msname_p
	for fieldnames and antenna names More...
bool	haveMS_p
const casacore::String	dashlin1
	Formatting strings. More...
const casacore::String	dashlin2
casacore::Vector< casacore::Int >	nVisPerField_
	For keeping track of the number of vis per field. More...

Detailed Description

Provides and lists information about the header of a calibration table. Based on MSSummary and CTSummary.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• CalTable
• MSSummary
• Coordinates

Etymology

This class lists the ancilliary or header information from a CalTable in a Summary format.

Synopsis

CalTables consist of pixels and descriptive information stored in what is loosely termed the header. This is information describing the coordinate system, the image units etc. This class enables you to retrieve the descriptive header information and/or list it.

Example

CalTable inputCT(fileName);
CalSummary header(inputCT);
LogOrigin or("myClass", "myFunction(...)", WHERE);
LogIO os(or);
header.list(os);

A CalTable object is constructed and then logged to the supplied LogIO object.

Motivation

The viewing of the cal table header is a basic capability that is commonly required.

Definition at line 84 of file CalSummary.h.

Constructor & Destructor Documentation

casa::CalSummary::CalSummary

(

CalTable &

ct

)

Constructor.

casa::CalSummary::CalSummary

(

CalTable *

ct

)

casa::CalSummary::~CalSummary

(

)

Destructor.

Member Function Documentation

void casa::CalSummary::clearFormatFlags ( casacore::LogIO &  os ) const

private

Clear formatting flags.

bool casa::CalSummary::getObservatoryPosition ( casacore::MPosition &  obspos, casacore::String &  name  ) const

private

Needed for antenna offsets.

void casa::CalSummary::list	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

List all header information.

void casa::CalSummary::listAntenna	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

void casa::CalSummary::listField	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

void casa::CalSummary::listHistory

(

casacore::LogIO &

os

)

const

void casa::CalSummary::listHow	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

List how data were obtained (SpectralWindow and Antenna tables)

void casa::CalSummary::listMain	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

List main table.

void casa::CalSummary::listObservation	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

List subtables.

void casa::CalSummary::listSpectralWindow	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

void casa::CalSummary::listTables	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

List table size summary.

void casa::CalSummary::listTitle

(

casacore::LogIO &

os

)

const

List a title for the Summary.

void casa::CalSummary::listWhat	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

List what was observed (Field and Main tables)

void casa::CalSummary::listWhere	(	casacore::LogIO &	os,
		casacore::Bool	verbose = false
	)		const

List convenient groupings of tables: List where CT obtained (Observation table)

const casacore::String casa::CalSummary::name

(

)

const

Retrieve caltable name.

casacore::Int casa::CalSummary::nrow

(

)

const

Retrieve number of rows.

casacore::Bool casa::CalSummary::setCT

(

CalTable &

ct

)

Set a new CT.

void casa::CalSummary::setMSname ( )

private

Set msname_p if MS exists.

Member Data Documentation

const casacore::String casa::CalSummary::dashlin1

private

Formatting strings.

Definition at line 143 of file CalSummary.h.

const casacore::String casa::CalSummary::dashlin2

private

Definition at line 143 of file CalSummary.h.

bool casa::CalSummary::haveMS_p

private

Definition at line 140 of file CalSummary.h.

casacore::String casa::CalSummary::msname_p

private

for fieldnames and antenna names

Definition at line 139 of file CalSummary.h.

casacore::Vector<casacore::Int> casa::CalSummary::nVisPerField_

mutableprivate

For keeping track of the number of vis per field.

Definition at line 156 of file CalSummary.h.

CalTable* casa::CalSummary::pCT

private

Pointer to CalTable.

Definition at line 136 of file CalSummary.h.

---

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

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