casa::CTSummary Class Reference

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

#include <CTSummary.h>

Public Member Functions
	CTSummary (const NewCalTable &ct)
	Constructor. More...
	CTSummary (const NewCalTable *ct)
	~CTSummary ()
	Destructor. More...
casacore::Int	nrow () const
	Retrieve number of rows. More...
casacore::String	name () const
	Retrieve caltable name. More...
casacore::Bool	setNCT (const NewCalTable &ct)
	Set a new NCT. 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
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
const NewCalTable *	pNCT
	Pointer to NewCalTable. More...
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...
casacore::String	ctname_p
	Name of the CT used in the constructor. More...

Detailed Description

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

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• NewCalTable
• MSSummary
• Coordinates

Etymology

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

Synopsis

NCTs 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

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

A NewCalTable 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 CTSummary.h.

Constructor & Destructor Documentation

casa::CTSummary::CTSummary

(

const NewCalTable &

ct

)

Constructor.

casa::CTSummary::CTSummary

(

const NewCalTable *

ct

)

casa::CTSummary::~CTSummary

(

)

Destructor.

Member Function Documentation

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

private

Clear formatting flags.

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

private

Needed for antenna offsets.

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

List all header information.

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

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

void casa::CTSummary::listHistory

(

casacore::LogIO &

os

)

const

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

List how data were obtained (SpectralWindow and Antenna tables)

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

List main table.

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

List subtables.

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

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

List table size summary.

void casa::CTSummary::listTitle

(

casacore::LogIO &

os

)

const

List a title for the Summary.

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

List what was observed (Field and Main tables)

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

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

casacore::String casa::CTSummary::name

(

)

const

Retrieve caltable name.

casacore::Int casa::CTSummary::nrow

(

)

const

Retrieve number of rows.

casacore::Bool casa::CTSummary::setNCT

(

const NewCalTable &

ct

)

Set a new NCT.

Member Data Documentation

casacore::String casa::CTSummary::ctname_p

private

Name of the CT used in the constructor.

Definition at line 152 of file CTSummary.h.

const casacore::String casa::CTSummary::dashlin1

private

Formatting strings.

Definition at line 139 of file CTSummary.h.

const casacore::String casa::CTSummary::dashlin2

private

Definition at line 139 of file CTSummary.h.

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

mutableprivate

For keeping track of the number of vis per field.

Definition at line 149 of file CTSummary.h.

const NewCalTable* casa::CTSummary::pNCT

private

Pointer to NewCalTable.

Definition at line 136 of file CTSummary.h.

---

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

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